GBDX Raster Data Access API (RDA)

Operator

Operator

getOperation

Get an operator descriptor by name.


/operator/{operationName}

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/operator/{operationName}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OperatorApi;

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

public class OperatorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        OperatorApi apiInstance = new OperatorApi();
        String operationName = "IdahoRead"; // String | 
        try {
            Operator result = apiInstance.getOperation(operationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorApi#getOperation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OperatorApi;

public class OperatorApiExample {

    public static void main(String[] args) {
        OperatorApi apiInstance = new OperatorApi();
        String operationName = "IdahoRead"; // String | 
        try {
            Operator result = apiInstance.getOperation(operationName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorApi#getOperation");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

String *operationName = "IdahoRead"; // 

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

// Get an operator descriptor by name.
[apiInstance getOperationWith:operationName
              completionHandler: ^(Operator output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new .OperatorApi()


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

namespace Example
{
    public class getOperationExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OperatorApi();
            var operationName = "IdahoRead";  // String | 

            try
            {
                // Get an operator descriptor by name.
                Operator result = apiInstance.getOperation(operationName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OperatorApi.getOperation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OperatorApi();
$operationName = "IdahoRead"; // String | 

try {
    $result = $api_instance->getOperation($operationName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperatorApi->getOperation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::OperatorApi;

# Configure OAuth2 access token for authorization: oauth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::OperatorApi->new();
my $operationName = "IdahoRead"; # String | 

eval { 
    my $result = $api_instance->getOperation(operationName => $operationName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperatorApi->getOperation: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .OperatorApi()
operationName = "IdahoRead" # String | 

try: 
    # Get an operator descriptor by name.
    api_response = api_instance.get_operation(operationName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperatorApi->getOperation: %s\n" % e)

Parameters

Path parameters
Name Description
operationName*
String
Required

Responses

Status: 200 - successful operation

Status: 404 - Operation Not Found


getOperationList

Get a list of all operators.


/operator

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/operator?fullListing="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OperatorApi;

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

public class OperatorApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: oauth
        OAuth oauth = (OAuth) defaultClient.getAuthentication("oauth");
        oauth.setAccessToken("YOUR ACCESS TOKEN");

        OperatorApi apiInstance = new OperatorApi();
        Boolean fullListing = true; // Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names
        try {
            array[Operator] result = apiInstance.getOperationList(fullListing);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorApi#getOperationList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OperatorApi;

public class OperatorApiExample {

    public static void main(String[] args) {
        OperatorApi apiInstance = new OperatorApi();
        Boolean fullListing = true; // Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names
        try {
            array[Operator] result = apiInstance.getOperationList(fullListing);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OperatorApi#getOperationList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure OAuth2 access token for authorization: (authentication scheme: oauth)
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

Boolean *fullListing = true; // if true, return a full listing, including descriptors, if false, return only the list of operator names (optional) (default to true)

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

// Get a list of all operators.
[apiInstance getOperationListWith:fullListing
              completionHandler: ^(array[Operator] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new .OperatorApi()

var opts = { 
  'fullListing': true // {Boolean} if true, return a full listing, including descriptors, if false, return only the list of operator names
};

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

namespace Example
{
    public class getOperationListExample
    {
        public void main()
        {
            
            // Configure OAuth2 access token for authorization: oauth
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new OperatorApi();
            var fullListing = true;  // Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names (optional)  (default to true)

            try
            {
                // Get a list of all operators.
                array[Operator] result = apiInstance.getOperationList(fullListing);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OperatorApi.getOperationList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth
\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\Api\OperatorApi();
$fullListing = true; // Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names

try {
    $result = $api_instance->getOperationList($fullListing);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OperatorApi->getOperationList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::OperatorApi;

# Configure OAuth2 access token for authorization: oauth
$::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

my $api_instance = ::OperatorApi->new();
my $fullListing = true; # Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names

eval { 
    my $result = $api_instance->getOperationList(fullListing => $fullListing);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OperatorApi->getOperationList: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: oauth
.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = .OperatorApi()
fullListing = true # Boolean | if true, return a full listing, including descriptors, if false, return only the list of operator names (optional) (default to true)

try: 
    # Get a list of all operators.
    api_response = api_instance.get_operation_list(fullListing=fullListing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OperatorApi->getOperationList: %s\n" % e)

Parameters

Query parameters
Name Description
fullListing
Boolean
if true, return a full listing, including descriptors, if false, return only the list of operator names

Responses

Status: 200 - successful operation


StripMetadata

StripMetadata

getCapabilities

Get capabilities for a given catalog ID.


/stripMetadata/{catalogId}/capabilities

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/stripMetadata/{catalogId}/capabilities?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StripMetadataApi;

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

public class StripMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            Capabilities result = apiInstance.getCapabilities(catalogId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getCapabilities");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StripMetadataApi;

public class StripMetadataApiExample {

    public static void main(String[] args) {
        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            Capabilities result = apiInstance.getCapabilities(catalogId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getCapabilities");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *catalogId = "103001002BD30300"; // The DigitalGlobe strip catalog identifier

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

// Get capabilities for a given catalog ID.
[apiInstance getCapabilitiesWith:catalogId
              completionHandler: ^(Capabilities output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .StripMetadataApi()


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

namespace Example
{
    public class getCapabilitiesExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new StripMetadataApi();
            var catalogId = "103001002BD30300";  // String | The DigitalGlobe strip catalog identifier

            try
            {
                // Get capabilities for a given catalog ID.
                Capabilities result = apiInstance.getCapabilities(catalogId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripMetadataApi.getCapabilities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\StripMetadataApi();
$catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier

try {
    $result = $api_instance->getCapabilities($catalogId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StripMetadataApi->getCapabilities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::StripMetadataApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::StripMetadataApi->new();
my $catalogId = "103001002BD30300"; # String | The DigitalGlobe strip catalog identifier

eval { 
    my $result = $api_instance->getCapabilities(catalogId => $catalogId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StripMetadataApi->getCapabilities: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .StripMetadataApi()
catalogId = "103001002BD30300" # String | The DigitalGlobe strip catalog identifier

try: 
    # Get capabilities for a given catalog ID.
    api_response = api_instance.get_capabilities(catalogId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StripMetadataApi->getCapabilities: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The DigitalGlobe strip catalog identifier
Required
Query parameters
Name Description

Responses

Status: 200 - successful operation


getStripFactoryMetadata

Get zipped factory metadata for the given catalog ID.


/stripMetadata/{catalogId}/factoryMetadata

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/stripMetadata/{catalogId}/factoryMetadata?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StripMetadataApi;

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

public class StripMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            apiInstance.getStripFactoryMetadata(catalogId);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getStripFactoryMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StripMetadataApi;

public class StripMetadataApiExample {

    public static void main(String[] args) {
        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            apiInstance.getStripFactoryMetadata(catalogId);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getStripFactoryMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *catalogId = "103001002BD30300"; // The DigitalGlobe strip catalog identifier

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

// Get zipped factory metadata for the given catalog ID.
[apiInstance getStripFactoryMetadataWith:catalogId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .StripMetadataApi()


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getStripFactoryMetadata(catalogId, callback);
using System;
using System.Diagnostics;
using .Api;
using .Client;
using .Model;

namespace Example
{
    public class getStripFactoryMetadataExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new StripMetadataApi();
            var catalogId = "103001002BD30300";  // String | The DigitalGlobe strip catalog identifier

            try
            {
                // Get zipped factory metadata for the given catalog ID.
                apiInstance.getStripFactoryMetadata(catalogId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripMetadataApi.getStripFactoryMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\StripMetadataApi();
$catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier

try {
    $api_instance->getStripFactoryMetadata($catalogId);
} catch (Exception $e) {
    echo 'Exception when calling StripMetadataApi->getStripFactoryMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::StripMetadataApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::StripMetadataApi->new();
my $catalogId = "103001002BD30300"; # String | The DigitalGlobe strip catalog identifier

eval { 
    $api_instance->getStripFactoryMetadata(catalogId => $catalogId);
};
if ($@) {
    warn "Exception when calling StripMetadataApi->getStripFactoryMetadata: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .StripMetadataApi()
catalogId = "103001002BD30300" # String | The DigitalGlobe strip catalog identifier

try: 
    # Get zipped factory metadata for the given catalog ID.
    api_instance.get_strip_factory_metadata(catalogId)
except ApiException as e:
    print("Exception when calling StripMetadataApi->getStripFactoryMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The DigitalGlobe strip catalog identifier
Required
Query parameters
Name Description

Responses

Status: default - successful operation


getStripMetadata

Get strip metadata for the given catalog ID.


/stripMetadata/{catalogId}

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/stripMetadata/{catalogId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StripMetadataApi;

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

public class StripMetadataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            DigitalGlobeStripMetadata result = apiInstance.getStripMetadata(catalogId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getStripMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.StripMetadataApi;

public class StripMetadataApiExample {

    public static void main(String[] args) {
        StripMetadataApi apiInstance = new StripMetadataApi();
        String catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier
        try {
            DigitalGlobeStripMetadata result = apiInstance.getStripMetadata(catalogId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StripMetadataApi#getStripMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *catalogId = "103001002BD30300"; // The DigitalGlobe strip catalog identifier

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

// Get strip metadata for the given catalog ID.
[apiInstance getStripMetadataWith:catalogId
              completionHandler: ^(DigitalGlobeStripMetadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .StripMetadataApi()


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

namespace Example
{
    public class getStripMetadataExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new StripMetadataApi();
            var catalogId = "103001002BD30300";  // String | The DigitalGlobe strip catalog identifier

            try
            {
                // Get strip metadata for the given catalog ID.
                DigitalGlobeStripMetadata result = apiInstance.getStripMetadata(catalogId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StripMetadataApi.getStripMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\StripMetadataApi();
$catalogId = "103001002BD30300"; // String | The DigitalGlobe strip catalog identifier

try {
    $result = $api_instance->getStripMetadata($catalogId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StripMetadataApi->getStripMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::StripMetadataApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::StripMetadataApi->new();
my $catalogId = "103001002BD30300"; # String | The DigitalGlobe strip catalog identifier

eval { 
    my $result = $api_instance->getStripMetadata(catalogId => $catalogId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StripMetadataApi->getStripMetadata: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .StripMetadataApi()
catalogId = "103001002BD30300" # String | The DigitalGlobe strip catalog identifier

try: 
    # Get strip metadata for the given catalog ID.
    api_response = api_instance.get_strip_metadata(catalogId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StripMetadataApi->getStripMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
catalogId*
String
The DigitalGlobe strip catalog identifier
Required
Query parameters
Name Description

Responses

Status: 200 - successful operation


Template

Template

getJobStatus

check status of a materialization job

returns the current status of a materialization job previously submitted


/template/materialize/status/{jobId}

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/materialize/status/{jobId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        String jobId = jobId_example; // String | 
        try {
            MaterializeJob result = apiInstance.getJobStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getJobStatus");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String jobId = jobId_example; // String | 
        try {
            MaterializeJob result = apiInstance.getJobStatus(jobId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getJobStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *jobId = jobId_example; // 

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

// check status of a materialization job
[apiInstance getJobStatusWith:jobId
              completionHandler: ^(MaterializeJob output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()


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

namespace Example
{
    public class getJobStatusExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var jobId = jobId_example;  // String | 

            try
            {
                // check status of a materialization job
                MaterializeJob result = apiInstance.getJobStatus(jobId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.getJobStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$jobId = jobId_example; // String | 

try {
    $result = $api_instance->getJobStatus($jobId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $jobId = jobId_example; # String | 

eval { 
    my $result = $api_instance->getJobStatus(jobId => $jobId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getJobStatus: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
jobId = jobId_example # String | 

try: 
    # check status of a materialization job
    api_response = api_instance.get_job_status(jobId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getJobStatus: %s\n" % e)

Parameters

Path parameters
Name Description
jobId*
String
Required
Query parameters
Name Description

Responses

Status: 200 - successful operation


getMetadata

Get metadata about an image given a template id, template parameters, and optional node id.


/template/{templateId}/metadata

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/{templateId}/metadata?nodeId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        String nodeId = nodeId_example; // String | 
        try {
            UnifiedMetadata result = apiInstance.getMetadata(templateId, nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getMetadata");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        String nodeId = nodeId_example; // String | 
        try {
            UnifiedMetadata result = apiInstance.getMetadata(templateId, nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getMetadata");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *templateId = templateId_example; // 
String *nodeId = nodeId_example; //  (optional)

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

// Get metadata about an image given a template id, template parameters, and optional node id.
[apiInstance getMetadataWith:templateId
    nodeId:nodeId
              completionHandler: ^(UnifiedMetadata output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()

var opts = { 
  'nodeId': nodeId_example // {String} 
};

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

namespace Example
{
    public class getMetadataExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | 
            var nodeId = nodeId_example;  // String |  (optional) 

            try
            {
                // Get metadata about an image given a template id, template parameters, and optional node id.
                UnifiedMetadata result = apiInstance.getMetadata(templateId, nodeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.getMetadata: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$templateId = templateId_example; // String | 
$nodeId = nodeId_example; // String | 

try {
    $result = $api_instance->getMetadata($templateId, $nodeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getMetadata: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $templateId = templateId_example; # String | 
my $nodeId = nodeId_example; # String | 

eval { 
    my $result = $api_instance->getMetadata(templateId => $templateId, nodeId => $nodeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getMetadata: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
templateId = templateId_example # String | 
nodeId = nodeId_example # String |  (optional)

try: 
    # Get metadata about an image given a template id, template parameters, and optional node id.
    api_response = api_instance.get_metadata(templateId, nodeId=nodeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getMetadata: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
String
Required
Query parameters
Name Description
nodeId
String

Responses

Status: 200 - successful operation


getTemplate

Get a template given a template id.


/template/{templateId}

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/{templateId}?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        try {
            IPEGraph result = apiInstance.getTemplate(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        try {
            IPEGraph result = apiInstance.getTemplate(templateId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *templateId = templateId_example; // 

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

// Get a template given a template id.
[apiInstance getTemplateWith:templateId
              completionHandler: ^(IPEGraph output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()


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

namespace Example
{
    public class getTemplateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | 

            try
            {
                // Get a template given a template id.
                IPEGraph result = apiInstance.getTemplate(templateId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.getTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$templateId = templateId_example; // String | 

try {
    $result = $api_instance->getTemplate($templateId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $templateId = templateId_example; # String | 

eval { 
    my $result = $api_instance->getTemplate(templateId => $templateId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getTemplate: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
templateId = templateId_example # String | 

try: 
    # Get a template given a template id.
    api_response = api_instance.get_template(templateId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getTemplate: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
String
Required
Query parameters
Name Description

Responses

Status: 200 - successful operation


getTile

Get a tile from a virtual image given a template id, template parameters (provided as url query parameters), tile x and y, and optional node id.

Response is a tif formatted image comprising one tile of the virtual image. The size of the tile is described in the image metadata.


/template/{templateId}/tile/{tileX}/{tileY}

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/{templateId}/tile/{tileX}/{tileY}?nodeId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        Integer tileX = 56; // Integer | 
        Integer tileY = 56; // Integer | 
        String nodeId = nodeId_example; // String | 
        try {
            array[byte[]] result = apiInstance.getTile(templateId, tileX, tileY, nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        String templateId = templateId_example; // String | 
        Integer tileX = 56; // Integer | 
        Integer tileY = 56; // Integer | 
        String nodeId = nodeId_example; // String | 
        try {
            array[byte[]] result = apiInstance.getTile(templateId, tileX, tileY, nodeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#getTile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

String *templateId = templateId_example; // 
Integer *tileX = 56; // 
Integer *tileY = 56; // 
String *nodeId = nodeId_example; //  (optional)

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

// Get a tile from a virtual image given a template id, template parameters (provided as url query parameters), tile x and y, and optional node id.
[apiInstance getTileWith:templateId
    tileX:tileX
    tileY:tileY
    nodeId:nodeId
              completionHandler: ^(array[byte[]] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()

var opts = { 
  'nodeId': nodeId_example // {String} 
};

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

namespace Example
{
    public class getTileExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var templateId = templateId_example;  // String | 
            var tileX = 56;  // Integer | 
            var tileY = 56;  // Integer | 
            var nodeId = nodeId_example;  // String |  (optional) 

            try
            {
                // Get a tile from a virtual image given a template id, template parameters (provided as url query parameters), tile x and y, and optional node id.
                array[byte[]] result = apiInstance.getTile(templateId, tileX, tileY, nodeId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.getTile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$templateId = templateId_example; // String | 
$tileX = 56; // Integer | 
$tileY = 56; // Integer | 
$nodeId = nodeId_example; // String | 

try {
    $result = $api_instance->getTile($templateId, $tileX, $tileY, $nodeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->getTile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $templateId = templateId_example; # String | 
my $tileX = 56; # Integer | 
my $tileY = 56; # Integer | 
my $nodeId = nodeId_example; # String | 

eval { 
    my $result = $api_instance->getTile(templateId => $templateId, tileX => $tileX, tileY => $tileY, nodeId => $nodeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->getTile: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
templateId = templateId_example # String | 
tileX = 56 # Integer | 
tileY = 56 # Integer | 
nodeId = nodeId_example # String |  (optional)

try: 
    # Get a tile from a virtual image given a template id, template parameters (provided as url query parameters), tile x and y, and optional node id.
    api_response = api_instance.get_tile(templateId, tileX, tileY, nodeId=nodeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->getTile: %s\n" % e)

Parameters

Path parameters
Name Description
templateId*
String
Required
tileX*
Integer (int32)
Required
tileY*
Integer (int32)
Required
Query parameters
Name Description
nodeId
String

Responses

Status: 200 - successful operation


listMaterializationFormats

List supported data materialization output formats.


/template/materialize/formats

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/materialize/formats?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        try {
            array[FormatDescriptor] result = apiInstance.listMaterializationFormats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listMaterializationFormats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        try {
            array[FormatDescriptor] result = apiInstance.listMaterializationFormats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#listMaterializationFormats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];


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

// List supported data materialization output formats.
[apiInstance listMaterializationFormatsWithCompletionHandler: 
              ^(array[FormatDescriptor] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()

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

namespace Example
{
    public class listMaterializationFormatsExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();

            try
            {
                // List supported data materialization output formats.
                array[FormatDescriptor] result = apiInstance.listMaterializationFormats();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.listMaterializationFormats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();

try {
    $result = $api_instance->listMaterializationFormats();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->listMaterializationFormats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();

eval { 
    my $result = $api_instance->listMaterializationFormats();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->listMaterializationFormats: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

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

try: 
    # List supported data materialization output formats.
    api_response = api_instance.list_materialization_formats()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->listMaterializationFormats: %s\n" % e)

Parameters

Query parameters
Name Description

Responses

Status: 200 - successful operation


materializeTemplate

materialize a template

A unique identifier is returned that can be used to check status of the materialization job.


/template/materialize

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template/materialize?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        MaterializeRequest body = ; // MaterializeRequest | 
        try {
            String result = apiInstance.materializeTemplate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#materializeTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        MaterializeRequest body = ; // MaterializeRequest | 
        try {
            String result = apiInstance.materializeTemplate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#materializeTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

MaterializeRequest *body = ; //  (optional)

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

// materialize a template
[apiInstance materializeTemplateWith:body
              completionHandler: ^(String output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()

var opts = { 
  'body':  // {MaterializeRequest} 
};

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

namespace Example
{
    public class materializeTemplateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var body = new MaterializeRequest(); // MaterializeRequest |  (optional) 

            try
            {
                // materialize a template
                String result = apiInstance.materializeTemplate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.materializeTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$body = ; // MaterializeRequest | 

try {
    $result = $api_instance->materializeTemplate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->materializeTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $body = ::Object::MaterializeRequest->new(); # MaterializeRequest | 

eval { 
    my $result = $api_instance->materializeTemplate(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->materializeTemplate: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
body =  # MaterializeRequest |  (optional)

try: 
    # materialize a template
    api_response = api_instance.materialize_template(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->materializeTemplate: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - successful operation


storeTemplate

store template

A unique identifier is returned that can be used to reference the template later on.


/template

Usage and SDK Samples

curl -X  "https://rda.geobigdata.io/v1/template?"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.TemplateApi;

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

public class TemplateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: api_key
        ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
        api_key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //api_key.setApiKeyPrefix("Token");

        TemplateApi apiInstance = new TemplateApi();
        IPEGraph body = ; // IPEGraph | 
        try {
            IPEGraph result = apiInstance.storeTemplate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#storeTemplate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.TemplateApi;

public class TemplateApiExample {

    public static void main(String[] args) {
        TemplateApi apiInstance = new TemplateApi();
        IPEGraph body = ; // IPEGraph | 
        try {
            IPEGraph result = apiInstance.storeTemplate(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling TemplateApi#storeTemplate");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: api_key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"token"];

IPEGraph *body = ; //  (optional)

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

// store template
[apiInstance storeTemplateWith:body
              completionHandler: ^(IPEGraph output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var  = require('');
var defaultClient = .ApiClient.instance;

// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['token'] = "Token"

var api = new .TemplateApi()

var opts = { 
  'body':  // {IPEGraph} 
};

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

namespace Example
{
    public class storeTemplateExample
    {
        public void main()
        {
            
            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("token", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("token", "Bearer");

            var apiInstance = new TemplateApi();
            var body = new IPEGraph(); // IPEGraph |  (optional) 

            try
            {
                // store template
                IPEGraph result = apiInstance.storeTemplate(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling TemplateApi.storeTemplate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// \Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');

$api_instance = new Swagger\Client\Api\TemplateApi();
$body = ; // IPEGraph | 

try {
    $result = $api_instance->storeTemplate($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TemplateApi->storeTemplate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use ::Configuration;
use ::TemplateApi;

# Configure API key authorization: api_key
$::Configuration::api_key->{'token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$::Configuration::api_key_prefix->{'token'} = "Bearer";

my $api_instance = ::TemplateApi->new();
my $body = ::Object::IPEGraph->new(); # IPEGraph | 

eval { 
    my $result = $api_instance->storeTemplate(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling TemplateApi->storeTemplate: $@\n";
}
from __future__ import print_statement
import time
import 
from .rest import ApiException
from pprint import pprint

# Configure API key authorization: api_key
.configuration.api_key['token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# .configuration.api_key_prefix['token'] = 'Bearer'

# create an instance of the API class
api_instance = .TemplateApi()
body =  # IPEGraph |  (optional)

try: 
    # store template
    api_response = api_instance.store_template(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling TemplateApi->storeTemplate: %s\n" % e)

Parameters

Body parameters
Name Description
body
Query parameters
Name Description

Responses

Status: 200 - successful operation