IBM Watson Decision Platform for Agriculture

Analytics

getAllJobs

Get All Jobs

/analytics/jobs/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//analytics/jobs/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AnalyticsApi apiInstance = new AnalyticsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[JobResponse] result = apiInstance.getAllJobs(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAllJobs");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[JobResponse] result = apiInstance.getAllJobs(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAllJobs");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get All Jobs
[apiInstance getAllJobsWith:xProfileId
              completionHandler: ^(array[JobResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AnalyticsApi()
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllJobs(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllJobsExample
    {
        public void main()
        {


            var apiInstance = new AnalyticsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get All Jobs
                array[JobResponse] result = apiInstance.getAllJobs(xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAllJobs: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAnalyticsApi();
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllJobs($xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAllJobs: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;


my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllJobs(xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAllJobs: $@\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.AnalyticsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get All Jobs
    api_response = api_instance.get_all_jobs(xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAllJobs: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

getAllJobsForStatus

Get All Jobs

/analytics/jobs/status/{jobStatus}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//analytics/jobs/status/{jobStatus}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobStatus = jobStatus_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[JobResponse] result = apiInstance.getAllJobsForStatus(jobStatus, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAllJobsForStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobStatus = jobStatus_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[JobResponse] result = apiInstance.getAllJobsForStatus(jobStatus, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getAllJobsForStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobStatus = jobStatus_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get All Jobs
[apiInstance getAllJobsForStatusWith:jobStatus
    xProfileId:xProfileId
              completionHandler: ^(array[JobResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AnalyticsApi()
var jobStatus = jobStatus_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllJobsForStatus(jobStatus, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllJobsForStatusExample
    {
        public void main()
        {


            var apiInstance = new AnalyticsApi();
            var jobStatus = jobStatus_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get All Jobs
                array[JobResponse] result = apiInstance.getAllJobsForStatus(jobStatus, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getAllJobsForStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAnalyticsApi();
$jobStatus = jobStatus_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllJobsForStatus($jobStatus, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getAllJobsForStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;


my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $jobStatus = jobStatus_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllJobsForStatus(jobStatus => $jobStatus, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getAllJobsForStatus: $@\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.AnalyticsApi()
jobStatus = jobStatus_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get All Jobs
    api_response = api_instance.get_all_jobs_for_status(jobStatus, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getAllJobsForStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
jobStatus*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 Jobs list successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

getJobData

Return Job data

/analytics/{jobId}/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream,application/json"\
"//analytics/{jobId}/data"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            apiInstance.getJobData(jobId, xProfileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getJobData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            apiInstance.getJobData(jobId, xProfileId);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getJobData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobId = jobId_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Return Job data
[apiInstance getJobDataWith:jobId
    xProfileId:xProfileId
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AnalyticsApi()
var jobId = jobId_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getJobData(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobDataExample
    {
        public void main()
        {


            var apiInstance = new AnalyticsApi();
            var jobId = jobId_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Return Job data
                apiInstance.getJobData(jobId, xProfileId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getJobData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAnalyticsApi();
$jobId = jobId_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $api_instance->getJobData($jobId, $xProfileId);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getJobData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;


my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $jobId = jobId_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    $api_instance->getJobData(jobId => $jobId, xProfileId => $xProfileId);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getJobData: $@\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.AnalyticsApi()
jobId = jobId_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Return Job data
    api_instance.get_job_data(jobId, xProfileId=xProfileId)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getJobData: %s\n" % e)

Parameters

Path parameters

Name	Description
jobId*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 SubField layer successfully found

Status: 400 - HTTP 400 Bad request; Job is not READY

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

Status: 500 - HTTP 500 Internal service error

Schema

getJobStatus

Get Job Status

/analytics/{jobId}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//analytics/{jobId}/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.getJobStatus(jobId, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getJobStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.getJobStatus(jobId, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#getJobStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobId = jobId_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get Job Status
[apiInstance getJobStatusWith:jobId
    xProfileId:xProfileId
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AnalyticsApi()
var jobId = jobId_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJobStatus(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJobStatusExample
    {
        public void main()
        {


            var apiInstance = new AnalyticsApi();
            var jobId = jobId_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get Job Status
                JobResponse result = apiInstance.getJobStatus(jobId, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.getJobStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAnalyticsApi();
$jobId = jobId_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getJobStatus($jobId, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->getJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;


my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $jobId = jobId_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getJobStatus(jobId => $jobId, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->getJobStatus: $@\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.AnalyticsApi()
jobId = jobId_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get Job Status
    api_response = api_instance.get_job_status(jobId, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->getJobStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
jobId*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 Job status successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

postJob

Post Job payload

/analytics/job

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//analytics/job"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AnalyticsApi;

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

public class AnalyticsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AnalyticsApi apiInstance = new AnalyticsApi();
        PostJobPayload body = ; // PostJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#postJob");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AnalyticsApi;

public class AnalyticsApiExample {

    public static void main(String[] args) {
        AnalyticsApi apiInstance = new AnalyticsApi();
        PostJobPayload body = ; // PostJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalyticsApi#postJob");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
PostJobPayload *body = ; // Submit new Job payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Post Job payload
[apiInstance postJobWith:body
    xProfileId:xProfileId
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AnalyticsApi()
var body = ; // {{PostJobPayload}} Submit new Job payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postJob(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postJobExample
    {
        public void main()
        {


            var apiInstance = new AnalyticsApi();
            var body = new PostJobPayload(); // PostJobPayload | Submit new Job payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Post Job payload
                JobResponse result = apiInstance.postJob(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AnalyticsApi.postJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAnalyticsApi();
$body = ; // PostJobPayload | Submit new Job payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->postJob($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalyticsApi->postJob: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AnalyticsApi;


my $api_instance = WWW::SwaggerClient::AnalyticsApi->new();
my $body = WWW::SwaggerClient::Object::PostJobPayload->new(); # PostJobPayload | Submit new Job payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->postJob(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AnalyticsApi->postJob: $@\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.AnalyticsApi()
body =  # PostJobPayload | Submit new Job payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Post Job payload
    api_response = api_instance.post_job(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->postJob: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 202 - HTTP 202 Job successfully created

Schema

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

AssetImport

assetImportSourceHandler.post

Imports assets from source

Imports assets from source and transforms it to target structure.

/assetimport/source

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//assetimport/source?mode="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetImportApi;

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

public class AssetImportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetImportApi apiInstance = new AssetImportApi();
        Assetimport_source_body body = ; // Assetimport_source_body | Properties for the request
        String mode = mode_example; // String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.
        try {
            AssetImportResponse result = apiInstance.assetImportSourceHandler.post(body, mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportSourceHandler.post");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetImportApi;

public class AssetImportApiExample {

    public static void main(String[] args) {
        AssetImportApi apiInstance = new AssetImportApi();
        Assetimport_source_body body = ; // Assetimport_source_body | Properties for the request
        String mode = mode_example; // String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.
        try {
            AssetImportResponse result = apiInstance.assetImportSourceHandler.post(body, mode);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportSourceHandler.post");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Assetimport_source_body *body = ; // Properties for the request
String *mode = mode_example; // Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way. (optional)

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

// Imports assets from source
[apiInstance assetImportSourceHandler.postWith:body
    mode:mode
              completionHandler: ^(AssetImportResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetImportApi()
var body = ; // {{Assetimport_source_body}} Properties for the request
var opts = { 
  'mode': mode_example // {{String}} Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assetImportSourceHandler.post(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assetImportSourceHandler.postExample
    {
        public void main()
        {


            var apiInstance = new AssetImportApi();
            var body = new Assetimport_source_body(); // Assetimport_source_body | Properties for the request
            var mode = mode_example;  // String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way. (optional) 

            try
            {
                // Imports assets from source
                AssetImportResponse result = apiInstance.assetImportSourceHandler.post(body, mode);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetImportApi.assetImportSourceHandler.post: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetImportApi();
$body = ; // Assetimport_source_body | Properties for the request
$mode = mode_example; // String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.

try {
    $result = $api_instance->assetImportSourceHandler.post($body, $mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetImportApi->assetImportSourceHandler.post: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetImportApi;


my $api_instance = WWW::SwaggerClient::AssetImportApi->new();
my $body = WWW::SwaggerClient::Object::Assetimport_source_body->new(); # Assetimport_source_body | Properties for the request
my $mode = mode_example; # String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.

eval { 
    my $result = $api_instance->assetImportSourceHandler.post(body => $body, mode => $mode);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetImportApi->assetImportSourceHandler.post: $@\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.AssetImportApi()
body =  # Assetimport_source_body | Properties for the request
mode = mode_example # String | Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way. (optional)

try: 
    # Imports assets from source
    api_response = api_instance.asset_import_source_handler/post(body, mode=mode)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetImportApi->assetImportSourceHandler.post: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Query parameters

Name	Description
mode	String Mode for the api. API will do everything(extraction, transformation and loading) in one go if "e2e" mode is used. If left empty, API will function normal way.

Responses

Status: 200 - Response Message for e2e mode

Schema

Status: 202 - Response Message for single/default mode

Schema

Status: 500 - Bad Request

Schema

assetImportTargetHandler.delete

Deletes transformed assets from target

/assetimport/target/{Id}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//assetimport/target/{Id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetImportApi;

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

public class AssetImportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetImportApi apiInstance = new AssetImportApi();
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetDeleteResponse result = apiInstance.assetImportTargetHandler.delete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetHandler.delete");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetImportApi;

public class AssetImportApiExample {

    public static void main(String[] args) {
        AssetImportApi apiInstance = new AssetImportApi();
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetDeleteResponse result = apiInstance.assetImportTargetHandler.delete(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetHandler.delete");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *id = id_example; // Id of the job. Job id returned inside source api.

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

// Deletes transformed assets from target
[apiInstance assetImportTargetHandler.deleteWith:id
              completionHandler: ^(AssetDeleteResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetImportApi()
var id = id_example; // {{String}} Id of the job. Job id returned inside source api.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assetImportTargetHandler.delete(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assetImportTargetHandler.deleteExample
    {
        public void main()
        {


            var apiInstance = new AssetImportApi();
            var id = id_example;  // String | Id of the job. Job id returned inside source api.

            try
            {
                // Deletes transformed assets from target
                AssetDeleteResponse result = apiInstance.assetImportTargetHandler.delete(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetImportApi.assetImportTargetHandler.delete: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetImportApi();
$id = id_example; // String | Id of the job. Job id returned inside source api.

try {
    $result = $api_instance->assetImportTargetHandler.delete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetImportApi->assetImportTargetHandler.delete: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetImportApi;


my $api_instance = WWW::SwaggerClient::AssetImportApi->new();
my $id = id_example; # String | Id of the job. Job id returned inside source api.

eval { 
    my $result = $api_instance->assetImportTargetHandler.delete(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetImportApi->assetImportTargetHandler.delete: $@\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.AssetImportApi()
id = id_example # String | Id of the job. Job id returned inside source api.

try: 
    # Deletes transformed assets from target
    api_response = api_instance.asset_import_target_handler/delete(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetImportApi->assetImportTargetHandler.delete: %s\n" % e)

Parameters

Path parameters

Name	Description
Id*	String Id of the job. Job id returned inside source api. Required

Responses

Status: 200 - Response Message for e2e mode

Schema

Status: 500 - Bad Request

Schema

assetImportTargetHandler.post

Loads transformed assets to target

/assetimport/target/{id}

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//assetimport/target/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetImportApi;

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

public class AssetImportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetImportApi apiInstance = new AssetImportApi();
        Target_id_body body = ; // Target_id_body | Properties for the request
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetImportResponse result = apiInstance.assetImportTargetHandler.post(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetHandler.post");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetImportApi;

public class AssetImportApiExample {

    public static void main(String[] args) {
        AssetImportApi apiInstance = new AssetImportApi();
        Target_id_body body = ; // Target_id_body | Properties for the request
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetImportResponse result = apiInstance.assetImportTargetHandler.post(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetHandler.post");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Target_id_body *body = ; // Properties for the request
String *id = id_example; // Id of the job. Job id returned inside source api.

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

// Loads transformed assets to target
[apiInstance assetImportTargetHandler.postWith:body
    id:id
              completionHandler: ^(AssetImportResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetImportApi()
var body = ; // {{Target_id_body}} Properties for the request
var id = id_example; // {{String}} Id of the job. Job id returned inside source api.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assetImportTargetHandler.post(bodyid, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assetImportTargetHandler.postExample
    {
        public void main()
        {


            var apiInstance = new AssetImportApi();
            var body = new Target_id_body(); // Target_id_body | Properties for the request
            var id = id_example;  // String | Id of the job. Job id returned inside source api.

            try
            {
                // Loads transformed assets to target
                AssetImportResponse result = apiInstance.assetImportTargetHandler.post(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetImportApi.assetImportTargetHandler.post: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetImportApi();
$body = ; // Target_id_body | Properties for the request
$id = id_example; // String | Id of the job. Job id returned inside source api.

try {
    $result = $api_instance->assetImportTargetHandler.post($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetImportApi->assetImportTargetHandler.post: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetImportApi;


my $api_instance = WWW::SwaggerClient::AssetImportApi->new();
my $body = WWW::SwaggerClient::Object::Target_id_body->new(); # Target_id_body | Properties for the request
my $id = id_example; # String | Id of the job. Job id returned inside source api.

eval { 
    my $result = $api_instance->assetImportTargetHandler.post(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetImportApi->assetImportTargetHandler.post: $@\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.AssetImportApi()
body =  # Target_id_body | Properties for the request
id = id_example # String | Id of the job. Job id returned inside source api.

try: 
    # Loads transformed assets to target
    api_response = api_instance.asset_import_target_handler/post(body, id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetImportApi->assetImportTargetHandler.post: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Id of the job. Job id returned inside source api. Required

Body parameters

Name	Description
body *

Responses

Status: 200 - Response Message for e2e mode

Schema

Status: 500 - Bad Request

Schema

assetImportTargetUpdateHandler.put

Update assets in target

/assetimport/target

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//assetimport/target"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetImportApi;

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

public class AssetImportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetImportApi apiInstance = new AssetImportApi();
        Assetimport_target_body body = ; // Assetimport_target_body | Properties for the request
        try {
            AssetImportTargetUpdateResponse result = apiInstance.assetImportTargetUpdateHandler.put(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetUpdateHandler.put");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetImportApi;

public class AssetImportApiExample {

    public static void main(String[] args) {
        AssetImportApi apiInstance = new AssetImportApi();
        Assetimport_target_body body = ; // Assetimport_target_body | Properties for the request
        try {
            AssetImportTargetUpdateResponse result = apiInstance.assetImportTargetUpdateHandler.put(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#assetImportTargetUpdateHandler.put");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Assetimport_target_body *body = ; // Properties for the request

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

// Update assets in target
[apiInstance assetImportTargetUpdateHandler.putWith:body
              completionHandler: ^(AssetImportTargetUpdateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetImportApi()
var body = ; // {{Assetimport_target_body}} Properties for the request

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.assetImportTargetUpdateHandler.put(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class assetImportTargetUpdateHandler.putExample
    {
        public void main()
        {


            var apiInstance = new AssetImportApi();
            var body = new Assetimport_target_body(); // Assetimport_target_body | Properties for the request

            try
            {
                // Update assets in target
                AssetImportTargetUpdateResponse result = apiInstance.assetImportTargetUpdateHandler.put(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetImportApi.assetImportTargetUpdateHandler.put: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetImportApi();
$body = ; // Assetimport_target_body | Properties for the request

try {
    $result = $api_instance->assetImportTargetUpdateHandler.put($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetImportApi->assetImportTargetUpdateHandler.put: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetImportApi;


my $api_instance = WWW::SwaggerClient::AssetImportApi->new();
my $body = WWW::SwaggerClient::Object::Assetimport_target_body->new(); # Assetimport_target_body | Properties for the request

eval { 
    my $result = $api_instance->assetImportTargetUpdateHandler.put(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetImportApi->assetImportTargetUpdateHandler.put: $@\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.AssetImportApi()
body =  # Assetimport_target_body | Properties for the request

try: 
    # Update assets in target
    api_response = api_instance.asset_import_target_update_handler/put(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetImportApi->assetImportTargetUpdateHandler.put: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - Response Message for target update

Schema

Status: 500 - Bad Request

Schema

statusHandler.get

Get status for the created jobs

Gets current status of the job.

/assetimport/status/{id}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//assetimport/status/{id}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetImportApi;

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

public class AssetImportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetImportApi apiInstance = new AssetImportApi();
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetImportStatus result = apiInstance.statusHandler.get(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#statusHandler.get");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetImportApi;

public class AssetImportApiExample {

    public static void main(String[] args) {
        AssetImportApi apiInstance = new AssetImportApi();
        String id = id_example; // String | Id of the job. Job id returned inside source api.
        try {
            AssetImportStatus result = apiInstance.statusHandler.get(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetImportApi#statusHandler.get");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *id = id_example; // Id of the job. Job id returned inside source api.

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

// Get status for the created jobs
[apiInstance statusHandler.getWith:id
              completionHandler: ^(AssetImportStatus output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetImportApi()
var id = id_example; // {{String}} Id of the job. Job id returned inside source api.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.statusHandler.get(id, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class statusHandler.getExample
    {
        public void main()
        {


            var apiInstance = new AssetImportApi();
            var id = id_example;  // String | Id of the job. Job id returned inside source api.

            try
            {
                // Get status for the created jobs
                AssetImportStatus result = apiInstance.statusHandler.get(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetImportApi.statusHandler.get: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetImportApi();
$id = id_example; // String | Id of the job. Job id returned inside source api.

try {
    $result = $api_instance->statusHandler.get($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetImportApi->statusHandler.get: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetImportApi;


my $api_instance = WWW::SwaggerClient::AssetImportApi->new();
my $id = id_example; # String | Id of the job. Job id returned inside source api.

eval { 
    my $result = $api_instance->statusHandler.get(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetImportApi->statusHandler.get: $@\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.AssetImportApi()
id = id_example # String | Id of the job. Job id returned inside source api.

try: 
    # Get status for the created jobs
    api_response = api_instance.status_handler/get(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetImportApi->statusHandler.get: %s\n" % e)

Parameters

Path parameters

Name	Description
id*	String Id of the job. Job id returned inside source api. Required

Responses

Status: 200 - Status for the asset import job.

Schema

Status: 500 - Bad Request

Schema

Assets

createAsset

Create an asset

Creates an asset using a geometry

/asset

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        CreateAssetPayload body = ; // CreateAssetPayload | Payload containing list of assets to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createAsset(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#createAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        CreateAssetPayload body = ; // CreateAssetPayload | Payload containing list of assets to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createAsset(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#createAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
CreateAssetPayload *body = ; // Payload containing list of assets to create
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create an asset
[apiInstance createAssetWith:body
    xProfileId:xProfileId
              completionHandler: ^(UUIDResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var body = ; // {{CreateAssetPayload}} Payload containing list of assets to create
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAsset(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createAssetExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new CreateAssetPayload(); // CreateAssetPayload | Payload containing list of assets to create
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create an asset
                UUIDResponse result = apiInstance.createAsset(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.createAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // CreateAssetPayload | Payload containing list of assets to create
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createAsset($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->createAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::CreateAssetPayload->new(); # CreateAssetPayload | Payload containing list of assets to create
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createAsset(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->createAsset: $@\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.AssetsApi()
body =  # CreateAssetPayload | Payload containing list of assets to create
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create an asset
    api_response = api_instance.create_asset(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->createAsset: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 201 - The asset was successfully created

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 530 - HTTP 530 Geo Parser Error

Schema

Status: 531 - HTTP 531 Database error

Schema

deleteAsset

Delete an asset

/asset/{assetUuid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//asset/{assetUuid}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteAsset(assetUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#deleteAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteAsset(assetUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#deleteAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *assetUuid = assetUuid_example; // Unique asset Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Delete an asset
[apiInstance deleteAssetWith:assetUuid
    xProfileId:xProfileId
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var assetUuid = assetUuid_example; // {{String}} Unique asset Uuid
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAsset(assetUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAssetExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var assetUuid = assetUuid_example;  // String | Unique asset Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Delete an asset
                APIResponseMessage result = apiInstance.deleteAsset(assetUuid, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.deleteAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$assetUuid = assetUuid_example; // String | Unique asset Uuid
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->deleteAsset($assetUuid, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->deleteAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $assetUuid = assetUuid_example; # String | Unique asset Uuid
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->deleteAsset(assetUuid => $assetUuid, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->deleteAsset: $@\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.AssetsApi()
assetUuid = assetUuid_example # String | Unique asset Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Delete an asset
    api_response = api_instance.delete_asset(assetUuid, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->deleteAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
assetUuid*	String Unique asset Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 204 - Asset(s) successfully deleted

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

deleteAssetsByParentReference

Delete all assets for a given parent reference

/asset

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//asset?parentReferenceUuid="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String parentReferenceUuid = parentReferenceUuid_example; // String | Parent reference uuid
        try {
            APIResponseMessage result = apiInstance.deleteAssetsByParentReference(xProfileId, parentReferenceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#deleteAssetsByParentReference");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String parentReferenceUuid = parentReferenceUuid_example; // String | Parent reference uuid
        try {
            APIResponseMessage result = apiInstance.deleteAssetsByParentReference(xProfileId, parentReferenceUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#deleteAssetsByParentReference");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *parentReferenceUuid = parentReferenceUuid_example; // Parent reference uuid (optional)

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

// Delete all assets for a given parent reference
[apiInstance deleteAssetsByParentReferenceWith:xProfileId
    parentReferenceUuid:parentReferenceUuid
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'parentReferenceUuid': parentReferenceUuid_example // {{String}} Parent reference uuid
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAssetsByParentReference(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteAssetsByParentReferenceExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var parentReferenceUuid = parentReferenceUuid_example;  // String | Parent reference uuid (optional) 

            try
            {
                // Delete all assets for a given parent reference
                APIResponseMessage result = apiInstance.deleteAssetsByParentReference(xProfileId, parentReferenceUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.deleteAssetsByParentReference: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$parentReferenceUuid = parentReferenceUuid_example; // String | Parent reference uuid

try {
    $result = $api_instance->deleteAssetsByParentReference($xProfileId, $parentReferenceUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->deleteAssetsByParentReference: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $parentReferenceUuid = parentReferenceUuid_example; # String | Parent reference uuid

eval { 
    my $result = $api_instance->deleteAssetsByParentReference(xProfileId => $xProfileId, parentReferenceUuid => $parentReferenceUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->deleteAssetsByParentReference: $@\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.AssetsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
parentReferenceUuid = parentReferenceUuid_example # String | Parent reference uuid (optional)

try: 
    # Delete all assets for a given parent reference
    api_response = api_instance.delete_assets_by_parent_reference(xProfileId=xProfileId, parentReferenceUuid=parentReferenceUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->deleteAssetsByParentReference: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
parentReferenceUuid	String Parent reference uuid

Responses

Status: 204 - Asset(s) successfully deleted

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getAllAssets

Returns a list of assets

Returns a list of asset

/asset

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//asset?uuidsOnly=&start=&limit=&sort=&projection=&parentReferenceUuid=&includeAllChildren=&inputType=&includeDeleted=&includeScalarInfo=&includeScalarTypeInfo=&includeAssetGeometry=&includeRawGeometry=&bufferSize=&includeInternalName="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        UUID parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Parent reference uuid
        Boolean includeAllChildren = true; // Boolean | Include all eventual children of parent reference uuid
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted subfields
        Boolean includeScalarInfo = true; // Boolean | Include scalar information
        Boolean includeScalarTypeInfo = true; // Boolean | Include scalar type information
        Boolean includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
        Boolean includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        Boolean includeInternalName = true; // Boolean | Include Internal Name
        try {
            AssetFeature result = apiInstance.getAllAssets(xProfileId, uuidsOnly, start, limit, sort, projection, parentReferenceUuid, includeAllChildren, inputType, includeDeleted, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssets");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        UUID parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Parent reference uuid
        Boolean includeAllChildren = true; // Boolean | Include all eventual children of parent reference uuid
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted subfields
        Boolean includeScalarInfo = true; // Boolean | Include scalar information
        Boolean includeScalarTypeInfo = true; // Boolean | Include scalar type information
        Boolean includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
        Boolean includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        Boolean includeInternalName = true; // Boolean | Include Internal Name
        try {
            AssetFeature result = apiInstance.getAllAssets(xProfileId, uuidsOnly, start, limit, sort, projection, parentReferenceUuid, includeAllChildren, inputType, includeDeleted, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssets");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *uuidsOnly = true; // UUIDs Only - Return an array of subfield UUID's (optional) (default to false)
Integer *start = 56; // Start pagination offset (optional) (default to 0)
Integer *limit = 56; // Results per page (optional) (default to 10)
String *sort = sort_example; // Results sort order (optional) (default to id)
Integer *projection = 56; // Image Projection (optional) (default to 4326)
UUID *parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Parent reference uuid (optional)
Boolean *includeAllChildren = true; // Include all eventual children of parent reference uuid (optional) (default to false)
String *inputType = inputType_example; // Input type (optional)
Boolean *includeDeleted = true; // Include deleted subfields (optional) (default to false)
Boolean *includeScalarInfo = true; // Include scalar information (optional) (default to false)
Boolean *includeScalarTypeInfo = true; // Include scalar type information (optional) (default to true)
Boolean *includeAssetGeometry = true; // Include Asset GeoJson geometry in response (optional) (default to true)
Boolean *includeRawGeometry = true; // Return original raw Geometry (if present) instead of Asset Geometry  (optional)
Double *bufferSize = 1.2; // Buffer size around geometry (optional)
Boolean *includeInternalName = true; // Include Internal Name (optional) (default to false)

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

// Returns a list of assets
[apiInstance getAllAssetsWith:xProfileId
    uuidsOnly:uuidsOnly
    start:start
    limit:limit
    sort:sort
    projection:projection
    parentReferenceUuid:parentReferenceUuid
    includeAllChildren:includeAllChildren
    inputType:inputType
    includeDeleted:includeDeleted
    includeScalarInfo:includeScalarInfo
    includeScalarTypeInfo:includeScalarTypeInfo
    includeAssetGeometry:includeAssetGeometry
    includeRawGeometry:includeRawGeometry
    bufferSize:bufferSize
    includeInternalName:includeInternalName
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'uuidsOnly': true, // {{Boolean}} UUIDs Only - Return an array of subfield UUID's
  'start': 56, // {{Integer}} Start pagination offset
  'limit': 56, // {{Integer}} Results per page
  'sort': sort_example, // {{String}} Results sort order
  'projection': 56, // {{Integer}} Image Projection
  'parentReferenceUuid': 38400000-8cf0-11bd-b23e-10b96e4ef00d, // {{UUID}} Parent reference uuid
  'includeAllChildren': true, // {{Boolean}} Include all eventual children of parent reference uuid
  'inputType': inputType_example, // {{String}} Input type
  'includeDeleted': true, // {{Boolean}} Include deleted subfields
  'includeScalarInfo': true, // {{Boolean}} Include scalar information
  'includeScalarTypeInfo': true, // {{Boolean}} Include scalar type information
  'includeAssetGeometry': true, // {{Boolean}} Include Asset GeoJson geometry in response
  'includeRawGeometry': true, // {{Boolean}} Return original raw Geometry (if present) instead of Asset Geometry 
  'bufferSize': 1.2, // {{Double}} Buffer size around geometry
  'includeInternalName': true // {{Boolean}} Include Internal Name
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAssets(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAssetsExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var uuidsOnly = true;  // Boolean | UUIDs Only - Return an array of subfield UUID's (optional)  (default to false)
            var start = 56;  // Integer | Start pagination offset (optional)  (default to 0)
            var limit = 56;  // Integer | Results per page (optional)  (default to 10)
            var sort = sort_example;  // String | Results sort order (optional)  (default to id)
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)
            var parentReferenceUuid = new UUID(); // UUID | Parent reference uuid (optional) 
            var includeAllChildren = true;  // Boolean | Include all eventual children of parent reference uuid (optional)  (default to false)
            var inputType = inputType_example;  // String | Input type (optional) 
            var includeDeleted = true;  // Boolean | Include deleted subfields (optional)  (default to false)
            var includeScalarInfo = true;  // Boolean | Include scalar information (optional)  (default to false)
            var includeScalarTypeInfo = true;  // Boolean | Include scalar type information (optional)  (default to true)
            var includeAssetGeometry = true;  // Boolean | Include Asset GeoJson geometry in response (optional)  (default to true)
            var includeRawGeometry = true;  // Boolean | Return original raw Geometry (if present) instead of Asset Geometry  (optional) 
            var bufferSize = 1.2;  // Double | Buffer size around geometry (optional) 
            var includeInternalName = true;  // Boolean | Include Internal Name (optional)  (default to false)

            try
            {
                // Returns a list of assets
                AssetFeature result = apiInstance.getAllAssets(xProfileId, uuidsOnly, start, limit, sort, projection, parentReferenceUuid, includeAllChildren, inputType, includeDeleted, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAllAssets: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
$start = 56; // Integer | Start pagination offset
$limit = 56; // Integer | Results per page
$sort = sort_example; // String | Results sort order
$projection = 56; // Integer | Image Projection
$parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Parent reference uuid
$includeAllChildren = true; // Boolean | Include all eventual children of parent reference uuid
$inputType = inputType_example; // String | Input type
$includeDeleted = true; // Boolean | Include deleted subfields
$includeScalarInfo = true; // Boolean | Include scalar information
$includeScalarTypeInfo = true; // Boolean | Include scalar type information
$includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
$includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
$bufferSize = 1.2; // Double | Buffer size around geometry
$includeInternalName = true; // Boolean | Include Internal Name

try {
    $result = $api_instance->getAllAssets($xProfileId, $uuidsOnly, $start, $limit, $sort, $projection, $parentReferenceUuid, $includeAllChildren, $inputType, $includeDeleted, $includeScalarInfo, $includeScalarTypeInfo, $includeAssetGeometry, $includeRawGeometry, $bufferSize, $includeInternalName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAllAssets: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $uuidsOnly = true; # Boolean | UUIDs Only - Return an array of subfield UUID's
my $start = 56; # Integer | Start pagination offset
my $limit = 56; # Integer | Results per page
my $sort = sort_example; # String | Results sort order
my $projection = 56; # Integer | Image Projection
my $parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Parent reference uuid
my $includeAllChildren = true; # Boolean | Include all eventual children of parent reference uuid
my $inputType = inputType_example; # String | Input type
my $includeDeleted = true; # Boolean | Include deleted subfields
my $includeScalarInfo = true; # Boolean | Include scalar information
my $includeScalarTypeInfo = true; # Boolean | Include scalar type information
my $includeAssetGeometry = true; # Boolean | Include Asset GeoJson geometry in response
my $includeRawGeometry = true; # Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
my $bufferSize = 1.2; # Double | Buffer size around geometry
my $includeInternalName = true; # Boolean | Include Internal Name

eval { 
    my $result = $api_instance->getAllAssets(xProfileId => $xProfileId, uuidsOnly => $uuidsOnly, start => $start, limit => $limit, sort => $sort, projection => $projection, parentReferenceUuid => $parentReferenceUuid, includeAllChildren => $includeAllChildren, inputType => $inputType, includeDeleted => $includeDeleted, includeScalarInfo => $includeScalarInfo, includeScalarTypeInfo => $includeScalarTypeInfo, includeAssetGeometry => $includeAssetGeometry, includeRawGeometry => $includeRawGeometry, bufferSize => $bufferSize, includeInternalName => $includeInternalName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAllAssets: $@\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.AssetsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
uuidsOnly = true # Boolean | UUIDs Only - Return an array of subfield UUID's (optional) (default to false)
start = 56 # Integer | Start pagination offset (optional) (default to 0)
limit = 56 # Integer | Results per page (optional) (default to 10)
sort = sort_example # String | Results sort order (optional) (default to id)
projection = 56 # Integer | Image Projection (optional) (default to 4326)
parentReferenceUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Parent reference uuid (optional)
includeAllChildren = true # Boolean | Include all eventual children of parent reference uuid (optional) (default to false)
inputType = inputType_example # String | Input type (optional)
includeDeleted = true # Boolean | Include deleted subfields (optional) (default to false)
includeScalarInfo = true # Boolean | Include scalar information (optional) (default to false)
includeScalarTypeInfo = true # Boolean | Include scalar type information (optional) (default to true)
includeAssetGeometry = true # Boolean | Include Asset GeoJson geometry in response (optional) (default to true)
includeRawGeometry = true # Boolean | Return original raw Geometry (if present) instead of Asset Geometry  (optional)
bufferSize = 1.2 # Double | Buffer size around geometry (optional)
includeInternalName = true # Boolean | Include Internal Name (optional) (default to false)

try: 
    # Returns a list of assets
    api_response = api_instance.get_all_assets(xProfileId=xProfileId, uuidsOnly=uuidsOnly, start=start, limit=limit, sort=sort, projection=projection, parentReferenceUuid=parentReferenceUuid, includeAllChildren=includeAllChildren, inputType=inputType, includeDeleted=includeDeleted, includeScalarInfo=includeScalarInfo, includeScalarTypeInfo=includeScalarTypeInfo, includeAssetGeometry=includeAssetGeometry, includeRawGeometry=includeRawGeometry, bufferSize=bufferSize, includeInternalName=includeInternalName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAllAssets: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
uuidsOnly	Boolean UUIDs Only - Return an array of subfield UUID's
start	Integer (int32) Start pagination offset
limit	Integer (int32) Results per page
sort	String Results sort order
projection	Integer (int32) Image Projection
parentReferenceUuid	UUID (uuid) Parent reference uuid
includeAllChildren	Boolean Include all eventual children of parent reference uuid
inputType	String Input type
includeDeleted	Boolean Include deleted subfields
includeScalarInfo	Boolean Include scalar information
includeScalarTypeInfo	Boolean Include scalar type information
includeAssetGeometry	Boolean Include Asset GeoJson geometry in response
includeRawGeometry	Boolean Return original raw Geometry (if present) instead of Asset Geometry
bufferSize	Double (double) Buffer size around geometry
includeInternalName	Boolean Include Internal Name

Responses

Status: 200 - Asset(s) successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset(s) not found

Schema

getAllAssetsByBoundingBox

Search for a list of assets for a given bounding box

/asset/search/box

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/search/box"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        SearchByBoxPayload body = ; // SearchByBoxPayload | Search for a list of assets for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAllAssetsByBoundingBox(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssetsByBoundingBox");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        SearchByBoxPayload body = ; // SearchByBoxPayload | Search for a list of assets for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAllAssetsByBoundingBox(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssetsByBoundingBox");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByBoxPayload *body = ; // Search for a list of assets for a given bounding box
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of assets for a given bounding box
[apiInstance getAllAssetsByBoundingBoxWith:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var body = ; // {{SearchByBoxPayload}} Search for a list of assets for a given bounding box
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAssetsByBoundingBox(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAssetsByBoundingBoxExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new SearchByBoxPayload(); // SearchByBoxPayload | Search for a list of assets for a given bounding box
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of assets for a given bounding box
                AssetFeature result = apiInstance.getAllAssetsByBoundingBox(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAllAssetsByBoundingBox: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // SearchByBoxPayload | Search for a list of assets for a given bounding box
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllAssetsByBoundingBox($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAllAssetsByBoundingBox: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByBoxPayload->new(); # SearchByBoxPayload | Search for a list of assets for a given bounding box
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllAssetsByBoundingBox(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAllAssetsByBoundingBox: $@\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.AssetsApi()
body =  # SearchByBoxPayload | Search for a list of assets for a given bounding box
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of assets for a given bounding box
    api_response = api_instance.get_all_assets_by_bounding_box(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAllAssetsByBoundingBox: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - SubFields successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

getAllAssetsByGeometry

Search for a list of assets for a given GeoJson geometry

/asset/search/geometry

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/search/geometry"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        SearchByGeometryPayload body = ; // SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAllAssetsByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssetsByGeometry");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        SearchByGeometryPayload body = ; // SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAllAssetsByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAllAssetsByGeometry");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByGeometryPayload *body = ; // Search for a list of assets for a given GeoJson geometry
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of assets for a given GeoJson geometry
[apiInstance getAllAssetsByGeometryWith:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var body = ; // {{SearchByGeometryPayload}} Search for a list of assets for a given GeoJson geometry
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllAssetsByGeometry(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllAssetsByGeometryExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new SearchByGeometryPayload(); // SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of assets for a given GeoJson geometry
                AssetFeature result = apiInstance.getAllAssetsByGeometry(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAllAssetsByGeometry: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllAssetsByGeometry($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAllAssetsByGeometry: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByGeometryPayload->new(); # SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllAssetsByGeometry(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAllAssetsByGeometry: $@\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.AssetsApi()
body =  # SearchByGeometryPayload | Search for a list of assets for a given GeoJson geometry
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of assets for a given GeoJson geometry
    api_response = api_instance.get_all_assets_by_geometry(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAllAssetsByGeometry: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Assets successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

getAsset

Get an asset

/asset/{assetUuid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//asset/{assetUuid}?projection=&includeScalarInfo=&includeScalarTypeInfo=&includeAssetGeometry=&includeRawGeometry=&bufferSize=&includeInternalName="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        Boolean includeScalarInfo = true; // Boolean | Include scalar information
        Boolean includeScalarTypeInfo = true; // Boolean | Include scalar type information
        Boolean includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
        Boolean includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        Boolean includeInternalName = true; // Boolean | Include Internal Name
        try {
            AssetFeature result = apiInstance.getAsset(assetUuid, xProfileId, projection, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        Boolean includeScalarInfo = true; // Boolean | Include scalar information
        Boolean includeScalarTypeInfo = true; // Boolean | Include scalar type information
        Boolean includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
        Boolean includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        Boolean includeInternalName = true; // Boolean | Include Internal Name
        try {
            AssetFeature result = apiInstance.getAsset(assetUuid, xProfileId, projection, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *assetUuid = assetUuid_example; // Unique asset Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)
Integer *projection = 56; // Image Projection (optional) (default to 4326)
Boolean *includeScalarInfo = true; // Include scalar information (optional) (default to false)
Boolean *includeScalarTypeInfo = true; // Include scalar type information (optional) (default to true)
Boolean *includeAssetGeometry = true; // Include Asset GeoJson geometry in response (optional) (default to true)
Boolean *includeRawGeometry = true; // Return original raw Geometry (if present) instead of Asset Geometry  (optional)
Double *bufferSize = 1.2; // Buffer size around geometry (optional)
Boolean *includeInternalName = true; // Include Internal Name (optional) (default to false)

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

// Get an asset
[apiInstance getAssetWith:assetUuid
    xProfileId:xProfileId
    projection:projection
    includeScalarInfo:includeScalarInfo
    includeScalarTypeInfo:includeScalarTypeInfo
    includeAssetGeometry:includeAssetGeometry
    includeRawGeometry:includeRawGeometry
    bufferSize:bufferSize
    includeInternalName:includeInternalName
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var assetUuid = assetUuid_example; // {{String}} Unique asset Uuid
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'projection': 56, // {{Integer}} Image Projection
  'includeScalarInfo': true, // {{Boolean}} Include scalar information
  'includeScalarTypeInfo': true, // {{Boolean}} Include scalar type information
  'includeAssetGeometry': true, // {{Boolean}} Include Asset GeoJson geometry in response
  'includeRawGeometry': true, // {{Boolean}} Return original raw Geometry (if present) instead of Asset Geometry 
  'bufferSize': 1.2, // {{Double}} Buffer size around geometry
  'includeInternalName': true // {{Boolean}} Include Internal Name
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAsset(assetUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAssetExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var assetUuid = assetUuid_example;  // String | Unique asset Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)
            var includeScalarInfo = true;  // Boolean | Include scalar information (optional)  (default to false)
            var includeScalarTypeInfo = true;  // Boolean | Include scalar type information (optional)  (default to true)
            var includeAssetGeometry = true;  // Boolean | Include Asset GeoJson geometry in response (optional)  (default to true)
            var includeRawGeometry = true;  // Boolean | Return original raw Geometry (if present) instead of Asset Geometry  (optional) 
            var bufferSize = 1.2;  // Double | Buffer size around geometry (optional) 
            var includeInternalName = true;  // Boolean | Include Internal Name (optional)  (default to false)

            try
            {
                // Get an asset
                AssetFeature result = apiInstance.getAsset(assetUuid, xProfileId, projection, includeScalarInfo, includeScalarTypeInfo, includeAssetGeometry, includeRawGeometry, bufferSize, includeInternalName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$assetUuid = assetUuid_example; // String | Unique asset Uuid
$xProfileId = xProfileId_example; // String | Profile Id
$projection = 56; // Integer | Image Projection
$includeScalarInfo = true; // Boolean | Include scalar information
$includeScalarTypeInfo = true; // Boolean | Include scalar type information
$includeAssetGeometry = true; // Boolean | Include Asset GeoJson geometry in response
$includeRawGeometry = true; // Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
$bufferSize = 1.2; // Double | Buffer size around geometry
$includeInternalName = true; // Boolean | Include Internal Name

try {
    $result = $api_instance->getAsset($assetUuid, $xProfileId, $projection, $includeScalarInfo, $includeScalarTypeInfo, $includeAssetGeometry, $includeRawGeometry, $bufferSize, $includeInternalName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $assetUuid = assetUuid_example; # String | Unique asset Uuid
my $xProfileId = xProfileId_example; # String | Profile Id
my $projection = 56; # Integer | Image Projection
my $includeScalarInfo = true; # Boolean | Include scalar information
my $includeScalarTypeInfo = true; # Boolean | Include scalar type information
my $includeAssetGeometry = true; # Boolean | Include Asset GeoJson geometry in response
my $includeRawGeometry = true; # Boolean | Return original raw Geometry (if present) instead of Asset Geometry 
my $bufferSize = 1.2; # Double | Buffer size around geometry
my $includeInternalName = true; # Boolean | Include Internal Name

eval { 
    my $result = $api_instance->getAsset(assetUuid => $assetUuid, xProfileId => $xProfileId, projection => $projection, includeScalarInfo => $includeScalarInfo, includeScalarTypeInfo => $includeScalarTypeInfo, includeAssetGeometry => $includeAssetGeometry, includeRawGeometry => $includeRawGeometry, bufferSize => $bufferSize, includeInternalName => $includeInternalName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAsset: $@\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.AssetsApi()
assetUuid = assetUuid_example # String | Unique asset Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)
projection = 56 # Integer | Image Projection (optional) (default to 4326)
includeScalarInfo = true # Boolean | Include scalar information (optional) (default to false)
includeScalarTypeInfo = true # Boolean | Include scalar type information (optional) (default to true)
includeAssetGeometry = true # Boolean | Include Asset GeoJson geometry in response (optional) (default to true)
includeRawGeometry = true # Boolean | Return original raw Geometry (if present) instead of Asset Geometry  (optional)
bufferSize = 1.2 # Double | Buffer size around geometry (optional)
includeInternalName = true # Boolean | Include Internal Name (optional) (default to false)

try: 
    # Get an asset
    api_response = api_instance.get_asset(assetUuid, xProfileId=xProfileId, projection=projection, includeScalarInfo=includeScalarInfo, includeScalarTypeInfo=includeScalarTypeInfo, includeAssetGeometry=includeAssetGeometry, includeRawGeometry=includeRawGeometry, bufferSize=bufferSize, includeInternalName=includeInternalName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
assetUuid*	String Unique asset Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
projection	Integer (int32) Image Projection
includeScalarInfo	Boolean Include scalar information
includeScalarTypeInfo	Boolean Include scalar type information
includeAssetGeometry	Boolean Include Asset GeoJson geometry in response
includeRawGeometry	Boolean Return original raw Geometry (if present) instead of Asset Geometry
bufferSize	Double (double) Buffer size around geometry
includeInternalName	Boolean Include Internal Name

Responses

Status: 200 - Asset successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

getAssetsForAll

Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]

/asset/search

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/search"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        SearchByAllPayload body = ; // SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAssetsForAll(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAssetsForAll");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        SearchByAllPayload body = ; // SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAssetsForAll(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAssetsForAll");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByAllPayload *body = ; // Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
[apiInstance getAssetsForAllWith:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var body = ; // {{SearchByAllPayload}} Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAssetsForAll(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAssetsForAllExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new SearchByAllPayload(); // SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
                AssetFeature result = apiInstance.getAssetsForAll(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAssetsForAll: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAssetsForAll($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAssetsForAll: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByAllPayload->new(); # SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAssetsForAll(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAssetsForAll: $@\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.AssetsApi()
body =  # SearchByAllPayload | Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of assets for a given set of [bbox,geoJson,properties,scalarData]
    api_response = api_instance.get_assets_for_all(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAssetsForAll: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Asset(s) successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

getAssetsForProperties

Search for a list of assets for a given set of properties

/asset/search/property

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/search/property"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        SearchByPropertiesPayload body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAssetsForProperties(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAssetsForProperties");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        SearchByPropertiesPayload body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.getAssetsForProperties(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#getAssetsForProperties");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByPropertiesPayload *body = ; // Search for a list of subfields for a given set of properties
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of assets for a given set of properties
[apiInstance getAssetsForPropertiesWith:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var body = ; // {{SearchByPropertiesPayload}} Search for a list of subfields for a given set of properties
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAssetsForProperties(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAssetsForPropertiesExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new SearchByPropertiesPayload(); // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of assets for a given set of properties
                AssetFeature result = apiInstance.getAssetsForProperties(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.getAssetsForProperties: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAssetsForProperties($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->getAssetsForProperties: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByPropertiesPayload->new(); # SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAssetsForProperties(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->getAssetsForProperties: $@\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.AssetsApi()
body =  # SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of assets for a given set of properties
    api_response = api_instance.get_assets_for_properties(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->getAssetsForProperties: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Asset(s) successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

updateAsset

Update an asset

Update asset details

/asset/{assetUuid}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/{assetUuid}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        UpdateAssetPayload body = ; // UpdateAssetPayload | Update asset payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.updateAsset(assetUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#updateAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        UpdateAssetPayload body = ; // UpdateAssetPayload | Update asset payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.updateAsset(assetUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#updateAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *assetUuid = assetUuid_example; // Unique asset Uuid
UpdateAssetPayload *body = ; // Update asset payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Update an asset
[apiInstance updateAssetWith:assetUuid
    body:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var assetUuid = assetUuid_example; // {{String}} Unique asset Uuid
var opts = { 
  'body':  // {{UpdateAssetPayload}} Update asset payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAsset(assetUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAssetExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var assetUuid = assetUuid_example;  // String | Unique asset Uuid
            var body = new UpdateAssetPayload(); // UpdateAssetPayload | Update asset payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Update an asset
                AssetFeature result = apiInstance.updateAsset(assetUuid, body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.updateAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$assetUuid = assetUuid_example; // String | Unique asset Uuid
$body = ; // UpdateAssetPayload | Update asset payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->updateAsset($assetUuid, $body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->updateAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $assetUuid = assetUuid_example; # String | Unique asset Uuid
my $body = WWW::SwaggerClient::Object::UpdateAssetPayload->new(); # UpdateAssetPayload | Update asset payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->updateAsset(assetUuid => $assetUuid, body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->updateAsset: $@\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.AssetsApi()
assetUuid = assetUuid_example # String | Unique asset Uuid
body =  # UpdateAssetPayload | Update asset payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Update an asset
    api_response = api_instance.update_asset(assetUuid, body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->updateAsset: %s\n" % e)

Parameters

Path parameters

Name	Description
assetUuid*	String Unique asset Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - The asset was successfully updated

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

updateAssets

Update a list of assets

Update asset details

/asset

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AssetsApi;

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

public class AssetsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        AssetsApi apiInstance = new AssetsApi();
        UpdateAssetsPayload body = ; // UpdateAssetsPayload | Update asset payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeatureCollection result = apiInstance.updateAssets(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#updateAssets");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.AssetsApi;

public class AssetsApiExample {

    public static void main(String[] args) {
        AssetsApi apiInstance = new AssetsApi();
        UpdateAssetsPayload body = ; // UpdateAssetsPayload | Update asset payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeatureCollection result = apiInstance.updateAssets(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AssetsApi#updateAssets");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UpdateAssetsPayload *body = ; // Update asset payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Update a list of assets
[apiInstance updateAssetsWith:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.AssetsApi()
var opts = { 
  'body':  // {{UpdateAssetsPayload}} Update asset payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAssets(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateAssetsExample
    {
        public void main()
        {


            var apiInstance = new AssetsApi();
            var body = new UpdateAssetsPayload(); // UpdateAssetsPayload | Update asset payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Update a list of assets
                AssetFeatureCollection result = apiInstance.updateAssets(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AssetsApi.updateAssets: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiAssetsApi();
$body = ; // UpdateAssetsPayload | Update asset payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->updateAssets($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AssetsApi->updateAssets: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AssetsApi;


my $api_instance = WWW::SwaggerClient::AssetsApi->new();
my $body = WWW::SwaggerClient::Object::UpdateAssetsPayload->new(); # UpdateAssetsPayload | Update asset payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->updateAssets(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AssetsApi->updateAssets: $@\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.AssetsApi()
body =  # UpdateAssetsPayload | Update asset payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Update a list of assets
    api_response = api_instance.update_assets(body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AssetsApi->updateAssets: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - The asset was successfully updated

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

CarbonAccountingEngine

fugitiveEmission

Calculates fugitive emission

/carbon/fugitive

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/fugitive"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        FugitivePayload body = ; // FugitivePayload | Payload for fugitive emission
        try {
            FugitiveResponse result = apiInstance.fugitiveEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#fugitiveEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        FugitivePayload body = ; // FugitivePayload | Payload for fugitive emission
        try {
            FugitiveResponse result = apiInstance.fugitiveEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#fugitiveEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
FugitivePayload *body = ; // Payload for fugitive emission

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

// Calculates fugitive emission
[apiInstance fugitiveEmissionWith:body
              completionHandler: ^(FugitiveResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{FugitivePayload}} Payload for fugitive emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fugitiveEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class fugitiveEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new FugitivePayload(); // FugitivePayload | Payload for fugitive emission

            try
            {
                // Calculates fugitive emission
                FugitiveResponse result = apiInstance.fugitiveEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.fugitiveEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // FugitivePayload | Payload for fugitive emission

try {
    $result = $api_instance->fugitiveEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->fugitiveEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::FugitivePayload->new(); # FugitivePayload | Payload for fugitive emission

eval { 
    my $result = $api_instance->fugitiveEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->fugitiveEmission: $@\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.CarbonAccountingEngineApi()
body =  # FugitivePayload | Payload for fugitive emission

try: 
    # Calculates fugitive emission
    api_response = api_instance.fugitive_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->fugitiveEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalid payload

Schema

Status: 400 - Failure, problem with input data

Schema

locationEmission

Calculates location based emission

/carbon/location

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/location"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        LocationPayload body = ; // LocationPayload | Payload for location based emission
        try {
            LocationResponse result = apiInstance.locationEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#locationEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        LocationPayload body = ; // LocationPayload | Payload for location based emission
        try {
            LocationResponse result = apiInstance.locationEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#locationEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
LocationPayload *body = ; // Payload for location based emission

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

// Calculates location based emission
[apiInstance locationEmissionWith:body
              completionHandler: ^(LocationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{LocationPayload}} Payload for location based emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.locationEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class locationEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new LocationPayload(); // LocationPayload | Payload for location based emission

            try
            {
                // Calculates location based emission
                LocationResponse result = apiInstance.locationEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.locationEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // LocationPayload | Payload for location based emission

try {
    $result = $api_instance->locationEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->locationEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::LocationPayload->new(); # LocationPayload | Payload for location based emission

eval { 
    my $result = $api_instance->locationEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->locationEmission: $@\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.CarbonAccountingEngineApi()
body =  # LocationPayload | Payload for location based emission

try: 
    # Calculates location based emission
    api_response = api_instance.location_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->locationEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalidy payload

Schema

Status: 400 - Failure, problem with input data

Schema

marketEmission

Calculates market based emission

/carbon/market

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/market"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        MarketPayload body = ; // MarketPayload | Payload for market based emission
        try {
            MarketResponse result = apiInstance.marketEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#marketEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        MarketPayload body = ; // MarketPayload | Payload for market based emission
        try {
            MarketResponse result = apiInstance.marketEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#marketEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
MarketPayload *body = ; // Payload for market based emission

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

// Calculates market based emission
[apiInstance marketEmissionWith:body
              completionHandler: ^(MarketResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{MarketPayload}} Payload for market based emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.marketEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class marketEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new MarketPayload(); // MarketPayload | Payload for market based emission

            try
            {
                // Calculates market based emission
                MarketResponse result = apiInstance.marketEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.marketEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // MarketPayload | Payload for market based emission

try {
    $result = $api_instance->marketEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->marketEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::MarketPayload->new(); # MarketPayload | Payload for market based emission

eval { 
    my $result = $api_instance->marketEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->marketEmission: $@\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.CarbonAccountingEngineApi()
body =  # MarketPayload | Payload for market based emission

try: 
    # Calculates market based emission
    api_response = api_instance.market_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->marketEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalidy payload

Schema

Status: 400 - Failure, problem with input data

Schema

mobileEmission

Calculates mobile emission

/carbon/mobile

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/mobile"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        MobilePayload body = ; // MobilePayload | Payload for mobile emission
        try {
            MobileResponse result = apiInstance.mobileEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#mobileEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        MobilePayload body = ; // MobilePayload | Payload for mobile emission
        try {
            MobileResponse result = apiInstance.mobileEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#mobileEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
MobilePayload *body = ; // Payload for mobile emission

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

// Calculates mobile emission
[apiInstance mobileEmissionWith:body
              completionHandler: ^(MobileResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{MobilePayload}} Payload for mobile emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mobileEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class mobileEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new MobilePayload(); // MobilePayload | Payload for mobile emission

            try
            {
                // Calculates mobile emission
                MobileResponse result = apiInstance.mobileEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.mobileEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // MobilePayload | Payload for mobile emission

try {
    $result = $api_instance->mobileEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->mobileEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::MobilePayload->new(); # MobilePayload | Payload for mobile emission

eval { 
    my $result = $api_instance->mobileEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->mobileEmission: $@\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.CarbonAccountingEngineApi()
body =  # MobilePayload | Payload for mobile emission

try: 
    # Calculates mobile emission
    api_response = api_instance.mobile_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->mobileEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalid payload

Schema

Status: 404 - Failure, item not found

Schema

Status: 400 - Failure, problem wiht input data

Schema

stationaryEmission

Calculates stationary emission

/carbon/stationary

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/stationary"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        StationaryPayload body = ; // StationaryPayload | Payload for stationary emission
        try {
            StationaryResponse result = apiInstance.stationaryEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#stationaryEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        StationaryPayload body = ; // StationaryPayload | Payload for stationary emission
        try {
            StationaryResponse result = apiInstance.stationaryEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#stationaryEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
StationaryPayload *body = ; // Payload for stationary emission

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

// Calculates stationary emission
[apiInstance stationaryEmissionWith:body
              completionHandler: ^(StationaryResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{StationaryPayload}} Payload for stationary emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.stationaryEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class stationaryEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new StationaryPayload(); // StationaryPayload | Payload for stationary emission

            try
            {
                // Calculates stationary emission
                StationaryResponse result = apiInstance.stationaryEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.stationaryEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // StationaryPayload | Payload for stationary emission

try {
    $result = $api_instance->stationaryEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->stationaryEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::StationaryPayload->new(); # StationaryPayload | Payload for stationary emission

eval { 
    my $result = $api_instance->stationaryEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->stationaryEmission: $@\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.CarbonAccountingEngineApi()
body =  # StationaryPayload | Payload for stationary emission

try: 
    # Calculates stationary emission
    api_response = api_instance.stationary_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->stationaryEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalid payload

Schema

Status: 400 - Failure, problem with input data

Schema

transportationDistributionEmission

Calculates transportation and distribution emission

/carbon/transportation_and_distribution

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"//carbon/transportation_and_distribution"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CarbonAccountingEngineApi;

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

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        TransportationDistributionPayload body = ; // TransportationDistributionPayload | Payload for transportation and distribution emission
        try {
            TransportationDistributionResponse result = apiInstance.transportationDistributionEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#transportationDistributionEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CarbonAccountingEngineApi;

public class CarbonAccountingEngineApiExample {

    public static void main(String[] args) {
        CarbonAccountingEngineApi apiInstance = new CarbonAccountingEngineApi();
        TransportationDistributionPayload body = ; // TransportationDistributionPayload | Payload for transportation and distribution emission
        try {
            TransportationDistributionResponse result = apiInstance.transportationDistributionEmission(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CarbonAccountingEngineApi#transportationDistributionEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
TransportationDistributionPayload *body = ; // Payload for transportation and distribution emission

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

// Calculates transportation and distribution emission
[apiInstance transportationDistributionEmissionWith:body
              completionHandler: ^(TransportationDistributionResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CarbonAccountingEngineApi()
var body = ; // {{TransportationDistributionPayload}} Payload for transportation and distribution emission

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transportationDistributionEmission(body, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class transportationDistributionEmissionExample
    {
        public void main()
        {


            var apiInstance = new CarbonAccountingEngineApi();
            var body = new TransportationDistributionPayload(); // TransportationDistributionPayload | Payload for transportation and distribution emission

            try
            {
                // Calculates transportation and distribution emission
                TransportationDistributionResponse result = apiInstance.transportationDistributionEmission(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CarbonAccountingEngineApi.transportationDistributionEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCarbonAccountingEngineApi();
$body = ; // TransportationDistributionPayload | Payload for transportation and distribution emission

try {
    $result = $api_instance->transportationDistributionEmission($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarbonAccountingEngineApi->transportationDistributionEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CarbonAccountingEngineApi;


my $api_instance = WWW::SwaggerClient::CarbonAccountingEngineApi->new();
my $body = WWW::SwaggerClient::Object::TransportationDistributionPayload->new(); # TransportationDistributionPayload | Payload for transportation and distribution emission

eval { 
    my $result = $api_instance->transportationDistributionEmission(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CarbonAccountingEngineApi->transportationDistributionEmission: $@\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.CarbonAccountingEngineApi()
body =  # TransportationDistributionPayload | Payload for transportation and distribution emission

try: 
    # Calculates transportation and distribution emission
    api_response = api_instance.transportation_distribution_emission(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CarbonAccountingEngineApi->transportationDistributionEmission: %s\n" % e)

Parameters

Body parameters

Name	Description
body *

Responses

Status: 200 - success

Schema

Status: 422 - Failure, invalid payload

Schema

Status: 404 - Failure, item not found

Schema

Status: 400 - Failure, problem with input data

Schema

Config

getCropTypeConfig

(Deprecated) Return supported crop types

Return supported crop types. 'corn' for example

/field/config/croptypes

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/config/croptypes?locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getCropTypeConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getCropTypeConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getCropTypeConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getCropTypeConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *locale = locale_example; // Return the configuration values appropriate to a locale (optional)

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

// (Deprecated) Return supported crop types
[apiInstance getCropTypeConfigWith:locale
              completionHandler: ^(array[Pair] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ConfigApi()
var opts = { 
  'locale': locale_example // {{String}} Return the configuration values appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCropTypeConfig(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCropTypeConfigExample
    {
        public void main()
        {


            var apiInstance = new ConfigApi();
            var locale = locale_example;  // String | Return the configuration values appropriate to a locale (optional) 

            try
            {
                // (Deprecated) Return supported crop types
                array[Pair] result = apiInstance.getCropTypeConfig(locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getCropTypeConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConfigApi();
$locale = locale_example; // String | Return the configuration values appropriate to a locale

try {
    $result = $api_instance->getCropTypeConfig($locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getCropTypeConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;


my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $locale = locale_example; # String | Return the configuration values appropriate to a locale

eval { 
    my $result = $api_instance->getCropTypeConfig(locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getCropTypeConfig: $@\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.ConfigApi()
locale = locale_example # String | Return the configuration values appropriate to a locale (optional)

try: 
    # (Deprecated) Return supported crop types
    api_response = api_instance.get_crop_type_config(locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getCropTypeConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
locale	String Return the configuration values appropriate to a locale

Responses

Status: 200 - HTTP 200 Crop types configuration successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getCropsConfig

Return supported crop types

Return supported crop types. 'corn' for example

/field/config/crops

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/config/crops?locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            'String' result = apiInstance.getCropsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getCropsConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            'String' result = apiInstance.getCropsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getCropsConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *locale = locale_example; // Return the configuration values appropriate to a locale (optional)

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

// Return supported crop types
[apiInstance getCropsConfigWith:locale
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ConfigApi()
var opts = { 
  'locale': locale_example // {{String}} Return the configuration values appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCropsConfig(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getCropsConfigExample
    {
        public void main()
        {


            var apiInstance = new ConfigApi();
            var locale = locale_example;  // String | Return the configuration values appropriate to a locale (optional) 

            try
            {
                // Return supported crop types
                'String' result = apiInstance.getCropsConfig(locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getCropsConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConfigApi();
$locale = locale_example; // String | Return the configuration values appropriate to a locale

try {
    $result = $api_instance->getCropsConfig($locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getCropsConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;


my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $locale = locale_example; # String | Return the configuration values appropriate to a locale

eval { 
    my $result = $api_instance->getCropsConfig(locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getCropsConfig: $@\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.ConfigApi()
locale = locale_example # String | Return the configuration values appropriate to a locale (optional)

try: 
    # Return supported crop types
    api_response = api_instance.get_crops_config(locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getCropsConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
locale	String Return the configuration values appropriate to a locale

Responses

Status: 200 - HTTP 200 Crop types configuration successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getDiseaseConfig

Return supported diseases per crop type

/field/config/diseases

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/config/diseases?cropType=&locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConfigApi apiInstance = new ConfigApi();
        String cropType = cropType_example; // String | Crop type
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getDiseaseConfig(cropType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getDiseaseConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String cropType = cropType_example; // String | Crop type
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getDiseaseConfig(cropType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getDiseaseConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *cropType = cropType_example; // Crop type
String *locale = locale_example; // Return the configuration values appropriate to a locale (optional)

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

// Return supported diseases per crop type
[apiInstance getDiseaseConfigWith:cropType
    locale:locale
              completionHandler: ^(array[Pair] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ConfigApi()
var cropType = cropType_example; // {{String}} Crop type
var opts = { 
  'locale': locale_example // {{String}} Return the configuration values appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiseaseConfig(cropType, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDiseaseConfigExample
    {
        public void main()
        {


            var apiInstance = new ConfigApi();
            var cropType = cropType_example;  // String | Crop type
            var locale = locale_example;  // String | Return the configuration values appropriate to a locale (optional) 

            try
            {
                // Return supported diseases per crop type
                array[Pair] result = apiInstance.getDiseaseConfig(cropType, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getDiseaseConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConfigApi();
$cropType = cropType_example; // String | Crop type
$locale = locale_example; // String | Return the configuration values appropriate to a locale

try {
    $result = $api_instance->getDiseaseConfig($cropType, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getDiseaseConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;


my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $cropType = cropType_example; # String | Crop type
my $locale = locale_example; # String | Return the configuration values appropriate to a locale

eval { 
    my $result = $api_instance->getDiseaseConfig(cropType => $cropType, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getDiseaseConfig: $@\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.ConfigApi()
cropType = cropType_example # String | Crop type
locale = locale_example # String | Return the configuration values appropriate to a locale (optional)

try: 
    # Return supported diseases per crop type
    api_response = api_instance.get_disease_config(cropType, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getDiseaseConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
cropType*	String Crop type Required
locale	String Return the configuration values appropriate to a locale

Responses

Status: 200 - HTTP 200 Disease configuration successfully returned

Schema

Status: 400 - HTTP 400 Unable to return diseases. Crop type must be specified

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Unable to locate crop type in configuration

Schema

getEventsConfig

Return supported subfield events

Return supported subfield events. 'PLANTING', 'HARVESTING' for example

/field/config/events

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/config/events?locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getEventsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getEventsConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getEventsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getEventsConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *locale = locale_example; // Return the configuration values appropriate to a locale (optional)

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

// Return supported subfield events
[apiInstance getEventsConfigWith:locale
              completionHandler: ^(array[Pair] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ConfigApi()
var opts = { 
  'locale': locale_example // {{String}} Return the configuration values appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventsConfig(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventsConfigExample
    {
        public void main()
        {


            var apiInstance = new ConfigApi();
            var locale = locale_example;  // String | Return the configuration values appropriate to a locale (optional) 

            try
            {
                // Return supported subfield events
                array[Pair] result = apiInstance.getEventsConfig(locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getEventsConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConfigApi();
$locale = locale_example; // String | Return the configuration values appropriate to a locale

try {
    $result = $api_instance->getEventsConfig($locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getEventsConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;


my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $locale = locale_example; # String | Return the configuration values appropriate to a locale

eval { 
    my $result = $api_instance->getEventsConfig(locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getEventsConfig: $@\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.ConfigApi()
locale = locale_example # String | Return the configuration values appropriate to a locale (optional)

try: 
    # Return supported subfield events
    api_response = api_instance.get_events_config(locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getEventsConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
locale	String Return the configuration values appropriate to a locale

Responses

Status: 200 - HTTP 200 SubField Events configuration successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getProjectionsConfig

Return supported projections

Return supported projections. 'EPSG:4326', 'EPSG:3857' for example

/field/config/projections

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/config/projections?locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigApi;

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

public class ConfigApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getProjectionsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getProjectionsConfig");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ConfigApi;

public class ConfigApiExample {

    public static void main(String[] args) {
        ConfigApi apiInstance = new ConfigApi();
        String locale = locale_example; // String | Return the configuration values appropriate to a locale
        try {
            array[Pair] result = apiInstance.getProjectionsConfig(locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigApi#getProjectionsConfig");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *locale = locale_example; // Return the configuration values appropriate to a locale (optional)

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

// Return supported projections
[apiInstance getProjectionsConfigWith:locale
              completionHandler: ^(array[Pair] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ConfigApi()
var opts = { 
  'locale': locale_example // {{String}} Return the configuration values appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProjectionsConfig(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getProjectionsConfigExample
    {
        public void main()
        {


            var apiInstance = new ConfigApi();
            var locale = locale_example;  // String | Return the configuration values appropriate to a locale (optional) 

            try
            {
                // Return supported projections
                array[Pair] result = apiInstance.getProjectionsConfig(locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigApi.getProjectionsConfig: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiConfigApi();
$locale = locale_example; // String | Return the configuration values appropriate to a locale

try {
    $result = $api_instance->getProjectionsConfig($locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->getProjectionsConfig: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigApi;


my $api_instance = WWW::SwaggerClient::ConfigApi->new();
my $locale = locale_example; # String | Return the configuration values appropriate to a locale

eval { 
    my $result = $api_instance->getProjectionsConfig(locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigApi->getProjectionsConfig: $@\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.ConfigApi()
locale = locale_example # String | Return the configuration values appropriate to a locale (optional)

try: 
    # Return supported projections
    api_response = api_instance.get_projections_config(locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigApi->getProjectionsConfig: %s\n" % e)

Parameters

Query parameters

Name	Description
locale	String Return the configuration values appropriate to a locale

Responses

Status: 200 - HTTP 200 Projection configuration successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

CustomLayers

deleteRegisteredLayer

Delete a registered layer from the registered analytics table

/layer/{analyticsuuid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//layer/{analyticsuuid}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomLayersApi;

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

public class CustomLayersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        try {
            GetRegisteredLayerResponse result = apiInstance.deleteRegisteredLayer(analyticsuuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#deleteRegisteredLayer");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CustomLayersApi;

public class CustomLayersApiExample {

    public static void main(String[] args) {
        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        try {
            GetRegisteredLayerResponse result = apiInstance.deleteRegisteredLayer(analyticsuuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#deleteRegisteredLayer");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Analytics UUID

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

// Delete a registered layer from the registered analytics table
[apiInstance deleteRegisteredLayerWith:analyticsuuid
              completionHandler: ^(GetRegisteredLayerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CustomLayersApi()
var analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Analytics UUID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRegisteredLayer(analyticsuuid, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteRegisteredLayerExample
    {
        public void main()
        {


            var apiInstance = new CustomLayersApi();
            var analyticsuuid = new UUID(); // UUID | Unique Analytics UUID

            try
            {
                // Delete a registered layer from the registered analytics table
                GetRegisteredLayerResponse result = apiInstance.deleteRegisteredLayer(analyticsuuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomLayersApi.deleteRegisteredLayer: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCustomLayersApi();
$analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID

try {
    $result = $api_instance->deleteRegisteredLayer($analyticsuuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomLayersApi->deleteRegisteredLayer: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomLayersApi;


my $api_instance = WWW::SwaggerClient::CustomLayersApi->new();
my $analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Analytics UUID

eval { 
    my $result = $api_instance->deleteRegisteredLayer(analyticsuuid => $analyticsuuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomLayersApi->deleteRegisteredLayer: $@\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.CustomLayersApi()
analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Analytics UUID

try: 
    # Delete a registered layer from the registered analytics table
    api_response = api_instance.delete_registered_layer(analyticsuuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomLayersApi->deleteRegisteredLayer: %s\n" % e)

Parameters

Path parameters

Name	Description
analyticsuuid*	UUID (uuid) Unique Analytics UUID Required

Responses

Status: 200 - HTTP 200 requested layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getAllRegisteredLayersData

Get PNG or GeoTiff of an analytics layer provided by PAIRS geoserver

Retrieve an Analytics Layer GeoTiff/PNG Image As A Binary Stream/ metadata with URL

/layer/{analyticsuuid}/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//layer/{analyticsuuid}/data?date=&queryMethod=&metadataOnly=&bbox=&height=&width=&crs="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomLayersApi;

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

public class CustomLayersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
        String queryMethod = queryMethod_example; // String | Choose from WMS or WCS
        Boolean metadataOnly = true; // Boolean | If metadata is only needed set to true
        String bbox = bbox_example; // String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
        Integer height = 56; // Integer | (For WMS only) The height of the PNG image
        Integer width = 56; // Integer | (For WMS only) The width of the PNG image
        String crs = crs_example; // String | Choose from 4326 or 3857
        try {
            GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersData(analyticsuuid, xProfileId, date, queryMethod, metadataOnly, bbox, height, width, crs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getAllRegisteredLayersData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CustomLayersApi;

public class CustomLayersApiExample {

    public static void main(String[] args) {
        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
        String queryMethod = queryMethod_example; // String | Choose from WMS or WCS
        Boolean metadataOnly = true; // Boolean | If metadata is only needed set to true
        String bbox = bbox_example; // String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
        Integer height = 56; // Integer | (For WMS only) The height of the PNG image
        Integer width = 56; // Integer | (For WMS only) The width of the PNG image
        String crs = crs_example; // String | Choose from 4326 or 3857
        try {
            GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersData(analyticsuuid, xProfileId, date, queryMethod, metadataOnly, bbox, height, width, crs);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getAllRegisteredLayersData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Analytics UUID
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *date = date_example; // Query Timestamp yyyy-MM-dd hh:mm:ss.SSS (optional)
String *queryMethod = queryMethod_example; // Choose from WMS or WCS (optional) (default to WCS)
Boolean *metadataOnly = true; // If metadata is only needed set to true (optional) (default to false)
String *bbox = bbox_example; // (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information (optional)
Integer *height = 56; // (For WMS only) The height of the PNG image (optional) (default to 256)
Integer *width = 56; // (For WMS only) The width of the PNG image (optional) (default to 256)
String *crs = crs_example; // Choose from 4326 or 3857 (optional) (default to 4326)

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

// Get PNG or GeoTiff of an analytics layer provided by PAIRS geoserver
[apiInstance getAllRegisteredLayersDataWith:analyticsuuid
    xProfileId:xProfileId
    date:date
    queryMethod:queryMethod
    metadataOnly:metadataOnly
    bbox:bbox
    height:height
    width:width
    crs:crs
              completionHandler: ^(GetRegisteredLayerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CustomLayersApi()
var analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Analytics UUID
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'date': date_example, // {{String}} Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
  'queryMethod': queryMethod_example, // {{String}} Choose from WMS or WCS
  'metadataOnly': true, // {{Boolean}} If metadata is only needed set to true
  'bbox': bbox_example, // {{String}} (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
  'height': 56, // {{Integer}} (For WMS only) The height of the PNG image
  'width': 56, // {{Integer}} (For WMS only) The width of the PNG image
  'crs': crs_example // {{String}} Choose from 4326 or 3857
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllRegisteredLayersData(analyticsuuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllRegisteredLayersDataExample
    {
        public void main()
        {


            var apiInstance = new CustomLayersApi();
            var analyticsuuid = new UUID(); // UUID | Unique Analytics UUID
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var date = date_example;  // String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS (optional) 
            var queryMethod = queryMethod_example;  // String | Choose from WMS or WCS (optional)  (default to WCS)
            var metadataOnly = true;  // Boolean | If metadata is only needed set to true (optional)  (default to false)
            var bbox = bbox_example;  // String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information (optional) 
            var height = 56;  // Integer | (For WMS only) The height of the PNG image (optional)  (default to 256)
            var width = 56;  // Integer | (For WMS only) The width of the PNG image (optional)  (default to 256)
            var crs = crs_example;  // String | Choose from 4326 or 3857 (optional)  (default to 4326)

            try
            {
                // Get PNG or GeoTiff of an analytics layer provided by PAIRS geoserver
                GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersData(analyticsuuid, xProfileId, date, queryMethod, metadataOnly, bbox, height, width, crs);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomLayersApi.getAllRegisteredLayersData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCustomLayersApi();
$analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
$xProfileId = xProfileId_example; // String | Profile Id
$date = date_example; // String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
$queryMethod = queryMethod_example; // String | Choose from WMS or WCS
$metadataOnly = true; // Boolean | If metadata is only needed set to true
$bbox = bbox_example; // String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
$height = 56; // Integer | (For WMS only) The height of the PNG image
$width = 56; // Integer | (For WMS only) The width of the PNG image
$crs = crs_example; // String | Choose from 4326 or 3857

try {
    $result = $api_instance->getAllRegisteredLayersData($analyticsuuid, $xProfileId, $date, $queryMethod, $metadataOnly, $bbox, $height, $width, $crs);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomLayersApi->getAllRegisteredLayersData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomLayersApi;


my $api_instance = WWW::SwaggerClient::CustomLayersApi->new();
my $analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Analytics UUID
my $xProfileId = xProfileId_example; # String | Profile Id
my $date = date_example; # String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
my $queryMethod = queryMethod_example; # String | Choose from WMS or WCS
my $metadataOnly = true; # Boolean | If metadata is only needed set to true
my $bbox = bbox_example; # String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
my $height = 56; # Integer | (For WMS only) The height of the PNG image
my $width = 56; # Integer | (For WMS only) The width of the PNG image
my $crs = crs_example; # String | Choose from 4326 or 3857

eval { 
    my $result = $api_instance->getAllRegisteredLayersData(analyticsuuid => $analyticsuuid, xProfileId => $xProfileId, date => $date, queryMethod => $queryMethod, metadataOnly => $metadataOnly, bbox => $bbox, height => $height, width => $width, crs => $crs);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomLayersApi->getAllRegisteredLayersData: $@\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.CustomLayersApi()
analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Analytics UUID
xProfileId = xProfileId_example # String | Profile Id (optional)
date = date_example # String | Query Timestamp yyyy-MM-dd hh:mm:ss.SSS (optional)
queryMethod = queryMethod_example # String | Choose from WMS or WCS (optional) (default to WCS)
metadataOnly = true # Boolean | If metadata is only needed set to true (optional) (default to false)
bbox = bbox_example # String | (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information (optional)
height = 56 # Integer | (For WMS only) The height of the PNG image (optional) (default to 256)
width = 56 # Integer | (For WMS only) The width of the PNG image (optional) (default to 256)
crs = crs_example # String | Choose from 4326 or 3857 (optional) (default to 4326)

try: 
    # Get PNG or GeoTiff of an analytics layer provided by PAIRS geoserver
    api_response = api_instance.get_all_registered_layers_data(analyticsuuid, xProfileId=xProfileId, date=date, queryMethod=queryMethod, metadataOnly=metadataOnly, bbox=bbox, height=height, width=width, crs=crs)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomLayersApi->getAllRegisteredLayersData: %s\n" % e)

Parameters

Path parameters

Name	Description
analyticsuuid*	UUID (uuid) Unique Analytics UUID Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
date	String Query Timestamp yyyy-MM-dd hh:mm:ss.SSS
queryMethod	String Choose from WMS or WCS
metadataOnly	Boolean If metadata is only needed set to true
bbox	String (For WMS Only) Boundingbox parameters in the format 'swLat,swLon,neLat,neLon'. If nothing is provided, boundingbox will be derived from PAIRS query information
height	Integer (int32) (For WMS only) The height of the PNG image
width	Integer (int32) (For WMS only) The width of the PNG image
crs	String Choose from 4326 or 3857

Responses

Status: 200 - HTTP 200 requested layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getAllRegisteredLayersInfo

Get a list of all registered custom layers by the user

Get the list of all custom layers registered by the user.

/layer

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//layer?UuidsOnly=&start=&limit="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomLayersApi;

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

public class CustomLayersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CustomLayersApi apiInstance = new CustomLayersApi();
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of analytic UUIDs
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        try {
            GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersInfo(uuidsOnly, start, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getAllRegisteredLayersInfo");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CustomLayersApi;

public class CustomLayersApiExample {

    public static void main(String[] args) {
        CustomLayersApi apiInstance = new CustomLayersApi();
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of analytic UUIDs
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        try {
            GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersInfo(uuidsOnly, start, limit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getAllRegisteredLayersInfo");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Boolean *uuidsOnly = true; // UUIDs Only - Return an array of analytic UUIDs (optional) (default to false)
Integer *start = 56; // Start pagination offset (optional) (default to 0)
Integer *limit = 56; // Results per page (optional) (default to 20)

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

// Get a list of all registered custom layers by the user
[apiInstance getAllRegisteredLayersInfoWith:uuidsOnly
    start:start
    limit:limit
              completionHandler: ^(GetRegisteredLayerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CustomLayersApi()
var opts = { 
  'uuidsOnly': true, // {{Boolean}} UUIDs Only - Return an array of analytic UUIDs
  'start': 56, // {{Integer}} Start pagination offset
  'limit': 56 // {{Integer}} Results per page
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllRegisteredLayersInfo(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllRegisteredLayersInfoExample
    {
        public void main()
        {


            var apiInstance = new CustomLayersApi();
            var uuidsOnly = true;  // Boolean | UUIDs Only - Return an array of analytic UUIDs (optional)  (default to false)
            var start = 56;  // Integer | Start pagination offset (optional)  (default to 0)
            var limit = 56;  // Integer | Results per page (optional)  (default to 20)

            try
            {
                // Get a list of all registered custom layers by the user
                GetRegisteredLayerResponse result = apiInstance.getAllRegisteredLayersInfo(uuidsOnly, start, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomLayersApi.getAllRegisteredLayersInfo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCustomLayersApi();
$uuidsOnly = true; // Boolean | UUIDs Only - Return an array of analytic UUIDs
$start = 56; // Integer | Start pagination offset
$limit = 56; // Integer | Results per page

try {
    $result = $api_instance->getAllRegisteredLayersInfo($uuidsOnly, $start, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomLayersApi->getAllRegisteredLayersInfo: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomLayersApi;


my $api_instance = WWW::SwaggerClient::CustomLayersApi->new();
my $uuidsOnly = true; # Boolean | UUIDs Only - Return an array of analytic UUIDs
my $start = 56; # Integer | Start pagination offset
my $limit = 56; # Integer | Results per page

eval { 
    my $result = $api_instance->getAllRegisteredLayersInfo(uuidsOnly => $uuidsOnly, start => $start, limit => $limit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomLayersApi->getAllRegisteredLayersInfo: $@\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.CustomLayersApi()
uuidsOnly = true # Boolean | UUIDs Only - Return an array of analytic UUIDs (optional) (default to false)
start = 56 # Integer | Start pagination offset (optional) (default to 0)
limit = 56 # Integer | Results per page (optional) (default to 20)

try: 
    # Get a list of all registered custom layers by the user
    api_response = api_instance.get_all_registered_layers_info(uuidsOnly=uuidsOnly, start=start, limit=limit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomLayersApi->getAllRegisteredLayersInfo: %s\n" % e)

Parameters

Query parameters

Name	Description
UuidsOnly	Boolean UUIDs Only - Return an array of analytic UUIDs
start	Integer (int32) Start pagination offset
limit	Integer (int32) Results per page

Responses

Status: 200 - HTTP 200 requested layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getRegisteredLayerInfo

Get a list of all registered custom layers by the user

Get the list of all custom layers registered by the user.

/layer/{analyticsuuid}/info

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//layer/{analyticsuuid}/info?fromDate=&toDate="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomLayersApi;

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

public class CustomLayersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            GetRegisteredLayerResponse result = apiInstance.getRegisteredLayerInfo(analyticsuuid, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getRegisteredLayerInfo");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CustomLayersApi;

public class CustomLayersApiExample {

    public static void main(String[] args) {
        CustomLayersApi apiInstance = new CustomLayersApi();
        UUID analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            GetRegisteredLayerResponse result = apiInstance.getRegisteredLayerInfo(analyticsuuid, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#getRegisteredLayerInfo");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Analytics UUID
String *fromDate = fromDate_example; // Query fromDate yyyy-MM-dd (optional)
String *toDate = toDate_example; // Query toDate yyyy-MM-dd (optional)

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

// Get a list of all registered custom layers by the user
[apiInstance getRegisteredLayerInfoWith:analyticsuuid
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(GetRegisteredLayerResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CustomLayersApi()
var analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Analytics UUID
var opts = { 
  'fromDate': fromDate_example, // {{String}} Query fromDate yyyy-MM-dd
  'toDate': toDate_example // {{String}} Query toDate yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegisteredLayerInfo(analyticsuuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegisteredLayerInfoExample
    {
        public void main()
        {


            var apiInstance = new CustomLayersApi();
            var analyticsuuid = new UUID(); // UUID | Unique Analytics UUID
            var fromDate = fromDate_example;  // String | Query fromDate yyyy-MM-dd (optional) 
            var toDate = toDate_example;  // String | Query toDate yyyy-MM-dd (optional) 

            try
            {
                // Get a list of all registered custom layers by the user
                GetRegisteredLayerResponse result = apiInstance.getRegisteredLayerInfo(analyticsuuid, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomLayersApi.getRegisteredLayerInfo: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCustomLayersApi();
$analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Analytics UUID
$fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
$toDate = toDate_example; // String | Query toDate yyyy-MM-dd

try {
    $result = $api_instance->getRegisteredLayerInfo($analyticsuuid, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomLayersApi->getRegisteredLayerInfo: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomLayersApi;


my $api_instance = WWW::SwaggerClient::CustomLayersApi->new();
my $analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Analytics UUID
my $fromDate = fromDate_example; # String | Query fromDate yyyy-MM-dd
my $toDate = toDate_example; # String | Query toDate yyyy-MM-dd

eval { 
    my $result = $api_instance->getRegisteredLayerInfo(analyticsuuid => $analyticsuuid, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomLayersApi->getRegisteredLayerInfo: $@\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.CustomLayersApi()
analyticsuuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Analytics UUID
fromDate = fromDate_example # String | Query fromDate yyyy-MM-dd (optional)
toDate = toDate_example # String | Query toDate yyyy-MM-dd (optional)

try: 
    # Get a list of all registered custom layers by the user
    api_response = api_instance.get_registered_layer_info(analyticsuuid, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomLayersApi->getRegisteredLayerInfo: %s\n" % e)

Parameters

Path parameters

Name	Description
analyticsuuid*	UUID (uuid) Unique Analytics UUID Required

Query parameters

Name	Description
fromDate	String Query fromDate yyyy-MM-dd
toDate	String Query toDate yyyy-MM-dd

Responses

Status: 200 - HTTP 200 requested layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

registerAnalytic

POST a PAIRS job payload to `registered_layers` table. Returns an unique analyticsUUID for each layer ID in PAIRS payload

/layer/analytics/metadata

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//layer/analytics/metadata"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CustomLayersApi;

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

public class CustomLayersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        CustomLayersApi apiInstance = new CustomLayersApi();
        AnalyticsRegistrationPayload body = ; // AnalyticsRegistrationPayload | Analytics Registration payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[PostRegisterLayerResponse] result = apiInstance.registerAnalytic(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#registerAnalytic");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.CustomLayersApi;

public class CustomLayersApiExample {

    public static void main(String[] args) {
        CustomLayersApi apiInstance = new CustomLayersApi();
        AnalyticsRegistrationPayload body = ; // AnalyticsRegistrationPayload | Analytics Registration payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            array[PostRegisterLayerResponse] result = apiInstance.registerAnalytic(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CustomLayersApi#registerAnalytic");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
AnalyticsRegistrationPayload *body = ; // Analytics Registration payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Register a PAIRS job payload as layers for WOC UI
[apiInstance registerAnalyticWith:body
    xProfileId:xProfileId
              completionHandler: ^(array[PostRegisterLayerResponse] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.CustomLayersApi()
var body = ; // {{AnalyticsRegistrationPayload}} Analytics Registration payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.registerAnalytic(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class registerAnalyticExample
    {
        public void main()
        {


            var apiInstance = new CustomLayersApi();
            var body = new AnalyticsRegistrationPayload(); // AnalyticsRegistrationPayload | Analytics Registration payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Register a PAIRS job payload as layers for WOC UI
                array[PostRegisterLayerResponse] result = apiInstance.registerAnalytic(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CustomLayersApi.registerAnalytic: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiCustomLayersApi();
$body = ; // AnalyticsRegistrationPayload | Analytics Registration payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->registerAnalytic($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomLayersApi->registerAnalytic: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CustomLayersApi;


my $api_instance = WWW::SwaggerClient::CustomLayersApi->new();
my $body = WWW::SwaggerClient::Object::AnalyticsRegistrationPayload->new(); # AnalyticsRegistrationPayload | Analytics Registration payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->registerAnalytic(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CustomLayersApi->registerAnalytic: $@\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.CustomLayersApi()
body =  # AnalyticsRegistrationPayload | Analytics Registration payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Register a PAIRS job payload as layers for WOC UI
    api_response = api_instance.register_analytic(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CustomLayersApi->registerAnalytic: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - HTTP 200 Analytics successfully registered

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Data

getLayerDataBySubField

Get SubField Layer GeoTiff Image

Retrieve a SubField Layer GeoTiff Image As A Binary Stream

/field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/octet-stream,application/json"\
"//field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/data?model=&projection=&format=&disease=&predictionOffset=&temperature=&date=&fromDate=&toDate="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

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

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        DataApi apiInstance = new DataApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String model = model_example; // String | Image Layer Model Algorithm
        String projection = projection_example; // String | Image Projection
        String format = format_example; // String | Layer Output Format
        String disease = disease_example; // String | DISEASE only parameter - Disease Type
        String predictionOffset = predictionOffset_example; // String | DISEASE only parameter - Disease prediction offset (in days)
        Boolean temperature = true; // Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            LayerDataResponse result = apiInstance.getLayerDataBySubField(fielduuid, subfielduuid, layer, xProfileId, model, projection, format, disease, predictionOffset, temperature, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getLayerDataBySubField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String model = model_example; // String | Image Layer Model Algorithm
        String projection = projection_example; // String | Image Projection
        String format = format_example; // String | Layer Output Format
        String disease = disease_example; // String | DISEASE only parameter - Disease Type
        String predictionOffset = predictionOffset_example; // String | DISEASE only parameter - Disease prediction offset (in days)
        Boolean temperature = true; // Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            LayerDataResponse result = apiInstance.getLayerDataBySubField(fielduuid, subfielduuid, layer, xProfileId, model, projection, format, disease, predictionOffset, temperature, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getLayerDataBySubField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field UUID
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *layer = layer_example; // Image Layer type
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *model = model_example; // Image Layer Model Algorithm (optional)
String *projection = projection_example; // Image Projection (optional) (default to 4326)
String *format = format_example; // Layer Output Format (optional)
String *disease = disease_example; // DISEASE only parameter - Disease Type (optional)
String *predictionOffset = predictionOffset_example; // DISEASE only parameter - Disease prediction offset (in days) (optional)
Boolean *temperature = true; // HDSM only parameter - true for HDSM temperature / false for HDSM moisture (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)
String *fromDate = fromDate_example; // Query fromDate yyyy-MM-dd (optional)
String *toDate = toDate_example; // Query toDate yyyy-MM-dd (optional)

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

// Get SubField Layer GeoTiff Image
[apiInstance getLayerDataBySubFieldWith:fielduuid
    subfielduuid:subfielduuid
    layer:layer
    xProfileId:xProfileId
    model:model
    projection:projection
    format:format
    disease:disease
    predictionOffset:predictionOffset
    temperature:temperature
    date:date
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(LayerDataResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.DataApi()
var fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field UUID
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var layer = layer_example; // {{String}} Image Layer type
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'model': model_example, // {{String}} Image Layer Model Algorithm
  'projection': projection_example, // {{String}} Image Projection
  'format': format_example, // {{String}} Layer Output Format
  'disease': disease_example, // {{String}} DISEASE only parameter - Disease Type
  'predictionOffset': predictionOffset_example, // {{String}} DISEASE only parameter - Disease prediction offset (in days)
  'temperature': true, // {{Boolean}} HDSM only parameter - true for HDSM temperature / false for HDSM moisture
  'date': date_example, // {{String}} Query Date yyyy-MM-dd
  'fromDate': fromDate_example, // {{String}} Query fromDate yyyy-MM-dd
  'toDate': toDate_example // {{String}} Query toDate yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLayerDataBySubField(fielduuid, subfielduuid, layer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLayerDataBySubFieldExample
    {
        public void main()
        {


            var apiInstance = new DataApi();
            var fielduuid = new UUID(); // UUID | Unique Field UUID
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var layer = layer_example;  // String | Image Layer type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var model = model_example;  // String | Image Layer Model Algorithm (optional) 
            var projection = projection_example;  // String | Image Projection (optional)  (default to 4326)
            var format = format_example;  // String | Layer Output Format (optional) 
            var disease = disease_example;  // String | DISEASE only parameter - Disease Type (optional) 
            var predictionOffset = predictionOffset_example;  // String | DISEASE only parameter - Disease prediction offset (in days) (optional) 
            var temperature = true;  // Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 
            var fromDate = fromDate_example;  // String | Query fromDate yyyy-MM-dd (optional) 
            var toDate = toDate_example;  // String | Query toDate yyyy-MM-dd (optional) 

            try
            {
                // Get SubField Layer GeoTiff Image
                LayerDataResponse result = apiInstance.getLayerDataBySubField(fielduuid, subfielduuid, layer, xProfileId, model, projection, format, disease, predictionOffset, temperature, date, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getLayerDataBySubField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiDataApi();
$fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$layer = layer_example; // String | Image Layer type
$xProfileId = xProfileId_example; // String | Profile Id
$model = model_example; // String | Image Layer Model Algorithm
$projection = projection_example; // String | Image Projection
$format = format_example; // String | Layer Output Format
$disease = disease_example; // String | DISEASE only parameter - Disease Type
$predictionOffset = predictionOffset_example; // String | DISEASE only parameter - Disease prediction offset (in days)
$temperature = true; // Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture
$date = date_example; // String | Query Date yyyy-MM-dd
$fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
$toDate = toDate_example; // String | Query toDate yyyy-MM-dd

try {
    $result = $api_instance->getLayerDataBySubField($fielduuid, $subfielduuid, $layer, $xProfileId, $model, $projection, $format, $disease, $predictionOffset, $temperature, $date, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getLayerDataBySubField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;


my $api_instance = WWW::SwaggerClient::DataApi->new();
my $fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field UUID
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $layer = layer_example; # String | Image Layer type
my $xProfileId = xProfileId_example; # String | Profile Id
my $model = model_example; # String | Image Layer Model Algorithm
my $projection = projection_example; # String | Image Projection
my $format = format_example; # String | Layer Output Format
my $disease = disease_example; # String | DISEASE only parameter - Disease Type
my $predictionOffset = predictionOffset_example; # String | DISEASE only parameter - Disease prediction offset (in days)
my $temperature = true; # Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture
my $date = date_example; # String | Query Date yyyy-MM-dd
my $fromDate = fromDate_example; # String | Query fromDate yyyy-MM-dd
my $toDate = toDate_example; # String | Query toDate yyyy-MM-dd

eval { 
    my $result = $api_instance->getLayerDataBySubField(fielduuid => $fielduuid, subfielduuid => $subfielduuid, layer => $layer, xProfileId => $xProfileId, model => $model, projection => $projection, format => $format, disease => $disease, predictionOffset => $predictionOffset, temperature => $temperature, date => $date, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getLayerDataBySubField: $@\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.DataApi()
fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field UUID
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
layer = layer_example # String | Image Layer type
xProfileId = xProfileId_example # String | Profile Id (optional)
model = model_example # String | Image Layer Model Algorithm (optional)
projection = projection_example # String | Image Projection (optional) (default to 4326)
format = format_example # String | Layer Output Format (optional)
disease = disease_example # String | DISEASE only parameter - Disease Type (optional)
predictionOffset = predictionOffset_example # String | DISEASE only parameter - Disease prediction offset (in days) (optional)
temperature = true # Boolean | HDSM only parameter - true for HDSM temperature / false for HDSM moisture (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)
fromDate = fromDate_example # String | Query fromDate yyyy-MM-dd (optional)
toDate = toDate_example # String | Query toDate yyyy-MM-dd (optional)

try: 
    # Get SubField Layer GeoTiff Image
    api_response = api_instance.get_layer_data_by_sub_field(fielduuid, subfielduuid, layer, xProfileId=xProfileId, model=model, projection=projection, format=format, disease=disease, predictionOffset=predictionOffset, temperature=temperature, date=date, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DataApi->getLayerDataBySubField: %s\n" % e)

Parameters

Path parameters

Name	Description
fielduuid*	UUID (uuid) Unique Field UUID Required
subfielduuid*	UUID (uuid) Unique SubField UUID Required
layer*	String Image Layer type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
model	String Image Layer Model Algorithm
projection	String Image Projection
format	String Layer Output Format
disease	String DISEASE only parameter - Disease Type
predictionOffset	String DISEASE only parameter - Disease prediction offset (in days)
temperature	Boolean HDSM only parameter - true for HDSM temperature / false for HDSM moisture
date	String Query Date yyyy-MM-dd
fromDate	String Query fromDate yyyy-MM-dd
toDate	String Query toDate yyyy-MM-dd

Responses

Status: 200 - HTTP 200 SubField layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Data layer not found in object storage

Schema

Status: 503 - HTTP 503 Unable to communicate with Field Profile Service

Schema

Events

createSubFieldEventExternal

Create a SubField event

Create an event for the SubField with the SubField id used

/field/{fieldUuid}/subfield/{subFieldUuid}/event

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//field/{fieldUuid}/subfield/{subFieldUuid}/event"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        EventPayload body = ; // EventPayload | event payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventResponse result = apiInstance.createSubFieldEventExternal(fieldUuid, subFieldUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#createSubFieldEventExternal");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        EventPayload body = ; // EventPayload | event payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventResponse result = apiInstance.createSubFieldEventExternal(fieldUuid, subFieldUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#createSubFieldEventExternal");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field Uuid
UUID *subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField Uuid
EventPayload *body = ; // event payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create a SubField event
[apiInstance createSubFieldEventExternalWith:fieldUuid
    subFieldUuid:subFieldUuid
    body:body
    xProfileId:xProfileId
              completionHandler: ^(EventResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.EventsApi()
var fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field Uuid
var subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField Uuid
var opts = { 
  'body':  // {{EventPayload}} event payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSubFieldEventExternal(fieldUuidsubFieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSubFieldEventExternalExample
    {
        public void main()
        {


            var apiInstance = new EventsApi();
            var fieldUuid = new UUID(); // UUID | Unique Field Uuid
            var subFieldUuid = new UUID(); // UUID | Unique SubField Uuid
            var body = new EventPayload(); // EventPayload | event payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create a SubField event
                EventResponse result = apiInstance.createSubFieldEventExternal(fieldUuid, subFieldUuid, body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.createSubFieldEventExternal: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventsApi();
$fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
$subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
$body = ; // EventPayload | event payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createSubFieldEventExternal($fieldUuid, $subFieldUuid, $body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->createSubFieldEventExternal: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;


my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field Uuid
my $subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField Uuid
my $body = WWW::SwaggerClient::Object::EventPayload->new(); # EventPayload | event payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createSubFieldEventExternal(fieldUuid => $fieldUuid, subFieldUuid => $subFieldUuid, body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->createSubFieldEventExternal: $@\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.EventsApi()
fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field Uuid
subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField Uuid
body =  # EventPayload | event payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create a SubField event
    api_response = api_instance.create_sub_field_event_external(fieldUuid, subFieldUuid, body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->createSubFieldEventExternal: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUID (uuid) Unique Field Uuid Required
subFieldUuid*	UUID (uuid) Unique SubField Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - HTTP 200 SubField Event Created Successfully

Schema

Status: 400 - HTTP 400 Unsupported Event Type Supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField Not Found

Schema

getAllEventsBySubFieldIdExternal

Returns a list of events for given subField

Returns a list of events for a SubField with the SubField id used

/field/{fieldUuid}/subfield/{subFieldUuid}/event

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldUuid}/subfield/{subFieldUuid}/event?date=&fromDate=&toDate="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            EventListResponse result = apiInstance.getAllEventsBySubFieldIdExternal(fieldUuid, subFieldUuid, xProfileId, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getAllEventsBySubFieldIdExternal");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            EventListResponse result = apiInstance.getAllEventsBySubFieldIdExternal(fieldUuid, subFieldUuid, xProfileId, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getAllEventsBySubFieldIdExternal");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field Uuid
UUID *subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)
String *fromDate = fromDate_example; // Query fromDate yyyy-MM-dd (optional)
String *toDate = toDate_example; // Query toDate yyyy-MM-dd (optional)

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

// Returns a list of events for given subField
[apiInstance getAllEventsBySubFieldIdExternalWith:fieldUuid
    subFieldUuid:subFieldUuid
    xProfileId:xProfileId
    date:date
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(EventListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.EventsApi()
var fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field Uuid
var subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField Uuid
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'date': date_example, // {{String}} Query Date yyyy-MM-dd
  'fromDate': fromDate_example, // {{String}} Query fromDate yyyy-MM-dd
  'toDate': toDate_example // {{String}} Query toDate yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllEventsBySubFieldIdExternal(fieldUuid, subFieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllEventsBySubFieldIdExternalExample
    {
        public void main()
        {


            var apiInstance = new EventsApi();
            var fieldUuid = new UUID(); // UUID | Unique Field Uuid
            var subFieldUuid = new UUID(); // UUID | Unique SubField Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 
            var fromDate = fromDate_example;  // String | Query fromDate yyyy-MM-dd (optional) 
            var toDate = toDate_example;  // String | Query toDate yyyy-MM-dd (optional) 

            try
            {
                // Returns a list of events for given subField
                EventListResponse result = apiInstance.getAllEventsBySubFieldIdExternal(fieldUuid, subFieldUuid, xProfileId, date, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getAllEventsBySubFieldIdExternal: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventsApi();
$fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
$subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
$xProfileId = xProfileId_example; // String | Profile Id
$date = date_example; // String | Query Date yyyy-MM-dd
$fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
$toDate = toDate_example; // String | Query toDate yyyy-MM-dd

try {
    $result = $api_instance->getAllEventsBySubFieldIdExternal($fieldUuid, $subFieldUuid, $xProfileId, $date, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getAllEventsBySubFieldIdExternal: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;


my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field Uuid
my $subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField Uuid
my $xProfileId = xProfileId_example; # String | Profile Id
my $date = date_example; # String | Query Date yyyy-MM-dd
my $fromDate = fromDate_example; # String | Query fromDate yyyy-MM-dd
my $toDate = toDate_example; # String | Query toDate yyyy-MM-dd

eval { 
    my $result = $api_instance->getAllEventsBySubFieldIdExternal(fieldUuid => $fieldUuid, subFieldUuid => $subFieldUuid, xProfileId => $xProfileId, date => $date, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getAllEventsBySubFieldIdExternal: $@\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.EventsApi()
fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field Uuid
subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)
fromDate = fromDate_example # String | Query fromDate yyyy-MM-dd (optional)
toDate = toDate_example # String | Query toDate yyyy-MM-dd (optional)

try: 
    # Returns a list of events for given subField
    api_response = api_instance.get_all_events_by_sub_field_id_external(fieldUuid, subFieldUuid, xProfileId=xProfileId, date=date, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getAllEventsBySubFieldIdExternal: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUID (uuid) Unique Field Uuid Required
subFieldUuid*	UUID (uuid) Unique SubField Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
date	String Query Date yyyy-MM-dd
fromDate	String Query fromDate yyyy-MM-dd
toDate	String Query toDate yyyy-MM-dd

Responses

Status: 200 - HTTP 200 SubField successfully found

Schema

Status: 400 - HTTP 400 Invalid date supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getEventByUuid

Returns an event for given event UUID

Returns an event for a SubField with the event uuid used

/field/{fieldUuid}/subfield/{subFieldUuid}/event/{eventUuid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldUuid}/subfield/{subFieldUuid}/event/{eventUuid}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EventsApi apiInstance = new EventsApi();
        UUIDParam fieldUuid = ; // UUIDParam | Unique Field Uuid
        UUIDParam subFieldUuid = ; // UUIDParam | Unique SubField Uuid
        UUIDParam eventUuid = ; // UUIDParam | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventListResponse result = apiInstance.getEventByUuid(fieldUuid, subFieldUuid, eventUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventByUuid");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        UUIDParam fieldUuid = ; // UUIDParam | Unique Field Uuid
        UUIDParam subFieldUuid = ; // UUIDParam | Unique SubField Uuid
        UUIDParam eventUuid = ; // UUIDParam | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventListResponse result = apiInstance.getEventByUuid(fieldUuid, subFieldUuid, eventUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#getEventByUuid");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUIDParam *fieldUuid = ; // Unique Field Uuid
UUIDParam *subFieldUuid = ; // Unique SubField Uuid
UUIDParam *eventUuid = ; // Unique SubField Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Returns an event for given event UUID
[apiInstance getEventByUuidWith:fieldUuid
    subFieldUuid:subFieldUuid
    eventUuid:eventUuid
    xProfileId:xProfileId
              completionHandler: ^(EventListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.EventsApi()
var fieldUuid = ; // {{UUIDParam}} Unique Field Uuid
var subFieldUuid = ; // {{UUIDParam}} Unique SubField Uuid
var eventUuid = ; // {{UUIDParam}} Unique SubField Uuid
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEventByUuid(fieldUuid, subFieldUuid, eventUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getEventByUuidExample
    {
        public void main()
        {


            var apiInstance = new EventsApi();
            var fieldUuid = new UUIDParam(); // UUIDParam | Unique Field Uuid
            var subFieldUuid = new UUIDParam(); // UUIDParam | Unique SubField Uuid
            var eventUuid = new UUIDParam(); // UUIDParam | Unique SubField Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Returns an event for given event UUID
                EventListResponse result = apiInstance.getEventByUuid(fieldUuid, subFieldUuid, eventUuid, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.getEventByUuid: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventsApi();
$fieldUuid = ; // UUIDParam | Unique Field Uuid
$subFieldUuid = ; // UUIDParam | Unique SubField Uuid
$eventUuid = ; // UUIDParam | Unique SubField Uuid
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getEventByUuid($fieldUuid, $subFieldUuid, $eventUuid, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->getEventByUuid: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;


my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $fieldUuid = ; # UUIDParam | Unique Field Uuid
my $subFieldUuid = ; # UUIDParam | Unique SubField Uuid
my $eventUuid = ; # UUIDParam | Unique SubField Uuid
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getEventByUuid(fieldUuid => $fieldUuid, subFieldUuid => $subFieldUuid, eventUuid => $eventUuid, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->getEventByUuid: $@\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.EventsApi()
fieldUuid =  # UUIDParam | Unique Field Uuid
subFieldUuid =  # UUIDParam | Unique SubField Uuid
eventUuid =  # UUIDParam | Unique SubField Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Returns an event for given event UUID
    api_response = api_instance.get_event_by_uuid(fieldUuid, subFieldUuid, eventUuid, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->getEventByUuid: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUIDParam Unique Field Uuid Required
subFieldUuid*	UUIDParam Unique SubField Uuid Required
eventUuid*	UUIDParam Unique SubField Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 Events For SubField Returned Successfully

Schema

Status: 400 - HTTP 400 Invalid date supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

searchEventEndpointAdmin

Returns a list of events for all subFields

/subfield/event/search

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield/event/search"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EventsApi apiInstance = new EventsApi();
        EventSearchPayload body = ; // EventSearchPayload | event search payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventSearchUuidsResponse result = apiInstance.searchEventEndpointAdmin(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#searchEventEndpointAdmin");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        EventSearchPayload body = ; // EventSearchPayload | event search payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventSearchUuidsResponse result = apiInstance.searchEventEndpointAdmin(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#searchEventEndpointAdmin");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
EventSearchPayload *body = ; // event search payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Returns a list of events for all subFields
[apiInstance searchEventEndpointAdminWith:body
    xProfileId:xProfileId
              completionHandler: ^(EventSearchUuidsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.EventsApi()
var opts = { 
  'body':  // {{EventSearchPayload}} event search payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchEventEndpointAdmin(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchEventEndpointAdminExample
    {
        public void main()
        {


            var apiInstance = new EventsApi();
            var body = new EventSearchPayload(); // EventSearchPayload | event search payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Returns a list of events for all subFields
                EventSearchUuidsResponse result = apiInstance.searchEventEndpointAdmin(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.searchEventEndpointAdmin: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventsApi();
$body = ; // EventSearchPayload | event search payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->searchEventEndpointAdmin($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->searchEventEndpointAdmin: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;


my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $body = WWW::SwaggerClient::Object::EventSearchPayload->new(); # EventSearchPayload | event search payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->searchEventEndpointAdmin(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->searchEventEndpointAdmin: $@\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.EventsApi()
body =  # EventSearchPayload | event search payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Returns a list of events for all subFields
    api_response = api_instance.search_event_endpoint_admin(body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->searchEventEndpointAdmin: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - HTTP 200 Events Returned Successfully

Schema

Status: 400 - HTTP 400 Bad Search Body Supplied

Schema

searchEventEndpointUser

Returns a list of events for given subField

Returns a list of events for a SubField with the SubField id used

/field/{fieldUuid}/subfield/{subFieldUuid}/event/search

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//field/{fieldUuid}/subfield/{subFieldUuid}/event/search"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventsApi;

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

public class EventsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        EventSearchPayload body = ; // EventSearchPayload | event search payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventSearchUuidsResponse result = apiInstance.searchEventEndpointUser(fieldUuid, subFieldUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#searchEventEndpointUser");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.EventsApi;

public class EventsApiExample {

    public static void main(String[] args) {
        EventsApi apiInstance = new EventsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        EventSearchPayload body = ; // EventSearchPayload | event search payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            EventSearchUuidsResponse result = apiInstance.searchEventEndpointUser(fieldUuid, subFieldUuid, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventsApi#searchEventEndpointUser");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field Uuid
UUID *subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField Uuid
EventSearchPayload *body = ; // event search payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Returns a list of events for given subField
[apiInstance searchEventEndpointUserWith:fieldUuid
    subFieldUuid:subFieldUuid
    body:body
    xProfileId:xProfileId
              completionHandler: ^(EventSearchUuidsResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.EventsApi()
var fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field Uuid
var subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField Uuid
var opts = { 
  'body':  // {{EventSearchPayload}} event search payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchEventEndpointUser(fieldUuidsubFieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchEventEndpointUserExample
    {
        public void main()
        {


            var apiInstance = new EventsApi();
            var fieldUuid = new UUID(); // UUID | Unique Field Uuid
            var subFieldUuid = new UUID(); // UUID | Unique SubField Uuid
            var body = new EventSearchPayload(); // EventSearchPayload | event search payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Returns a list of events for given subField
                EventSearchUuidsResponse result = apiInstance.searchEventEndpointUser(fieldUuid, subFieldUuid, body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventsApi.searchEventEndpointUser: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiEventsApi();
$fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
$subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
$body = ; // EventSearchPayload | event search payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->searchEventEndpointUser($fieldUuid, $subFieldUuid, $body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EventsApi->searchEventEndpointUser: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::EventsApi;


my $api_instance = WWW::SwaggerClient::EventsApi->new();
my $fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field Uuid
my $subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField Uuid
my $body = WWW::SwaggerClient::Object::EventSearchPayload->new(); # EventSearchPayload | event search payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->searchEventEndpointUser(fieldUuid => $fieldUuid, subFieldUuid => $subFieldUuid, body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventsApi->searchEventEndpointUser: $@\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.EventsApi()
fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field Uuid
subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField Uuid
body =  # EventSearchPayload | event search payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Returns a list of events for given subField
    api_response = api_instance.search_event_endpoint_user(fieldUuid, subFieldUuid, body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EventsApi->searchEventEndpointUser: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUID (uuid) Unique Field Uuid Required
subFieldUuid*	UUID (uuid) Unique SubField Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - HTTP 200 Events Returned Successfully

Schema

Status: 400 - HTTP 400 Bad Search Body Supplied

Schema

Fields

createField

Create a Field and SubFields

Creates a Field and SubFields with associated JSON payload

/field

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//field?projection="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FieldsApi;

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

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FieldsApi apiInstance = new FieldsApi();
        RequestJson body = ; // RequestJson | Field create JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        try {
            UuidFieldResponse result = apiInstance.createField(body, xProfileId, projection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#createField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FieldsApi;

public class FieldsApiExample {

    public static void main(String[] args) {
        FieldsApi apiInstance = new FieldsApi();
        RequestJson body = ; // RequestJson | Field create JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        try {
            UuidFieldResponse result = apiInstance.createField(body, xProfileId, projection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#createField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
RequestJson *body = ; // Field create JSON payload
String *xProfileId = xProfileId_example; // Profile Id (optional)
Integer *projection = 56; // Image Projection (optional) (default to 4326)

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

// Create a Field and SubFields
[apiInstance createFieldWith:body
    xProfileId:xProfileId
    projection:projection
              completionHandler: ^(UuidFieldResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FieldsApi()
var body = ; // {{RequestJson}} Field create JSON payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'projection': 56 // {{Integer}} Image Projection
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createField(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createFieldExample
    {
        public void main()
        {


            var apiInstance = new FieldsApi();
            var body = new RequestJson(); // RequestJson | Field create JSON payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)

            try
            {
                // Create a Field and SubFields
                UuidFieldResponse result = apiInstance.createField(body, xProfileId, projection);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FieldsApi.createField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFieldsApi();
$body = ; // RequestJson | Field create JSON payload
$xProfileId = xProfileId_example; // String | Profile Id
$projection = 56; // Integer | Image Projection

try {
    $result = $api_instance->createField($body, $xProfileId, $projection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->createField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FieldsApi;


my $api_instance = WWW::SwaggerClient::FieldsApi->new();
my $body = WWW::SwaggerClient::Object::RequestJson->new(); # RequestJson | Field create JSON payload
my $xProfileId = xProfileId_example; # String | Profile Id
my $projection = 56; # Integer | Image Projection

eval { 
    my $result = $api_instance->createField(body => $body, xProfileId => $xProfileId, projection => $projection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FieldsApi->createField: $@\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.FieldsApi()
body =  # RequestJson | Field create JSON payload
xProfileId = xProfileId_example # String | Profile Id (optional)
projection = 56 # Integer | Image Projection (optional) (default to 4326)

try: 
    # Create a Field and SubFields
    api_response = api_instance.create_field(body, xProfileId=xProfileId, projection=projection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FieldsApi->createField: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
projection	Integer (int32) Image Projection

Responses

Status: 201 - HTTP 201 The field was successfully created for the provided JSON Payload

Schema

Status: 400 - HTTP 400 Bad User Input

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Field not found

Schema

deleteField

Delete a Field

Delete a Field and SubFields based on unique identifier

/field/{fieldId}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FieldsApi;

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

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteField(fieldId, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#deleteField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FieldsApi;

public class FieldsApiExample {

    public static void main(String[] args) {
        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteField(fieldId, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#deleteField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *fieldId = fieldId_example; // Unique field id
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Delete a Field
[apiInstance deleteFieldWith:fieldId
    xProfileId:xProfileId
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FieldsApi()
var fieldId = fieldId_example; // {{String}} Unique field id
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteField(fieldId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteFieldExample
    {
        public void main()
        {


            var apiInstance = new FieldsApi();
            var fieldId = fieldId_example;  // String | Unique field id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Delete a Field
                APIResponseMessage result = apiInstance.deleteField(fieldId, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FieldsApi.deleteField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFieldsApi();
$fieldId = fieldId_example; // String | Unique field id
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->deleteField($fieldId, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->deleteField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FieldsApi;


my $api_instance = WWW::SwaggerClient::FieldsApi->new();
my $fieldId = fieldId_example; # String | Unique field id
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->deleteField(fieldId => $fieldId, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FieldsApi->deleteField: $@\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.FieldsApi()
fieldId = fieldId_example # String | Unique field id
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Delete a Field
    api_response = api_instance.delete_field(fieldId, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FieldsApi->deleteField: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldId*	String Unique field id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 204 - HTTP 204 Field successfully deleted

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Field not found

Schema

getAllFields

Returns a list of Fields

Returns a list of Fields based on Field id's or Fields within a given radius

/field

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field?uuidsOnly=&lon=&lat=&radius=&start=&limit=&sort=&projection=&includeDetails=&inputType=&includeDeleted="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FieldsApi;

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

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FieldsApi apiInstance = new FieldsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of field UUID's
        Double lon = 1.2; // Double | Longitude
        Double lat = 1.2; // Double | Latitude
        Double radius = 1.2; // Double | Search radius (in metres)
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        Boolean includeDetails = true; // Boolean | Include SubField Details
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted fields
        try {
            FeatureCollection result = apiInstance.getAllFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, includeDetails, inputType, includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getAllFields");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FieldsApi;

public class FieldsApiExample {

    public static void main(String[] args) {
        FieldsApi apiInstance = new FieldsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of field UUID's
        Double lon = 1.2; // Double | Longitude
        Double lat = 1.2; // Double | Latitude
        Double radius = 1.2; // Double | Search radius (in metres)
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        Boolean includeDetails = true; // Boolean | Include SubField Details
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted fields
        try {
            FeatureCollection result = apiInstance.getAllFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, includeDetails, inputType, includeDeleted);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getAllFields");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *uuidsOnly = true; // UUIDs Only - Return an array of field UUID's (optional) (default to false)
Double *lon = 1.2; // Longitude (optional)
Double *lat = 1.2; // Latitude (optional)
Double *radius = 1.2; // Search radius (in metres) (optional) (default to 20000)
Integer *start = 56; // Start pagination offset (optional) (default to 0)
Integer *limit = 56; // Results per page (optional) (default to 10)
String *sort = sort_example; // Results sort order (optional) (default to id)
Integer *projection = 56; // Image Projection (optional) (default to 4326)
Boolean *includeDetails = true; // Include SubField Details (optional) (default to false)
String *inputType = inputType_example; // Input type (optional) (default to SPECIFIED_FIELD)
Boolean *includeDeleted = true; // Include deleted fields (optional) (default to false)

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

// Returns a list of Fields
[apiInstance getAllFieldsWith:xProfileId
    uuidsOnly:uuidsOnly
    lon:lon
    lat:lat
    radius:radius
    start:start
    limit:limit
    sort:sort
    projection:projection
    includeDetails:includeDetails
    inputType:inputType
    includeDeleted:includeDeleted
              completionHandler: ^(FeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FieldsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'uuidsOnly': true, // {{Boolean}} UUIDs Only - Return an array of field UUID's
  'lon': 1.2, // {{Double}} Longitude
  'lat': 1.2, // {{Double}} Latitude
  'radius': 1.2, // {{Double}} Search radius (in metres)
  'start': 56, // {{Integer}} Start pagination offset
  'limit': 56, // {{Integer}} Results per page
  'sort': sort_example, // {{String}} Results sort order
  'projection': 56, // {{Integer}} Image Projection
  'includeDetails': true, // {{Boolean}} Include SubField Details
  'inputType': inputType_example, // {{String}} Input type
  'includeDeleted': true // {{Boolean}} Include deleted fields
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllFields(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllFieldsExample
    {
        public void main()
        {


            var apiInstance = new FieldsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var uuidsOnly = true;  // Boolean | UUIDs Only - Return an array of field UUID's (optional)  (default to false)
            var lon = 1.2;  // Double | Longitude (optional) 
            var lat = 1.2;  // Double | Latitude (optional) 
            var radius = 1.2;  // Double | Search radius (in metres) (optional)  (default to 20000)
            var start = 56;  // Integer | Start pagination offset (optional)  (default to 0)
            var limit = 56;  // Integer | Results per page (optional)  (default to 10)
            var sort = sort_example;  // String | Results sort order (optional)  (default to id)
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)
            var includeDetails = true;  // Boolean | Include SubField Details (optional)  (default to false)
            var inputType = inputType_example;  // String | Input type (optional)  (default to SPECIFIED_FIELD)
            var includeDeleted = true;  // Boolean | Include deleted fields (optional)  (default to false)

            try
            {
                // Returns a list of Fields
                FeatureCollection result = apiInstance.getAllFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, includeDetails, inputType, includeDeleted);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FieldsApi.getAllFields: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFieldsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$uuidsOnly = true; // Boolean | UUIDs Only - Return an array of field UUID's
$lon = 1.2; // Double | Longitude
$lat = 1.2; // Double | Latitude
$radius = 1.2; // Double | Search radius (in metres)
$start = 56; // Integer | Start pagination offset
$limit = 56; // Integer | Results per page
$sort = sort_example; // String | Results sort order
$projection = 56; // Integer | Image Projection
$includeDetails = true; // Boolean | Include SubField Details
$inputType = inputType_example; // String | Input type
$includeDeleted = true; // Boolean | Include deleted fields

try {
    $result = $api_instance->getAllFields($xProfileId, $uuidsOnly, $lon, $lat, $radius, $start, $limit, $sort, $projection, $includeDetails, $inputType, $includeDeleted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->getAllFields: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FieldsApi;


my $api_instance = WWW::SwaggerClient::FieldsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $uuidsOnly = true; # Boolean | UUIDs Only - Return an array of field UUID's
my $lon = 1.2; # Double | Longitude
my $lat = 1.2; # Double | Latitude
my $radius = 1.2; # Double | Search radius (in metres)
my $start = 56; # Integer | Start pagination offset
my $limit = 56; # Integer | Results per page
my $sort = sort_example; # String | Results sort order
my $projection = 56; # Integer | Image Projection
my $includeDetails = true; # Boolean | Include SubField Details
my $inputType = inputType_example; # String | Input type
my $includeDeleted = true; # Boolean | Include deleted fields

eval { 
    my $result = $api_instance->getAllFields(xProfileId => $xProfileId, uuidsOnly => $uuidsOnly, lon => $lon, lat => $lat, radius => $radius, start => $start, limit => $limit, sort => $sort, projection => $projection, includeDetails => $includeDetails, inputType => $inputType, includeDeleted => $includeDeleted);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FieldsApi->getAllFields: $@\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.FieldsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
uuidsOnly = true # Boolean | UUIDs Only - Return an array of field UUID's (optional) (default to false)
lon = 1.2 # Double | Longitude (optional)
lat = 1.2 # Double | Latitude (optional)
radius = 1.2 # Double | Search radius (in metres) (optional) (default to 20000)
start = 56 # Integer | Start pagination offset (optional) (default to 0)
limit = 56 # Integer | Results per page (optional) (default to 10)
sort = sort_example # String | Results sort order (optional) (default to id)
projection = 56 # Integer | Image Projection (optional) (default to 4326)
includeDetails = true # Boolean | Include SubField Details (optional) (default to false)
inputType = inputType_example # String | Input type (optional) (default to SPECIFIED_FIELD)
includeDeleted = true # Boolean | Include deleted fields (optional) (default to false)

try: 
    # Returns a list of Fields
    api_response = api_instance.get_all_fields(xProfileId=xProfileId, uuidsOnly=uuidsOnly, lon=lon, lat=lat, radius=radius, start=start, limit=limit, sort=sort, projection=projection, includeDetails=includeDetails, inputType=inputType, includeDeleted=includeDeleted)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FieldsApi->getAllFields: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
uuidsOnly	Boolean UUIDs Only - Return an array of field UUID's
lon	Double (double) Longitude
lat	Double (double) Latitude
radius	Double (double) Search radius (in metres)
start	Integer (int32) Start pagination offset
limit	Integer (int32) Results per page
sort	String Results sort order
projection	Integer (int32) Image Projection
includeDetails	Boolean Include SubField Details
inputType	String Input type
includeDeleted	Boolean Include deleted fields

Responses

Status: 200 - HTTP 200 All Fields successfully found

Schema

Status: 400 - HTTP 400 Bad User Input

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Fields not found

Schema

getField

Get a Field

Return a Field and SubFields based on unique identifier

/field/{fieldId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldId}?projection="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FieldsApi;

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

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        try {
            Feature result = apiInstance.getField(fieldId, xProfileId, projection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FieldsApi;

public class FieldsApiExample {

    public static void main(String[] args) {
        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        try {
            Feature result = apiInstance.getField(fieldId, xProfileId, projection);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *fieldId = fieldId_example; // Unique field id
String *xProfileId = xProfileId_example; // Profile Id (optional)
Integer *projection = 56; // Image Projection (optional) (default to 4326)

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

// Get a Field
[apiInstance getFieldWith:fieldId
    xProfileId:xProfileId
    projection:projection
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FieldsApi()
var fieldId = fieldId_example; // {{String}} Unique field id
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'projection': 56 // {{Integer}} Image Projection
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getField(fieldId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getFieldExample
    {
        public void main()
        {


            var apiInstance = new FieldsApi();
            var fieldId = fieldId_example;  // String | Unique field id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)

            try
            {
                // Get a Field
                Feature result = apiInstance.getField(fieldId, xProfileId, projection);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FieldsApi.getField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFieldsApi();
$fieldId = fieldId_example; // String | Unique field id
$xProfileId = xProfileId_example; // String | Profile Id
$projection = 56; // Integer | Image Projection

try {
    $result = $api_instance->getField($fieldId, $xProfileId, $projection);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->getField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FieldsApi;


my $api_instance = WWW::SwaggerClient::FieldsApi->new();
my $fieldId = fieldId_example; # String | Unique field id
my $xProfileId = xProfileId_example; # String | Profile Id
my $projection = 56; # Integer | Image Projection

eval { 
    my $result = $api_instance->getField(fieldId => $fieldId, xProfileId => $xProfileId, projection => $projection);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FieldsApi->getField: $@\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.FieldsApi()
fieldId = fieldId_example # String | Unique field id
xProfileId = xProfileId_example # String | Profile Id (optional)
projection = 56 # Integer | Image Projection (optional) (default to 4326)

try: 
    # Get a Field
    api_response = api_instance.get_field(fieldId, xProfileId=xProfileId, projection=projection)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FieldsApi->getField: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldId*	String Unique field id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
projection	Integer (int32) Image Projection

Responses

Status: 200 - HTTP 200 Field successfully found

Schema

Status: 400 - HTTP 400 Bad User Input

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Field not found

Schema

updateField

Update a Field

Update Field attributes and/or SubFields

/field/{fieldId}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//field/{fieldId}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FieldsApi;

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

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        RequestJson body = ; // RequestJson | Field update JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UuidFieldResponse result = apiInstance.updateField(fieldId, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#updateField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FieldsApi;

public class FieldsApiExample {

    public static void main(String[] args) {
        FieldsApi apiInstance = new FieldsApi();
        String fieldId = fieldId_example; // String | Unique field id
        RequestJson body = ; // RequestJson | Field update JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UuidFieldResponse result = apiInstance.updateField(fieldId, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#updateField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *fieldId = fieldId_example; // Unique field id
RequestJson *body = ; // Field update JSON payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Update a Field
[apiInstance updateFieldWith:fieldId
    body:body
    xProfileId:xProfileId
              completionHandler: ^(UuidFieldResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FieldsApi()
var fieldId = fieldId_example; // {{String}} Unique field id
var opts = { 
  'body':  // {{RequestJson}} Field update JSON payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateField(fieldId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateFieldExample
    {
        public void main()
        {


            var apiInstance = new FieldsApi();
            var fieldId = fieldId_example;  // String | Unique field id
            var body = new RequestJson(); // RequestJson | Field update JSON payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Update a Field
                UuidFieldResponse result = apiInstance.updateField(fieldId, body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FieldsApi.updateField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFieldsApi();
$fieldId = fieldId_example; // String | Unique field id
$body = ; // RequestJson | Field update JSON payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->updateField($fieldId, $body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->updateField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FieldsApi;


my $api_instance = WWW::SwaggerClient::FieldsApi->new();
my $fieldId = fieldId_example; # String | Unique field id
my $body = WWW::SwaggerClient::Object::RequestJson->new(); # RequestJson | Field update JSON payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->updateField(fieldId => $fieldId, body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FieldsApi->updateField: $@\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.FieldsApi()
fieldId = fieldId_example # String | Unique field id
body =  # RequestJson | Field update JSON payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Update a Field
    api_response = api_instance.update_field(fieldId, body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FieldsApi->updateField: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldId*	String Unique field id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - HTTP 200 The field was successfully updated for the provided UpdateJson

Schema

Status: 400 - HTTP 400 Bad User Input

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Field not found

Schema

FinanceEmissions

calculateFinanceEmission

Calculates Spend Based Emission

/carbon/economic_activity

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//carbon/economic_activity"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FinanceEmissionsApi;

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

public class FinanceEmissionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FinanceEmissionsApi apiInstance = new FinanceEmissionsApi();
        FinanceEmissionPayload body = ; // FinanceEmissionPayload | Payload for Spend Based Emission
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            inline_response_200 result = apiInstance.calculateFinanceEmission(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FinanceEmissionsApi#calculateFinanceEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FinanceEmissionsApi;

public class FinanceEmissionsApiExample {

    public static void main(String[] args) {
        FinanceEmissionsApi apiInstance = new FinanceEmissionsApi();
        FinanceEmissionPayload body = ; // FinanceEmissionPayload | Payload for Spend Based Emission
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            inline_response_200 result = apiInstance.calculateFinanceEmission(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FinanceEmissionsApi#calculateFinanceEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
FinanceEmissionPayload *body = ; // Payload for Spend Based Emission
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Calculates Spend Based Emission
[apiInstance calculateFinanceEmissionWith:body
    xProfileId:xProfileId
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FinanceEmissionsApi()
var body = ; // {{FinanceEmissionPayload}} Payload for Spend Based Emission
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateFinanceEmission(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculateFinanceEmissionExample
    {
        public void main()
        {


            var apiInstance = new FinanceEmissionsApi();
            var body = new FinanceEmissionPayload(); // FinanceEmissionPayload | Payload for Spend Based Emission
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Calculates Spend Based Emission
                inline_response_200 result = apiInstance.calculateFinanceEmission(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FinanceEmissionsApi.calculateFinanceEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFinanceEmissionsApi();
$body = ; // FinanceEmissionPayload | Payload for Spend Based Emission
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->calculateFinanceEmission($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FinanceEmissionsApi->calculateFinanceEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FinanceEmissionsApi;


my $api_instance = WWW::SwaggerClient::FinanceEmissionsApi->new();
my $body = WWW::SwaggerClient::Object::FinanceEmissionPayload->new(); # FinanceEmissionPayload | Payload for Spend Based Emission
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->calculateFinanceEmission(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FinanceEmissionsApi->calculateFinanceEmission: $@\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.FinanceEmissionsApi()
body =  # FinanceEmissionPayload | Payload for Spend Based Emission
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Calculates Spend Based Emission
    api_response = api_instance.calculate_finance_emission(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FinanceEmissionsApi->calculateFinanceEmission: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - HTTP 200 emission value retrieved successfully

{"transactionId":"eacac295-f850-443d-ae06-bf30c80e9a6e","TotalCO2e":143.7580282,"description":"Economic activity method is used. Emissions factors are obtained from  EORA factor data from 2022 for Oil and gas extraction Afghanistan. Revenue is estimated using an Asset Turnover Ratio of 0.68 against asset value. "}

{"result":{"transactionId":"b954f501-35e3-43e4-9867-3d71350b8af3","TotalCO2e":143.7580282,"description":"Economic activity method is used. Emissions factors are obtained from EORA factor data from 2022 for Oil and gas extraction Afghanistan. Revenue is estimated using an Asset Turnover Ratio of 0.68 against asset value. "},"data":{"unitEntity":[{"id":1,"name":"Total CO2e(kgCO2e/unit)","description":"It equals the sum of CO2, CH4 and N2O per unit factors expressed in kg of CO2-equivalents. "}],"countryEntity":[{"id":1,"internalName":"Afghanistan","standardName":"Afghanistan","name":"Afghanistan","alpha2":"AF","alpha3":"AFG","countryCode":4,"iso31662":"ISO 3166-2:AF","createdAt":"2025-02-27T21:06:32Z"}],"factorSetEntity":[{"id":1,"type":"Managed - Eora66","description":"Concordance of spend categories mapped from Eora Full dataset to 66 categories aligned with US EEIO.","factorSource":"The Eora Global Supply Chain Database - Eora Full set with concordance mapping to US EPA 66 EEIO Summary spend categories - https://worldmrio.com/ & https://knowledgebase.envizi.com/home/managed-emission-factors-eora-mrio-multi-region-in","createdAt":"2025-02-27T20:59:59Z"}],"factorDataTypeCodeEntity":[{"id":39,"factorSetsId":1,"type":"Oil and gas extraction [USD]","subtype":"Default Factor","createdAt":"2025-02-27T21:00:32Z"}],"factorSetVersionEntity":[{"id":8,"factorSetsId":1,"effectiveFrom":"2022-01-01T00:00:00Z","publishedFrom":"2023-07-01T00:00:00Z","reviewOn":"2025-01-01T00:00:00Z","year":2022,"factorSource":"2022 - The Eora Global Supply Chain Database - Eora Full set with concordance mapping to US EPA 66 EEIO Summary spend categories - https://worldmrio.com/ & https://knowledgebase.envizi.com/home/managed-emission-factors-eora-mrio-multi-region-in","createdAt":"2025-02-27T21:01:03Z"}],"factorValueEntity":[{"id":312,"countryId":1,"region":"Afghanistan","factorDataTypeCodesId":39,"factorSetVersionsId":8,"unitsId":1,"value":2.11408865}]}}

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

calculateRealEstateEmission

Calculates Real Estate Based Emission

/carbon/real_estate

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//carbon/real_estate"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FinanceEmissionsApi;

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

public class FinanceEmissionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        FinanceEmissionsApi apiInstance = new FinanceEmissionsApi();
        RealEstateEmissionPayload body = ; // RealEstateEmissionPayload | Payload for Real Estate Based Emission
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            inline_response_200_1 result = apiInstance.calculateRealEstateEmission(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FinanceEmissionsApi#calculateRealEstateEmission");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.FinanceEmissionsApi;

public class FinanceEmissionsApiExample {

    public static void main(String[] args) {
        FinanceEmissionsApi apiInstance = new FinanceEmissionsApi();
        RealEstateEmissionPayload body = ; // RealEstateEmissionPayload | Payload for Real Estate Based Emission
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            inline_response_200_1 result = apiInstance.calculateRealEstateEmission(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FinanceEmissionsApi#calculateRealEstateEmission");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
RealEstateEmissionPayload *body = ; // Payload for Real Estate Based Emission
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Calculates Real Estate Based Emission
[apiInstance calculateRealEstateEmissionWith:body
    xProfileId:xProfileId
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.FinanceEmissionsApi()
var body = ; // {{RealEstateEmissionPayload}} Payload for Real Estate Based Emission
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.calculateRealEstateEmission(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class calculateRealEstateEmissionExample
    {
        public void main()
        {


            var apiInstance = new FinanceEmissionsApi();
            var body = new RealEstateEmissionPayload(); // RealEstateEmissionPayload | Payload for Real Estate Based Emission
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Calculates Real Estate Based Emission
                inline_response_200_1 result = apiInstance.calculateRealEstateEmission(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FinanceEmissionsApi.calculateRealEstateEmission: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiFinanceEmissionsApi();
$body = ; // RealEstateEmissionPayload | Payload for Real Estate Based Emission
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->calculateRealEstateEmission($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FinanceEmissionsApi->calculateRealEstateEmission: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FinanceEmissionsApi;


my $api_instance = WWW::SwaggerClient::FinanceEmissionsApi->new();
my $body = WWW::SwaggerClient::Object::RealEstateEmissionPayload->new(); # RealEstateEmissionPayload | Payload for Real Estate Based Emission
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->calculateRealEstateEmission(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FinanceEmissionsApi->calculateRealEstateEmission: $@\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.FinanceEmissionsApi()
body =  # RealEstateEmissionPayload | Payload for Real Estate Based Emission
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Calculates Real Estate Based Emission
    api_response = api_instance.calculate_real_estate_emission(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FinanceEmissionsApi->calculateRealEstateEmission: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - HTTP 200 emission value retrieved successfully

{"transactionId":"00bb8acb-1748-42ba-b8a7-980eecc244eb","TotalCO2e":2.032476259,"description":"Residential method is used.Emissions/Energy intensity factors are obtained from Managed - Eora66 factor data from 2022 for Accommodation [USD] Default Factor Afghanistan. "}

{"result":{"transactionId":"581b965f-4451-4b3e-87c4-15fa248b3cfa","TotalCO2e":2.032476259,"description":"Residential method is used.Emissions/Energy intensity factors are obtained from Managed - Eora66 factor data from 2022 for Accommodation [USD] Default Factor Afghanistan. "},"data":{"unitEntity":[{"id":12,"name":"tCO<sub>2</sub>e/m¬≤","description":"Area based Emission - Total co2 per square meter","category":"emission","format":"sqmt"}],"countryEntity":[{"id":1,"internalName":"Afghanistan","standardName":"Afghanistan","name":"Afghanistan","alpha2":"AF","alpha3":"AFG","countryCode":4,"iso31662":"ISO 3166-2:AF","createdAt":"2025-02-27T21:06:32Z"}],"factorSetEntity":[{"id":1,"type":"Managed - Eora66","description":"Concordance of spend categories mapped from Eora Full dataset to 66 categories aligned with US EEIO.","factorSource":"The Eora Global Supply Chain Database - Eora Full set with concordance mapping to US EPA 66 EEIO Summary spend categories - https://worldmrio.com/ & https://knowledgebase.envizi.com/home/managed-emission-factors-eora-mrio-multi-region-in","createdAt":"2025-02-27T20:59:59Z"}],"factorDataTypeCodeEntity":[{"id":1,"factorSetsId":1,"type":"Accommodation [USD]","subtype":"Default Factor","createdAt":"2025-02-27T21:00:32Z"}],"factorSetVersionEntity":[{"id":8,"factorSetsId":1,"effectiveFrom":"2022-01-01T00:00:00Z","publishedFrom":"2023-07-01T00:00:00Z","reviewOn":"2025-01-01T00:00:00Z","year":2022,"factorSource":"2022 - The Eora Global Supply Chain Database - Eora Full set with concordance mapping to US EPA 66 EEIO Summary spend categories - https://worldmrio.com/ & https://knowledgebase.envizi.com/home/managed-emission-factors-eora-mrio-multi-region-in","createdAt":"2025-02-27T21:01:03Z"}],"factorValueEntity":[{"id":8,"countryId":1,"region":"Afghanistan","factorDataTypeCodesId":1,"factorSetVersionsId":8,"unitsId":12,"value":1.84770569}]}}

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Hierarchy

createHierarchy

Create hierarchy type and hierarchy levels

/hierarchy

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//hierarchy"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        HierarchyApi apiInstance = new HierarchyApi();
        Hierarchy body = ; // Hierarchy | Create hierarchy type and hierarchy levels
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            'String' result = apiInstance.createHierarchy(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#createHierarchy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        Hierarchy body = ; // Hierarchy | Create hierarchy type and hierarchy levels
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            'String' result = apiInstance.createHierarchy(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#createHierarchy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
Hierarchy *body = ; // Create hierarchy type and hierarchy levels
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create hierarchy type and hierarchy levels
[apiInstance createHierarchyWith:body
    xProfileId:xProfileId
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.HierarchyApi()
var body = ; // {{Hierarchy}} Create hierarchy type and hierarchy levels
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createHierarchy(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createHierarchyExample
    {
        public void main()
        {


            var apiInstance = new HierarchyApi();
            var body = new Hierarchy(); // Hierarchy | Create hierarchy type and hierarchy levels
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create hierarchy type and hierarchy levels
                'String' result = apiInstance.createHierarchy(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.createHierarchy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiHierarchyApi();
$body = ; // Hierarchy | Create hierarchy type and hierarchy levels
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createHierarchy($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HierarchyApi->createHierarchy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HierarchyApi;


my $api_instance = WWW::SwaggerClient::HierarchyApi->new();
my $body = WWW::SwaggerClient::Object::Hierarchy->new(); # Hierarchy | Create hierarchy type and hierarchy levels
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createHierarchy(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HierarchyApi->createHierarchy: $@\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.HierarchyApi()
body =  # Hierarchy | Create hierarchy type and hierarchy levels
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create hierarchy type and hierarchy levels
    api_response = api_instance.create_hierarchy(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->createHierarchy: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 201 - The hierarchy was successfully created.

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 531 - HTTP 531 Hierarchy DB Error

Schema

deleteHierarchy

Delete hierarchy

/hierarchy/{hierarchyName}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//hierarchy/{hierarchyName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteHierarchy(hierarchyName, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#deleteHierarchy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteHierarchy(hierarchyName, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#deleteHierarchy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *hierarchyName = hierarchyName_example; // Hierarchy type name/key
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Delete hierarchy
[apiInstance deleteHierarchyWith:hierarchyName
    xProfileId:xProfileId
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.HierarchyApi()
var hierarchyName = hierarchyName_example; // {{String}} Hierarchy type name/key
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteHierarchy(hierarchyName, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteHierarchyExample
    {
        public void main()
        {


            var apiInstance = new HierarchyApi();
            var hierarchyName = hierarchyName_example;  // String | Hierarchy type name/key
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Delete hierarchy
                APIResponseMessage result = apiInstance.deleteHierarchy(hierarchyName, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.deleteHierarchy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiHierarchyApi();
$hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->deleteHierarchy($hierarchyName, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HierarchyApi->deleteHierarchy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HierarchyApi;


my $api_instance = WWW::SwaggerClient::HierarchyApi->new();
my $hierarchyName = hierarchyName_example; # String | Hierarchy type name/key
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->deleteHierarchy(hierarchyName => $hierarchyName, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HierarchyApi->deleteHierarchy: $@\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.HierarchyApi()
hierarchyName = hierarchyName_example # String | Hierarchy type name/key
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Delete hierarchy
    api_response = api_instance.delete_hierarchy(hierarchyName, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->deleteHierarchy: %s\n" % e)

Parameters

Path parameters

Name	Description
hierarchyName*	String Hierarchy type name/key Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 204 - Hierarchy successfully deleted

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getHierarchyByType

Get hierarchy type and hierarchy levels

Get hierarchy types and hierarchy levels

/hierarchy/{hierarchyName}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//hierarchy/{hierarchyName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Hierarchy result = apiInstance.getHierarchyByType(hierarchyName, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getHierarchyByType");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Hierarchy result = apiInstance.getHierarchyByType(hierarchyName, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getHierarchyByType");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *hierarchyName = hierarchyName_example; // Hierarchy type name/key
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get hierarchy type and hierarchy levels
[apiInstance getHierarchyByTypeWith:hierarchyName
    xProfileId:xProfileId
              completionHandler: ^(Hierarchy output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.HierarchyApi()
var hierarchyName = hierarchyName_example; // {{String}} Hierarchy type name/key
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHierarchyByType(hierarchyName, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHierarchyByTypeExample
    {
        public void main()
        {


            var apiInstance = new HierarchyApi();
            var hierarchyName = hierarchyName_example;  // String | Hierarchy type name/key
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get hierarchy type and hierarchy levels
                Hierarchy result = apiInstance.getHierarchyByType(hierarchyName, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.getHierarchyByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiHierarchyApi();
$hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getHierarchyByType($hierarchyName, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HierarchyApi->getHierarchyByType: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HierarchyApi;


my $api_instance = WWW::SwaggerClient::HierarchyApi->new();
my $hierarchyName = hierarchyName_example; # String | Hierarchy type name/key
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getHierarchyByType(hierarchyName => $hierarchyName, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HierarchyApi->getHierarchyByType: $@\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.HierarchyApi()
hierarchyName = hierarchyName_example # String | Hierarchy type name/key
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get hierarchy type and hierarchy levels
    api_response = api_instance.get_hierarchy_by_type(hierarchyName, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->getHierarchyByType: %s\n" % e)

Parameters

Path parameters

Name	Description
hierarchyName*	String Hierarchy type name/key Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HierarchyType successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Hierarchy Type not found

Schema

getHierarchyList

Get all hierarchy types and hierarchy levels

/hierarchy

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//hierarchy"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        HierarchyApi apiInstance = new HierarchyApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            HierarchyList result = apiInstance.getHierarchyList(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getHierarchyList");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            HierarchyList result = apiInstance.getHierarchyList(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#getHierarchyList");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get all hierarchy types and hierarchy levels
[apiInstance getHierarchyListWith:xProfileId
              completionHandler: ^(HierarchyList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.HierarchyApi()
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHierarchyList(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getHierarchyListExample
    {
        public void main()
        {


            var apiInstance = new HierarchyApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get all hierarchy types and hierarchy levels
                HierarchyList result = apiInstance.getHierarchyList(xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.getHierarchyList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiHierarchyApi();
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getHierarchyList($xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HierarchyApi->getHierarchyList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HierarchyApi;


my $api_instance = WWW::SwaggerClient::HierarchyApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getHierarchyList(xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HierarchyApi->getHierarchyList: $@\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.HierarchyApi()
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get all hierarchy types and hierarchy levels
    api_response = api_instance.get_hierarchy_list(xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->getHierarchyList: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HierarchyType successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

updateHierarchy

Update a given hierarchy

Update hierarchy type and hierarchy levels

/hierarchy/{hierarchyName}

Usage and SDK Samples

curl -X PUT\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//hierarchy/{hierarchyName}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.HierarchyApi;

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

public class HierarchyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        Hierarchy body = ; // Hierarchy | Hierarchy update JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.updateHierarchy(hierarchyName, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#updateHierarchy");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.HierarchyApi;

public class HierarchyApiExample {

    public static void main(String[] args) {
        HierarchyApi apiInstance = new HierarchyApi();
        String hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
        Hierarchy body = ; // Hierarchy | Hierarchy update JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            AssetFeature result = apiInstance.updateHierarchy(hierarchyName, body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HierarchyApi#updateHierarchy");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *hierarchyName = hierarchyName_example; // Hierarchy type name/key
Hierarchy *body = ; // Hierarchy update JSON payload (optional)
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Update a given hierarchy
[apiInstance updateHierarchyWith:hierarchyName
    body:body
    xProfileId:xProfileId
              completionHandler: ^(AssetFeature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.HierarchyApi()
var hierarchyName = hierarchyName_example; // {{String}} Hierarchy type name/key
var opts = { 
  'body':  // {{Hierarchy}} Hierarchy update JSON payload
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateHierarchy(hierarchyName, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class updateHierarchyExample
    {
        public void main()
        {


            var apiInstance = new HierarchyApi();
            var hierarchyName = hierarchyName_example;  // String | Hierarchy type name/key
            var body = new Hierarchy(); // Hierarchy | Hierarchy update JSON payload (optional) 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Update a given hierarchy
                AssetFeature result = apiInstance.updateHierarchy(hierarchyName, body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling HierarchyApi.updateHierarchy: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiHierarchyApi();
$hierarchyName = hierarchyName_example; // String | Hierarchy type name/key
$body = ; // Hierarchy | Hierarchy update JSON payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->updateHierarchy($hierarchyName, $body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HierarchyApi->updateHierarchy: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::HierarchyApi;


my $api_instance = WWW::SwaggerClient::HierarchyApi->new();
my $hierarchyName = hierarchyName_example; # String | Hierarchy type name/key
my $body = WWW::SwaggerClient::Object::Hierarchy->new(); # Hierarchy | Hierarchy update JSON payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->updateHierarchy(hierarchyName => $hierarchyName, body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HierarchyApi->updateHierarchy: $@\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.HierarchyApi()
hierarchyName = hierarchyName_example # String | Hierarchy type name/key
body =  # Hierarchy | Hierarchy update JSON payload (optional)
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Update a given hierarchy
    api_response = api_instance.update_hierarchy(hierarchyName, body=body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HierarchyApi->updateHierarchy: %s\n" % e)

Parameters

Path parameters

Name	Description
hierarchyName*	String Hierarchy type name/key Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body

Responses

Status: 200 - The hierarchy was successfully updated

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Requested hierarchy not found

Schema

Information

getAllLayersInfoBySubField

Get Information For All Data Layers for a Specific SubField

Returns SubField layer information for all layer ids (eg SOIL, NDVI, DISEASE, YIELD etc)

/field/{fielduuid}/subfield/{subfielduuid}/layer

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fielduuid}/subfield/{subfielduuid}/layer?contextId=&date="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InformationApi;

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

public class InformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InformationApi apiInstance = new InformationApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            LayerInfoResponse result = apiInstance.getAllLayersInfoBySubField(fielduuid, subfielduuid, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#getAllLayersInfoBySubField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InformationApi;

public class InformationApiExample {

    public static void main(String[] args) {
        InformationApi apiInstance = new InformationApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            LayerInfoResponse result = apiInstance.getAllLayersInfoBySubField(fielduuid, subfielduuid, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#getAllLayersInfoBySubField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field UUID
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *contextId = contextId_example; // Layer context ID (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)

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

// Get Information For All Data Layers for a Specific SubField
[apiInstance getAllLayersInfoBySubFieldWith:fielduuid
    subfielduuid:subfielduuid
    xProfileId:xProfileId
    contextId:contextId
    date:date
              completionHandler: ^(LayerInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InformationApi()
var fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field UUID
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'contextId': contextId_example, // {{String}} Layer context ID
  'date': date_example // {{String}} Query Date yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllLayersInfoBySubField(fielduuid, subfielduuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllLayersInfoBySubFieldExample
    {
        public void main()
        {


            var apiInstance = new InformationApi();
            var fielduuid = new UUID(); // UUID | Unique Field UUID
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var contextId = contextId_example;  // String | Layer context ID (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 

            try
            {
                // Get Information For All Data Layers for a Specific SubField
                LayerInfoResponse result = apiInstance.getAllLayersInfoBySubField(fielduuid, subfielduuid, xProfileId, contextId, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InformationApi.getAllLayersInfoBySubField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInformationApi();
$fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$xProfileId = xProfileId_example; // String | Profile Id
$contextId = contextId_example; // String | Layer context ID
$date = date_example; // String | Query Date yyyy-MM-dd

try {
    $result = $api_instance->getAllLayersInfoBySubField($fielduuid, $subfielduuid, $xProfileId, $contextId, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformationApi->getAllLayersInfoBySubField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InformationApi;


my $api_instance = WWW::SwaggerClient::InformationApi->new();
my $fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field UUID
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $xProfileId = xProfileId_example; # String | Profile Id
my $contextId = contextId_example; # String | Layer context ID
my $date = date_example; # String | Query Date yyyy-MM-dd

eval { 
    my $result = $api_instance->getAllLayersInfoBySubField(fielduuid => $fielduuid, subfielduuid => $subfielduuid, xProfileId => $xProfileId, contextId => $contextId, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InformationApi->getAllLayersInfoBySubField: $@\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.InformationApi()
fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field UUID
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
xProfileId = xProfileId_example # String | Profile Id (optional)
contextId = contextId_example # String | Layer context ID (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)

try: 
    # Get Information For All Data Layers for a Specific SubField
    api_response = api_instance.get_all_layers_info_by_sub_field(fielduuid, subfielduuid, xProfileId=xProfileId, contextId=contextId, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InformationApi->getAllLayersInfoBySubField: %s\n" % e)

Parameters

Path parameters

Name	Description
fielduuid*	UUID (uuid) Unique Field UUID Required
subfielduuid*	UUID (uuid) Unique SubField UUID Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
contextId	String Layer context ID
date	String Query Date yyyy-MM-dd

Responses

Status: 200 - HTTP 200 All SubField layers information successfully returned

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

Status: 503 - HTTP 503 Unable to communicate with SubField Management Service

Schema

getLayerInfoBySubField

Get Information For a Specific Data Layer and a Specific SubField

Returns SubField layer information for a specific layer id (eg SOIL, NDVI, DISEASE, YIELD etc)

/field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/info

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/info?contextId=&date="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InformationApi;

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

public class InformationApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InformationApi apiInstance = new InformationApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            LayerInfoResponse result = apiInstance.getLayerInfoBySubField(fielduuid, subfielduuid, layer, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#getLayerInfoBySubField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InformationApi;

public class InformationApiExample {

    public static void main(String[] args) {
        InformationApi apiInstance = new InformationApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            LayerInfoResponse result = apiInstance.getLayerInfoBySubField(fielduuid, subfielduuid, layer, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InformationApi#getLayerInfoBySubField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field UUID
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *layer = layer_example; // Image Layer type
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *contextId = contextId_example; // Layer context ID (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)

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

// Get Information For a Specific Data Layer and a Specific SubField
[apiInstance getLayerInfoBySubFieldWith:fielduuid
    subfielduuid:subfielduuid
    layer:layer
    xProfileId:xProfileId
    contextId:contextId
    date:date
              completionHandler: ^(LayerInfoResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InformationApi()
var fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field UUID
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var layer = layer_example; // {{String}} Image Layer type
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'contextId': contextId_example, // {{String}} Layer context ID
  'date': date_example // {{String}} Query Date yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLayerInfoBySubField(fielduuid, subfielduuid, layer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLayerInfoBySubFieldExample
    {
        public void main()
        {


            var apiInstance = new InformationApi();
            var fielduuid = new UUID(); // UUID | Unique Field UUID
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var layer = layer_example;  // String | Image Layer type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var contextId = contextId_example;  // String | Layer context ID (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 

            try
            {
                // Get Information For a Specific Data Layer and a Specific SubField
                LayerInfoResponse result = apiInstance.getLayerInfoBySubField(fielduuid, subfielduuid, layer, xProfileId, contextId, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InformationApi.getLayerInfoBySubField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInformationApi();
$fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$layer = layer_example; // String | Image Layer type
$xProfileId = xProfileId_example; // String | Profile Id
$contextId = contextId_example; // String | Layer context ID
$date = date_example; // String | Query Date yyyy-MM-dd

try {
    $result = $api_instance->getLayerInfoBySubField($fielduuid, $subfielduuid, $layer, $xProfileId, $contextId, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InformationApi->getLayerInfoBySubField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InformationApi;


my $api_instance = WWW::SwaggerClient::InformationApi->new();
my $fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field UUID
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $layer = layer_example; # String | Image Layer type
my $xProfileId = xProfileId_example; # String | Profile Id
my $contextId = contextId_example; # String | Layer context ID
my $date = date_example; # String | Query Date yyyy-MM-dd

eval { 
    my $result = $api_instance->getLayerInfoBySubField(fielduuid => $fielduuid, subfielduuid => $subfielduuid, layer => $layer, xProfileId => $xProfileId, contextId => $contextId, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InformationApi->getLayerInfoBySubField: $@\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.InformationApi()
fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field UUID
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
layer = layer_example # String | Image Layer type
xProfileId = xProfileId_example # String | Profile Id (optional)
contextId = contextId_example # String | Layer context ID (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)

try: 
    # Get Information For a Specific Data Layer and a Specific SubField
    api_response = api_instance.get_layer_info_by_sub_field(fielduuid, subfielduuid, layer, xProfileId=xProfileId, contextId=contextId, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InformationApi->getLayerInfoBySubField: %s\n" % e)

Parameters

Path parameters

Name	Description
fielduuid*	UUID (uuid) Unique Field UUID Required
subfielduuid*	UUID (uuid) Unique SubField UUID Required
layer*	String Image Layer type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
contextId	String Layer context ID
date	String Query Date yyyy-MM-dd

Responses

Status: 200 - HTTP 200 SubField layer information successfully returned

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

Status: 503 - HTTP 503 Unable to communicate with SubField Management Service

Schema

Infrastructure

createInfrastructure

Create an asset infrastructure

Creates an asset infrastructure

/asset/infrastructure

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/infrastructure"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfrastructureApi;

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

public class InfrastructureApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InfrastructureApi apiInstance = new InfrastructureApi();
        CreateInfrastructurePayload body = ; // CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createInfrastructure(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#createInfrastructure");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfrastructureApi;

public class InfrastructureApiExample {

    public static void main(String[] args) {
        InfrastructureApi apiInstance = new InfrastructureApi();
        CreateInfrastructurePayload body = ; // CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createInfrastructure(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#createInfrastructure");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
CreateInfrastructurePayload *body = ; // Payload containing list of asset infrastructure to create
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create an asset infrastructure
[apiInstance createInfrastructureWith:body
    xProfileId:xProfileId
              completionHandler: ^(UUIDResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InfrastructureApi()
var body = ; // {{CreateInfrastructurePayload}} Payload containing list of asset infrastructure to create
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInfrastructure(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInfrastructureExample
    {
        public void main()
        {


            var apiInstance = new InfrastructureApi();
            var body = new CreateInfrastructurePayload(); // CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create an asset infrastructure
                UUIDResponse result = apiInstance.createInfrastructure(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfrastructureApi.createInfrastructure: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInfrastructureApi();
$body = ; // CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createInfrastructure($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfrastructureApi->createInfrastructure: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfrastructureApi;


my $api_instance = WWW::SwaggerClient::InfrastructureApi->new();
my $body = WWW::SwaggerClient::Object::CreateInfrastructurePayload->new(); # CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createInfrastructure(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfrastructureApi->createInfrastructure: $@\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.InfrastructureApi()
body =  # CreateInfrastructurePayload | Payload containing list of asset infrastructure to create
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create an asset infrastructure
    api_response = api_instance.create_infrastructure(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfrastructureApi->createInfrastructure: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 201 - The asset was successfully created

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 530 - HTTP 530 Geo Parser Error

Schema

Status: 531 - HTTP 531 Database error

Schema

createInfrastructureCategory

Create an infrastructure category

/asset/infrastructure/category

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/infrastructure/category"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfrastructureApi;

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

public class InfrastructureApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InfrastructureApi apiInstance = new InfrastructureApi();
        CreateInfrastructureCategoryPayload body = ; // CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.createInfrastructureCategory(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#createInfrastructureCategory");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfrastructureApi;

public class InfrastructureApiExample {

    public static void main(String[] args) {
        InfrastructureApi apiInstance = new InfrastructureApi();
        CreateInfrastructureCategoryPayload body = ; // CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.createInfrastructureCategory(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#createInfrastructureCategory");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
CreateInfrastructureCategoryPayload *body = ; // Payload containing list of asset infrastructure to create
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create an infrastructure category
[apiInstance createInfrastructureCategoryWith:body
    xProfileId:xProfileId
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InfrastructureApi()
var body = ; // {{CreateInfrastructureCategoryPayload}} Payload containing list of asset infrastructure to create
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createInfrastructureCategory(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createInfrastructureCategoryExample
    {
        public void main()
        {


            var apiInstance = new InfrastructureApi();
            var body = new CreateInfrastructureCategoryPayload(); // CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create an infrastructure category
                APIResponseMessage result = apiInstance.createInfrastructureCategory(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfrastructureApi.createInfrastructureCategory: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInfrastructureApi();
$body = ; // CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createInfrastructureCategory($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfrastructureApi->createInfrastructureCategory: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfrastructureApi;


my $api_instance = WWW::SwaggerClient::InfrastructureApi->new();
my $body = WWW::SwaggerClient::Object::CreateInfrastructureCategoryPayload->new(); # CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createInfrastructureCategory(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfrastructureApi->createInfrastructureCategory: $@\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.InfrastructureApi()
body =  # CreateInfrastructureCategoryPayload | Payload containing list of asset infrastructure to create
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create an infrastructure category
    api_response = api_instance.create_infrastructure_category(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfrastructureApi->createInfrastructureCategory: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - The infrastructure category exists

Schema

Status: 201 - The infrastructure category was successfully created

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 530 - HTTP 530 Geo Parser Error

Schema

Status: 531 - HTTP 531 Database error

Schema

getAllCategories

Returns a list of all infrastructure categories

/asset/infrastructure/category

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//asset/infrastructure/category"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfrastructureApi;

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

public class InfrastructureApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InfrastructureApi apiInstance = new InfrastructureApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            CategoryListResponse result = apiInstance.getAllCategories(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#getAllCategories");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfrastructureApi;

public class InfrastructureApiExample {

    public static void main(String[] args) {
        InfrastructureApi apiInstance = new InfrastructureApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            CategoryListResponse result = apiInstance.getAllCategories(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#getAllCategories");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Returns a list of all infrastructure categories
[apiInstance getAllCategoriesWith:xProfileId
              completionHandler: ^(CategoryListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InfrastructureApi()
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllCategories(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllCategoriesExample
    {
        public void main()
        {


            var apiInstance = new InfrastructureApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Returns a list of all infrastructure categories
                CategoryListResponse result = apiInstance.getAllCategories(xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfrastructureApi.getAllCategories: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInfrastructureApi();
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllCategories($xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfrastructureApi->getAllCategories: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfrastructureApi;


my $api_instance = WWW::SwaggerClient::InfrastructureApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllCategories(xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfrastructureApi->getAllCategories: $@\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.InfrastructureApi()
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Returns a list of all infrastructure categories
    api_response = api_instance.get_all_categories(xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfrastructureApi->getAllCategories: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - Asset(s) successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset(s) not found

Schema

searchInfrastuctureByGeometry

Search for a list of asset infrastructure for a given GeoJson geometry

/asset/infrastructure/search

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//asset/infrastructure/search"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.InfrastructureApi;

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

public class InfrastructureApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        InfrastructureApi apiInstance = new InfrastructureApi();
        SearchInfrastructurePayload body = ; // SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            InfrastructureFeatureCollection result = apiInstance.searchInfrastuctureByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#searchInfrastuctureByGeometry");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.InfrastructureApi;

public class InfrastructureApiExample {

    public static void main(String[] args) {
        InfrastructureApi apiInstance = new InfrastructureApi();
        SearchInfrastructurePayload body = ; // SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            InfrastructureFeatureCollection result = apiInstance.searchInfrastuctureByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling InfrastructureApi#searchInfrastuctureByGeometry");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchInfrastructurePayload *body = ; // Search for a list of asset infrastructure for a given GeoJson geometry
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of asset infrastructure for a given GeoJson geometry
[apiInstance searchInfrastuctureByGeometryWith:body
    xProfileId:xProfileId
              completionHandler: ^(InfrastructureFeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.InfrastructureApi()
var body = ; // {{SearchInfrastructurePayload}} Search for a list of asset infrastructure for a given GeoJson geometry
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.searchInfrastuctureByGeometry(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class searchInfrastuctureByGeometryExample
    {
        public void main()
        {


            var apiInstance = new InfrastructureApi();
            var body = new SearchInfrastructurePayload(); // SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of asset infrastructure for a given GeoJson geometry
                InfrastructureFeatureCollection result = apiInstance.searchInfrastuctureByGeometry(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling InfrastructureApi.searchInfrastuctureByGeometry: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiInfrastructureApi();
$body = ; // SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->searchInfrastuctureByGeometry($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InfrastructureApi->searchInfrastuctureByGeometry: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::InfrastructureApi;


my $api_instance = WWW::SwaggerClient::InfrastructureApi->new();
my $body = WWW::SwaggerClient::Object::SearchInfrastructurePayload->new(); # SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->searchInfrastuctureByGeometry(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling InfrastructureApi->searchInfrastuctureByGeometry: $@\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.InfrastructureApi()
body =  # SearchInfrastructurePayload | Search for a list of asset infrastructure for a given GeoJson geometry
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of asset infrastructure for a given GeoJson geometry
    api_response = api_instance.search_infrastucture_by_geometry(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling InfrastructureApi->searchInfrastuctureByGeometry: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Assets successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Asset not found

Schema

Json

getJsonGdd

Get GDD value

Get the GDD amount

/field/{fielduuid}/subfield/{subfielduuid}/layer/gdd/json

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fielduuid}/subfield/{subfielduuid}/layer/gdd/json?date=&includeDetails="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.JsonApi;

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

public class JsonApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        JsonApi apiInstance = new JsonApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        Boolean includeDetails = true; // Boolean | Include daily Gdd figure breakdown
        try {
            JsonGddResponse result = apiInstance.getJsonGdd(fielduuid, subfielduuid, xProfileId, date, includeDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonApi#getJsonGdd");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.JsonApi;

public class JsonApiExample {

    public static void main(String[] args) {
        JsonApi apiInstance = new JsonApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        Boolean includeDetails = true; // Boolean | Include daily Gdd figure breakdown
        try {
            JsonGddResponse result = apiInstance.getJsonGdd(fielduuid, subfielduuid, xProfileId, date, includeDetails);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling JsonApi#getJsonGdd");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field UUID
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)
Boolean *includeDetails = true; // Include daily Gdd figure breakdown (optional) (default to false)

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

// Get GDD value
[apiInstance getJsonGddWith:fielduuid
    subfielduuid:subfielduuid
    xProfileId:xProfileId
    date:date
    includeDetails:includeDetails
              completionHandler: ^(JsonGddResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.JsonApi()
var fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field UUID
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'date': date_example, // {{String}} Query Date yyyy-MM-dd
  'includeDetails': true // {{Boolean}} Include daily Gdd figure breakdown
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getJsonGdd(fielduuid, subfielduuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getJsonGddExample
    {
        public void main()
        {


            var apiInstance = new JsonApi();
            var fielduuid = new UUID(); // UUID | Unique Field UUID
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 
            var includeDetails = true;  // Boolean | Include daily Gdd figure breakdown (optional)  (default to false)

            try
            {
                // Get GDD value
                JsonGddResponse result = apiInstance.getJsonGdd(fielduuid, subfielduuid, xProfileId, date, includeDetails);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling JsonApi.getJsonGdd: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiJsonApi();
$fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$xProfileId = xProfileId_example; // String | Profile Id
$date = date_example; // String | Query Date yyyy-MM-dd
$includeDetails = true; // Boolean | Include daily Gdd figure breakdown

try {
    $result = $api_instance->getJsonGdd($fielduuid, $subfielduuid, $xProfileId, $date, $includeDetails);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JsonApi->getJsonGdd: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::JsonApi;


my $api_instance = WWW::SwaggerClient::JsonApi->new();
my $fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field UUID
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $xProfileId = xProfileId_example; # String | Profile Id
my $date = date_example; # String | Query Date yyyy-MM-dd
my $includeDetails = true; # Boolean | Include daily Gdd figure breakdown

eval { 
    my $result = $api_instance->getJsonGdd(fielduuid => $fielduuid, subfielduuid => $subfielduuid, xProfileId => $xProfileId, date => $date, includeDetails => $includeDetails);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling JsonApi->getJsonGdd: $@\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.JsonApi()
fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field UUID
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
xProfileId = xProfileId_example # String | Profile Id (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)
includeDetails = true # Boolean | Include daily Gdd figure breakdown (optional) (default to false)

try: 
    # Get GDD value
    api_response = api_instance.get_json_gdd(fielduuid, subfielduuid, xProfileId=xProfileId, date=date, includeDetails=includeDetails)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling JsonApi->getJsonGdd: %s\n" % e)

Parameters

Path parameters

Name	Description
fielduuid*	UUID (uuid) Unique Field UUID Required
subfielduuid*	UUID (uuid) Unique SubField UUID Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
date	String Query Date yyyy-MM-dd
includeDetails	Boolean Include daily Gdd figure breakdown

Responses

Status: 200 - HTTP 200 GDD SubField data successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Onboarding

postMappingJob

Post Job payload

/analytics/job/mapping/hierarchy

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//analytics/job/mapping/hierarchy"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OnboardingApi;

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

public class OnboardingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        OnboardingApi apiInstance = new OnboardingApi();
        PostHierarchyMappingJobPayload body = ; // PostHierarchyMappingJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobListResponse result = apiInstance.postMappingJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OnboardingApi#postMappingJob");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OnboardingApi;

public class OnboardingApiExample {

    public static void main(String[] args) {
        OnboardingApi apiInstance = new OnboardingApi();
        PostHierarchyMappingJobPayload body = ; // PostHierarchyMappingJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobListResponse result = apiInstance.postMappingJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OnboardingApi#postMappingJob");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
PostHierarchyMappingJobPayload *body = ; // Submit new Job payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Post Job payload
[apiInstance postMappingJobWith:body
    xProfileId:xProfileId
              completionHandler: ^(JobListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.OnboardingApi()
var body = ; // {{PostHierarchyMappingJobPayload}} Submit new Job payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postMappingJob(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postMappingJobExample
    {
        public void main()
        {


            var apiInstance = new OnboardingApi();
            var body = new PostHierarchyMappingJobPayload(); // PostHierarchyMappingJobPayload | Submit new Job payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Post Job payload
                JobListResponse result = apiInstance.postMappingJob(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.postMappingJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiOnboardingApi();
$body = ; // PostHierarchyMappingJobPayload | Submit new Job payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->postMappingJob($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OnboardingApi->postMappingJob: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OnboardingApi;


my $api_instance = WWW::SwaggerClient::OnboardingApi->new();
my $body = WWW::SwaggerClient::Object::PostHierarchyMappingJobPayload->new(); # PostHierarchyMappingJobPayload | Submit new Job payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->postMappingJob(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OnboardingApi->postMappingJob: $@\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.OnboardingApi()
body =  # PostHierarchyMappingJobPayload | Submit new Job payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Post Job payload
    api_response = api_instance.post_mapping_job(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OnboardingApi->postMappingJob: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 202 - HTTP 202 Job successfully created

Schema

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

postMappingJob1

Post Job payload

/analytics/job/mapping/vectordata

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//analytics/job/mapping/vectordata"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OnboardingApi;

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

public class OnboardingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        OnboardingApi apiInstance = new OnboardingApi();
        PostVectorDataMappingJobPayload body = ; // PostVectorDataMappingJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postMappingJob1(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OnboardingApi#postMappingJob1");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.OnboardingApi;

public class OnboardingApiExample {

    public static void main(String[] args) {
        OnboardingApi apiInstance = new OnboardingApi();
        PostVectorDataMappingJobPayload body = ; // PostVectorDataMappingJobPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postMappingJob1(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OnboardingApi#postMappingJob1");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
PostVectorDataMappingJobPayload *body = ; // Submit new Job payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Post Job payload
[apiInstance postMappingJob1With:body
    xProfileId:xProfileId
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.OnboardingApi()
var body = ; // {{PostVectorDataMappingJobPayload}} Submit new Job payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postMappingJob1(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postMappingJob1Example
    {
        public void main()
        {


            var apiInstance = new OnboardingApi();
            var body = new PostVectorDataMappingJobPayload(); // PostVectorDataMappingJobPayload | Submit new Job payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Post Job payload
                JobResponse result = apiInstance.postMappingJob1(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OnboardingApi.postMappingJob1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiOnboardingApi();
$body = ; // PostVectorDataMappingJobPayload | Submit new Job payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->postMappingJob1($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OnboardingApi->postMappingJob1: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::OnboardingApi;


my $api_instance = WWW::SwaggerClient::OnboardingApi->new();
my $body = WWW::SwaggerClient::Object::PostVectorDataMappingJobPayload->new(); # PostVectorDataMappingJobPayload | Submit new Job payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->postMappingJob1(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling OnboardingApi->postMappingJob1: $@\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.OnboardingApi()
body =  # PostVectorDataMappingJobPayload | Submit new Job payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Post Job payload
    api_response = api_instance.post_mapping_job1(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OnboardingApi->postMappingJob1: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 202 - HTTP 202 Job successfully created

Schema

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Registry

getRegistryModelForLayerId

Get Analytic Model

Return an analytic model for given LayerId

/field/layer/registry/{layer}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/layer/registry/{layer}?locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RegistryApi;

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

public class RegistryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RegistryApi apiInstance = new RegistryApi();
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String locale = locale_example; // String | Return display strings appropriate to a locale
        try {
            IModel result = apiInstance.getRegistryModelForLayerId(layer, xProfileId, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryModelForLayerId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RegistryApi;

public class RegistryApiExample {

    public static void main(String[] args) {
        RegistryApi apiInstance = new RegistryApi();
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String locale = locale_example; // String | Return display strings appropriate to a locale
        try {
            IModel result = apiInstance.getRegistryModelForLayerId(layer, xProfileId, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryModelForLayerId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *layer = layer_example; // Image Layer type
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *locale = locale_example; // Return display strings appropriate to a locale (optional)

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

// Get Analytic Model
[apiInstance getRegistryModelForLayerIdWith:layer
    xProfileId:xProfileId
    locale:locale
              completionHandler: ^(IModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.RegistryApi()
var layer = layer_example; // {{String}} Image Layer type
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'locale': locale_example // {{String}} Return display strings appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegistryModelForLayerId(layer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegistryModelForLayerIdExample
    {
        public void main()
        {


            var apiInstance = new RegistryApi();
            var layer = layer_example;  // String | Image Layer type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var locale = locale_example;  // String | Return display strings appropriate to a locale (optional) 

            try
            {
                // Get Analytic Model
                IModel result = apiInstance.getRegistryModelForLayerId(layer, xProfileId, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RegistryApi.getRegistryModelForLayerId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRegistryApi();
$layer = layer_example; // String | Image Layer type
$xProfileId = xProfileId_example; // String | Profile Id
$locale = locale_example; // String | Return display strings appropriate to a locale

try {
    $result = $api_instance->getRegistryModelForLayerId($layer, $xProfileId, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegistryApi->getRegistryModelForLayerId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RegistryApi;


my $api_instance = WWW::SwaggerClient::RegistryApi->new();
my $layer = layer_example; # String | Image Layer type
my $xProfileId = xProfileId_example; # String | Profile Id
my $locale = locale_example; # String | Return display strings appropriate to a locale

eval { 
    my $result = $api_instance->getRegistryModelForLayerId(layer => $layer, xProfileId => $xProfileId, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegistryApi->getRegistryModelForLayerId: $@\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.RegistryApi()
layer = layer_example # String | Image Layer type
xProfileId = xProfileId_example # String | Profile Id (optional)
locale = locale_example # String | Return display strings appropriate to a locale (optional)

try: 
    # Get Analytic Model
    api_response = api_instance.get_registry_model_for_layer_id(layer, xProfileId=xProfileId, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegistryApi->getRegistryModelForLayerId: %s\n" % e)

Parameters

Path parameters

Name	Description
layer*	String Image Layer type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
locale	String Return display strings appropriate to a locale

Responses

Status: 200 - HTTP 200 Model registry successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getRegistryModels

Get Model Registries

Return the list of analytic Model registries for an organisation

/field/layer/registry

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/layer/registry?cropType=&modelType=&locale="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RegistryApi;

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

public class RegistryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RegistryApi apiInstance = new RegistryApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String cropType = cropType_example; // String | Crop specific analytic
        String modelType = modelType_example; // String | Return analytic models matching supplied model type
        String locale = locale_example; // String | Return display strings appropriate to a locale
        try {
            IModel result = apiInstance.getRegistryModels(xProfileId, cropType, modelType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryModels");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RegistryApi;

public class RegistryApiExample {

    public static void main(String[] args) {
        RegistryApi apiInstance = new RegistryApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String cropType = cropType_example; // String | Crop specific analytic
        String modelType = modelType_example; // String | Return analytic models matching supplied model type
        String locale = locale_example; // String | Return display strings appropriate to a locale
        try {
            IModel result = apiInstance.getRegistryModels(xProfileId, cropType, modelType, locale);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryModels");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *cropType = cropType_example; // Crop specific analytic (optional)
String *modelType = modelType_example; // Return analytic models matching supplied model type (optional)
String *locale = locale_example; // Return display strings appropriate to a locale (optional)

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

// Get Model Registries
[apiInstance getRegistryModelsWith:xProfileId
    cropType:cropType
    modelType:modelType
    locale:locale
              completionHandler: ^(IModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.RegistryApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'cropType': cropType_example, // {{String}} Crop specific analytic
  'modelType': modelType_example, // {{String}} Return analytic models matching supplied model type
  'locale': locale_example // {{String}} Return display strings appropriate to a locale
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegistryModels(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegistryModelsExample
    {
        public void main()
        {


            var apiInstance = new RegistryApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var cropType = cropType_example;  // String | Crop specific analytic (optional) 
            var modelType = modelType_example;  // String | Return analytic models matching supplied model type (optional) 
            var locale = locale_example;  // String | Return display strings appropriate to a locale (optional) 

            try
            {
                // Get Model Registries
                IModel result = apiInstance.getRegistryModels(xProfileId, cropType, modelType, locale);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RegistryApi.getRegistryModels: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRegistryApi();
$xProfileId = xProfileId_example; // String | Profile Id
$cropType = cropType_example; // String | Crop specific analytic
$modelType = modelType_example; // String | Return analytic models matching supplied model type
$locale = locale_example; // String | Return display strings appropriate to a locale

try {
    $result = $api_instance->getRegistryModels($xProfileId, $cropType, $modelType, $locale);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegistryApi->getRegistryModels: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RegistryApi;


my $api_instance = WWW::SwaggerClient::RegistryApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $cropType = cropType_example; # String | Crop specific analytic
my $modelType = modelType_example; # String | Return analytic models matching supplied model type
my $locale = locale_example; # String | Return display strings appropriate to a locale

eval { 
    my $result = $api_instance->getRegistryModels(xProfileId => $xProfileId, cropType => $cropType, modelType => $modelType, locale => $locale);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegistryApi->getRegistryModels: $@\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.RegistryApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
cropType = cropType_example # String | Crop specific analytic (optional)
modelType = modelType_example # String | Return analytic models matching supplied model type (optional)
locale = locale_example # String | Return display strings appropriate to a locale (optional)

try: 
    # Get Model Registries
    api_response = api_instance.get_registry_models(xProfileId=xProfileId, cropType=cropType, modelType=modelType, locale=locale)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegistryApi->getRegistryModels: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
cropType	String Crop specific analytic
modelType	String Return analytic models matching supplied model type
locale	String Return display strings appropriate to a locale

Responses

Status: 200 - HTTP 200 Model registry successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getRegistryTypes

Get Registry types

Return the list of known model registry types

/field/layer/registry/types

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/layer/registry/types"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RegistryApi;

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

public class RegistryApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        RegistryApi apiInstance = new RegistryApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            IModel result = apiInstance.getRegistryTypes(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryTypes");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.RegistryApi;

public class RegistryApiExample {

    public static void main(String[] args) {
        RegistryApi apiInstance = new RegistryApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            IModel result = apiInstance.getRegistryTypes(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RegistryApi#getRegistryTypes");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get Registry types
[apiInstance getRegistryTypesWith:xProfileId
              completionHandler: ^(IModel output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.RegistryApi()
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRegistryTypes(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getRegistryTypesExample
    {
        public void main()
        {


            var apiInstance = new RegistryApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get Registry types
                IModel result = apiInstance.getRegistryTypes(xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RegistryApi.getRegistryTypes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiRegistryApi();
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getRegistryTypes($xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RegistryApi->getRegistryTypes: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::RegistryApi;


my $api_instance = WWW::SwaggerClient::RegistryApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getRegistryTypes(xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RegistryApi->getRegistryTypes: $@\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.RegistryApi()
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get Registry types
    api_response = api_instance.get_registry_types(xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RegistryApi->getRegistryTypes: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 Model registry types successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Report

getData

Get Report Job Data

/report/{jobId}/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//report/{jobId}/data?zip=&format="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReportApi apiInstance = new ReportApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean zip = true; // Boolean | Get zipped report
        String format = format_example; // String | Get geojson or csv format of the report
        try {
            JobResponse result = apiInstance.getData(jobId, xProfileId, zip, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean zip = true; // Boolean | Get zipped report
        String format = format_example; // String | Get geojson or csv format of the report
        try {
            JobResponse result = apiInstance.getData(jobId, xProfileId, zip, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobId = jobId_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *zip = true; // Get zipped report (optional) (default to false)
String *format = format_example; // Get geojson or csv format of the report (optional)

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

// Get Report Job Data
[apiInstance getDataWith:jobId
    xProfileId:xProfileId
    zip:zip
    format:format
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ReportApi()
var jobId = jobId_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'zip': true, // {{Boolean}} Get zipped report
  'format': format_example // {{String}} Get geojson or csv format of the report
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getData(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getDataExample
    {
        public void main()
        {


            var apiInstance = new ReportApi();
            var jobId = jobId_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var zip = true;  // Boolean | Get zipped report (optional)  (default to false)
            var format = format_example;  // String | Get geojson or csv format of the report (optional) 

            try
            {
                // Get Report Job Data
                JobResponse result = apiInstance.getData(jobId, xProfileId, zip, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReportApi();
$jobId = jobId_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id
$zip = true; // Boolean | Get zipped report
$format = format_example; // String | Get geojson or csv format of the report

try {
    $result = $api_instance->getData($jobId, $xProfileId, $zip, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;


my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $jobId = jobId_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id
my $zip = true; # Boolean | Get zipped report
my $format = format_example; # String | Get geojson or csv format of the report

eval { 
    my $result = $api_instance->getData(jobId => $jobId, xProfileId => $xProfileId, zip => $zip, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getData: $@\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.ReportApi()
jobId = jobId_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)
zip = true # Boolean | Get zipped report (optional) (default to false)
format = format_example # String | Get geojson or csv format of the report (optional)

try: 
    # Get Report Job Data
    api_response = api_instance.get_data(jobId, xProfileId=xProfileId, zip=zip, format=format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getData: %s\n" % e)

Parameters

Path parameters

Name	Description
jobId*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
zip	Boolean Get zipped report
format	String Get geojson or csv format of the report

Responses

Status: 200 - HTTP 200 Job status successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

getReportJobStatus

Get Report Job Status

/report/{jobId}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//report/{jobId}/status?includeStage="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReportApi apiInstance = new ReportApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeStage = true; // Boolean | Include stages - Return status with a list of stages
        try {
            JobResponse result = apiInstance.getReportJobStatus(jobId, xProfileId, includeStage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getReportJobStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeStage = true; // Boolean | Include stages - Return status with a list of stages
        try {
            JobResponse result = apiInstance.getReportJobStatus(jobId, xProfileId, includeStage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getReportJobStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobId = jobId_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *includeStage = true; // Include stages - Return status with a list of stages (optional) (default to false)

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

// Get Report Job Status
[apiInstance getReportJobStatusWith:jobId
    xProfileId:xProfileId
    includeStage:includeStage
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ReportApi()
var jobId = jobId_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'includeStage': true // {{Boolean}} Include stages - Return status with a list of stages
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getReportJobStatus(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getReportJobStatusExample
    {
        public void main()
        {


            var apiInstance = new ReportApi();
            var jobId = jobId_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var includeStage = true;  // Boolean | Include stages - Return status with a list of stages (optional)  (default to false)

            try
            {
                // Get Report Job Status
                JobResponse result = apiInstance.getReportJobStatus(jobId, xProfileId, includeStage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getReportJobStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReportApi();
$jobId = jobId_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id
$includeStage = true; // Boolean | Include stages - Return status with a list of stages

try {
    $result = $api_instance->getReportJobStatus($jobId, $xProfileId, $includeStage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->getReportJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;


my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $jobId = jobId_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id
my $includeStage = true; # Boolean | Include stages - Return status with a list of stages

eval { 
    my $result = $api_instance->getReportJobStatus(jobId => $jobId, xProfileId => $xProfileId, includeStage => $includeStage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->getReportJobStatus: $@\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.ReportApi()
jobId = jobId_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)
includeStage = true # Boolean | Include stages - Return status with a list of stages (optional) (default to false)

try: 
    # Get Report Job Status
    api_response = api_instance.get_report_job_status(jobId, xProfileId=xProfileId, includeStage=includeStage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->getReportJobStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
jobId*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
includeStage	Boolean Include stages - Return status with a list of stages

Responses

Status: 200 - HTTP 200 Job status successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

postReportJob

Post Report Job payload

/report/job

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//report/job"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ReportApi apiInstance = new ReportApi();
        PostReportPayload body = ; // PostReportPayload | Submit new Report payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postReportJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#postReportJob");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ReportApi;

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        PostReportPayload body = ; // PostReportPayload | Submit new Report payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            JobResponse result = apiInstance.postReportJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#postReportJob");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
PostReportPayload *body = ; // Submit new Report payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Post Report Job payload
[apiInstance postReportJobWith:body
    xProfileId:xProfileId
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ReportApi()
var body = ; // {{PostReportPayload}} Submit new Report payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postReportJob(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postReportJobExample
    {
        public void main()
        {


            var apiInstance = new ReportApi();
            var body = new PostReportPayload(); // PostReportPayload | Submit new Report payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Post Report Job payload
                JobResponse result = apiInstance.postReportJob(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.postReportJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiReportApi();
$body = ; // PostReportPayload | Submit new Report payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->postReportJob($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportApi->postReportJob: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ReportApi;


my $api_instance = WWW::SwaggerClient::ReportApi->new();
my $body = WWW::SwaggerClient::Object::PostReportPayload->new(); # PostReportPayload | Submit new Report payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->postReportJob(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ReportApi->postReportJob: $@\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.ReportApi()
body =  # PostReportPayload | Submit new Report payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Post Report Job payload
    api_response = api_instance.post_report_job(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ReportApi->postReportJob: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 202 - HTTP 202 Job successfully created

Schema

Status: 302 - HTTP 302 Uncompleted job found

Schema

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Scalars

createScalarAssetMapping

Save the scalar asset mapping

/scalar/assetmapping

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//scalar/assetmapping?includeInfo=&refreshMaterializedView="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        ScalarAssetMappingPayload body = ; // ScalarAssetMappingPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeInfo = true; // Boolean | Include results in the response
        Boolean refreshMaterializedView = true; // Boolean | Refresh the materialized view to update values
        try {
            ScalarAssetMappingResponse result = apiInstance.createScalarAssetMapping(body, xProfileId, includeInfo, refreshMaterializedView);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarAssetMapping");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        ScalarAssetMappingPayload body = ; // ScalarAssetMappingPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeInfo = true; // Boolean | Include results in the response
        Boolean refreshMaterializedView = true; // Boolean | Refresh the materialized view to update values
        try {
            ScalarAssetMappingResponse result = apiInstance.createScalarAssetMapping(body, xProfileId, includeInfo, refreshMaterializedView);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarAssetMapping");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
ScalarAssetMappingPayload *body = ; // 
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *includeInfo = true; // Include results in the response (optional) (default to false)
Boolean *refreshMaterializedView = true; // Refresh the materialized view to update values (optional) (default to false)

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

// Save the scalar asset mapping
[apiInstance createScalarAssetMappingWith:body
    xProfileId:xProfileId
    includeInfo:includeInfo
    refreshMaterializedView:refreshMaterializedView
              completionHandler: ^(ScalarAssetMappingResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var body = ; // {{ScalarAssetMappingPayload}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'includeInfo': true // {{Boolean}} Include results in the response
  'refreshMaterializedView': true // {{Boolean}} Refresh the materialized view to update values
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScalarAssetMapping(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScalarAssetMappingExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var body = new ScalarAssetMappingPayload(); // ScalarAssetMappingPayload | 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var includeInfo = true;  // Boolean | Include results in the response (optional)  (default to false)
            var refreshMaterializedView = true;  // Boolean | Refresh the materialized view to update values (optional)  (default to false)

            try
            {
                // Save the scalar asset mapping
                ScalarAssetMappingResponse result = apiInstance.createScalarAssetMapping(body, xProfileId, includeInfo, refreshMaterializedView);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.createScalarAssetMapping: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$body = ; // ScalarAssetMappingPayload | 
$xProfileId = xProfileId_example; // String | Profile Id
$includeInfo = true; // Boolean | Include results in the response
$refreshMaterializedView = true; // Boolean | Refresh the materialized view to update values

try {
    $result = $api_instance->createScalarAssetMapping($body, $xProfileId, $includeInfo, $refreshMaterializedView);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->createScalarAssetMapping: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $body = WWW::SwaggerClient::Object::ScalarAssetMappingPayload->new(); # ScalarAssetMappingPayload | 
my $xProfileId = xProfileId_example; # String | Profile Id
my $includeInfo = true; # Boolean | Include results in the response
my $refreshMaterializedView = true; # Boolean | Refresh the materialized view to update values

eval { 
    my $result = $api_instance->createScalarAssetMapping(body => $body, xProfileId => $xProfileId, includeInfo => $includeInfo, refreshMaterializedView => $refreshMaterializedView);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->createScalarAssetMapping: $@\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.ScalarsApi()
body =  # ScalarAssetMappingPayload | 
xProfileId = xProfileId_example # String | Profile Id (optional)
includeInfo = true # Boolean | Include results in the response (optional) (default to false)
refreshMaterializedView = true # Boolean | Refresh the materialized view to update values (optional) (default to false)

try: 
    # Save the scalar asset mapping
    api_response = api_instance.create_scalar_asset_mapping(body, xProfileId=xProfileId, includeInfo=includeInfo, refreshMaterializedView=refreshMaterializedView)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->createScalarAssetMapping: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
includeInfo	Boolean Include results in the response
refreshMaterializedView	Boolean Refresh the materialized view to update values

Responses

Status: 201 - HTTP 201 - Scalar Assset Mapping is saved successfully

Schema

Status: 400 - HTTP 400 - Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 409 - HTTP 409 - Entity with same id already exists

Schema

Status: 503 - HTTP 503 - Unable to communicate with Field Profile Service

Schema

createScalarData

Save the scalar datum

/scalar/data

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//scalar/data?includeInfo=&reuseIfPresent=&computationKey="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        ScalarDataPayload body = ; // ScalarDataPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeInfo = true; // Boolean | Include results in the response
        Boolean reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
        String computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data
        try {
            ScalarDataResponse result = apiInstance.createScalarData(body, xProfileId, includeInfo, reuseIfPresent, computationKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        ScalarDataPayload body = ; // ScalarDataPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeInfo = true; // Boolean | Include results in the response
        Boolean reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
        String computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data
        try {
            ScalarDataResponse result = apiInstance.createScalarData(body, xProfileId, includeInfo, reuseIfPresent, computationKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
ScalarDataPayload *body = ; // 
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *includeInfo = true; // Include results in the response (optional) (default to false)
Boolean *reuseIfPresent = true; // Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional) (default to false)
String *computationKey = computationKey_example; // ComputationKey to distinguish between multiple computation of the same analytic data (optional)

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

// Save the scalar datum
[apiInstance createScalarDataWith:body
    xProfileId:xProfileId
    includeInfo:includeInfo
    reuseIfPresent:reuseIfPresent
    computationKey:computationKey
              completionHandler: ^(ScalarDataResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var body = ; // {{ScalarDataPayload}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'includeInfo': true // {{Boolean}} Include results in the response
  'reuseIfPresent': true // {{Boolean}} Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
  'computationKey': computationKey_example // {{String}} ComputationKey to distinguish between multiple computation of the same analytic data
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScalarData(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScalarDataExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var body = new ScalarDataPayload(); // ScalarDataPayload | 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var includeInfo = true;  // Boolean | Include results in the response (optional)  (default to false)
            var reuseIfPresent = true;  // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional)  (default to false)
            var computationKey = computationKey_example;  // String | ComputationKey to distinguish between multiple computation of the same analytic data (optional) 

            try
            {
                // Save the scalar datum
                ScalarDataResponse result = apiInstance.createScalarData(body, xProfileId, includeInfo, reuseIfPresent, computationKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.createScalarData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$body = ; // ScalarDataPayload | 
$xProfileId = xProfileId_example; // String | Profile Id
$includeInfo = true; // Boolean | Include results in the response
$reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
$computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data

try {
    $result = $api_instance->createScalarData($body, $xProfileId, $includeInfo, $reuseIfPresent, $computationKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->createScalarData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $body = WWW::SwaggerClient::Object::ScalarDataPayload->new(); # ScalarDataPayload | 
my $xProfileId = xProfileId_example; # String | Profile Id
my $includeInfo = true; # Boolean | Include results in the response
my $reuseIfPresent = true; # Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
my $computationKey = computationKey_example; # String | ComputationKey to distinguish between multiple computation of the same analytic data

eval { 
    my $result = $api_instance->createScalarData(body => $body, xProfileId => $xProfileId, includeInfo => $includeInfo, reuseIfPresent => $reuseIfPresent, computationKey => $computationKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->createScalarData: $@\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.ScalarsApi()
body =  # ScalarDataPayload | 
xProfileId = xProfileId_example # String | Profile Id (optional)
includeInfo = true # Boolean | Include results in the response (optional) (default to false)
reuseIfPresent = true # Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional) (default to false)
computationKey = computationKey_example # String | ComputationKey to distinguish between multiple computation of the same analytic data (optional)

try: 
    # Save the scalar datum
    api_response = api_instance.create_scalar_data(body, xProfileId=xProfileId, includeInfo=includeInfo, reuseIfPresent=reuseIfPresent, computationKey=computationKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->createScalarData: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
includeInfo	Boolean Include results in the response
reuseIfPresent	Boolean Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
computationKey	String ComputationKey to distinguish between multiple computation of the same analytic data

Responses

Status: 201 - HTTP 201 - Scalar Type is saved successfully

Schema

Status: 400 - HTTP 400 - Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 409 - HTTP 409 - Entity with same id already exists

Schema

Status: 503 - HTTP 503 - Unable to communicate with Field Profile Service

Schema

createScalarDataBatch

Save the scalar datum

/scalar/data/batch

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//scalar/data/batch?reuseIfPresent=&computationKey="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        ScalarDataBatchPayload body = ; // ScalarDataBatchPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
        String computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data
        try {
            ScalarDataResponse result = apiInstance.createScalarDataBatch(body, xProfileId, reuseIfPresent, computationKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarDataBatch");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        ScalarDataBatchPayload body = ; // ScalarDataBatchPayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
        String computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data
        try {
            ScalarDataResponse result = apiInstance.createScalarDataBatch(body, xProfileId, reuseIfPresent, computationKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarDataBatch");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
ScalarDataBatchPayload *body = ; // 
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *reuseIfPresent = true; // Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional) (default to false)
String *computationKey = computationKey_example; // ComputationKey to distinguish between multiple computation of the same analytic data (optional)

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

// Save the scalar datum
[apiInstance createScalarDataBatchWith:body
    xProfileId:xProfileId
    reuseIfPresent:reuseIfPresent
    computationKey:computationKey
              completionHandler: ^(ScalarDataResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var body = ; // {{ScalarDataBatchPayload}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'reuseIfPresent': true // {{Boolean}} Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
  'computationKey': computationKey_example // {{String}} ComputationKey to distinguish between multiple computation of the same analytic data
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScalarDataBatch(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScalarDataBatchExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var body = new ScalarDataBatchPayload(); // ScalarDataBatchPayload | 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var reuseIfPresent = true;  // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional)  (default to false)
            var computationKey = computationKey_example;  // String | ComputationKey to distinguish between multiple computation of the same analytic data (optional) 

            try
            {
                // Save the scalar datum
                ScalarDataResponse result = apiInstance.createScalarDataBatch(body, xProfileId, reuseIfPresent, computationKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.createScalarDataBatch: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$body = ; // ScalarDataBatchPayload | 
$xProfileId = xProfileId_example; // String | Profile Id
$reuseIfPresent = true; // Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
$computationKey = computationKey_example; // String | ComputationKey to distinguish between multiple computation of the same analytic data

try {
    $result = $api_instance->createScalarDataBatch($body, $xProfileId, $reuseIfPresent, $computationKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->createScalarDataBatch: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $body = WWW::SwaggerClient::Object::ScalarDataBatchPayload->new(); # ScalarDataBatchPayload | 
my $xProfileId = xProfileId_example; # String | Profile Id
my $reuseIfPresent = true; # Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
my $computationKey = computationKey_example; # String | ComputationKey to distinguish between multiple computation of the same analytic data

eval { 
    my $result = $api_instance->createScalarDataBatch(body => $body, xProfileId => $xProfileId, reuseIfPresent => $reuseIfPresent, computationKey => $computationKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->createScalarDataBatch: $@\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.ScalarsApi()
body =  # ScalarDataBatchPayload | 
xProfileId = xProfileId_example # String | Profile Id (optional)
reuseIfPresent = true # Boolean | Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value (optional) (default to false)
computationKey = computationKey_example # String | ComputationKey to distinguish between multiple computation of the same analytic data (optional)

try: 
    # Save the scalar datum
    api_response = api_instance.create_scalar_data_batch(body, xProfileId=xProfileId, reuseIfPresent=reuseIfPresent, computationKey=computationKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->createScalarDataBatch: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
reuseIfPresent	Boolean Try to reuse an already created scalar data with same layerTableId,scalarTypeId,value
computationKey	String ComputationKey to distinguish between multiple computation of the same analytic data

Responses

Status: 202 - HTTP 202 - Batch scalars accepted

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

createScalarTypes

Save the scalar type

/scalar/type

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//scalar/type?checkIfExists=&includeInfo="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        ScalarTypePayload body = ; // ScalarTypePayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean checkIfExists = true; // Boolean | Check if Scalar type already exists
        Boolean includeInfo = true; // Boolean | Include results in the response
        try {
            ScalarTypeResponse result = apiInstance.createScalarTypes(body, xProfileId, checkIfExists, includeInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarTypes");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        ScalarTypePayload body = ; // ScalarTypePayload | 
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean checkIfExists = true; // Boolean | Check if Scalar type already exists
        Boolean includeInfo = true; // Boolean | Include results in the response
        try {
            ScalarTypeResponse result = apiInstance.createScalarTypes(body, xProfileId, checkIfExists, includeInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#createScalarTypes");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
ScalarTypePayload *body = ; // 
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *checkIfExists = true; // Check if Scalar type already exists (optional) (default to false)
Boolean *includeInfo = true; // Include results in the response (optional) (default to false)

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

// Save the scalar type
[apiInstance createScalarTypesWith:body
    xProfileId:xProfileId
    checkIfExists:checkIfExists
    includeInfo:includeInfo
              completionHandler: ^(ScalarTypeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var body = ; // {{ScalarTypePayload}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'checkIfExists': true // {{Boolean}} Check if Scalar type already exists
  'includeInfo': true // {{Boolean}} Include results in the response
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createScalarTypes(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createScalarTypesExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var body = new ScalarTypePayload(); // ScalarTypePayload | 
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var checkIfExists = true;  // Boolean | Check if Scalar type already exists (optional)  (default to false)
            var includeInfo = true;  // Boolean | Include results in the response (optional)  (default to false)

            try
            {
                // Save the scalar type
                ScalarTypeResponse result = apiInstance.createScalarTypes(body, xProfileId, checkIfExists, includeInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.createScalarTypes: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$body = ; // ScalarTypePayload | 
$xProfileId = xProfileId_example; // String | Profile Id
$checkIfExists = true; // Boolean | Check if Scalar type already exists
$includeInfo = true; // Boolean | Include results in the response

try {
    $result = $api_instance->createScalarTypes($body, $xProfileId, $checkIfExists, $includeInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->createScalarTypes: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $body = WWW::SwaggerClient::Object::ScalarTypePayload->new(); # ScalarTypePayload | 
my $xProfileId = xProfileId_example; # String | Profile Id
my $checkIfExists = true; # Boolean | Check if Scalar type already exists
my $includeInfo = true; # Boolean | Include results in the response

eval { 
    my $result = $api_instance->createScalarTypes(body => $body, xProfileId => $xProfileId, checkIfExists => $checkIfExists, includeInfo => $includeInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->createScalarTypes: $@\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.ScalarsApi()
body =  # ScalarTypePayload | 
xProfileId = xProfileId_example # String | Profile Id (optional)
checkIfExists = true # Boolean | Check if Scalar type already exists (optional) (default to false)
includeInfo = true # Boolean | Include results in the response (optional) (default to false)

try: 
    # Save the scalar type
    api_response = api_instance.create_scalar_types(body, xProfileId=xProfileId, checkIfExists=checkIfExists, includeInfo=includeInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->createScalarTypes: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
checkIfExists	Boolean Check if Scalar type already exists
includeInfo	Boolean Include results in the response

Responses

Status: 201 - HTTP 201 - Scalar Type is saved successfully

Schema

Status: 400 - HTTP 400 - Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 409 - HTTP 409 - Entity with same id already exists

Schema

Status: 503 - HTTP 503 - Unable to communicate with Field Profile Service

Schema

deleteScalarType

Delete a Scalar type

Delete a scalar type by id

/scalar/type/{uuid}

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//scalar/type/{uuid}"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        String uuid = uuid_example; // String | Uniq UUID of the Scalar Type
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarTypeResponse result = apiInstance.deleteScalarType(uuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#deleteScalarType");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        String uuid = uuid_example; // String | Uniq UUID of the Scalar Type
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarTypeResponse result = apiInstance.deleteScalarType(uuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#deleteScalarType");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *uuid = uuid_example; // Uniq UUID of the Scalar Type
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Delete a Scalar type
[apiInstance deleteScalarTypeWith:uuid
    xProfileId:xProfileId
              completionHandler: ^(ScalarTypeResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var uuid = uuid_example; // {{String}} Uniq UUID of the Scalar Type
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteScalarType(uuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteScalarTypeExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var uuid = uuid_example;  // String | Uniq UUID of the Scalar Type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Delete a Scalar type
                ScalarTypeResponse result = apiInstance.deleteScalarType(uuid, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.deleteScalarType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$uuid = uuid_example; // String | Uniq UUID of the Scalar Type
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->deleteScalarType($uuid, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->deleteScalarType: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $uuid = uuid_example; # String | Uniq UUID of the Scalar Type
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->deleteScalarType(uuid => $uuid, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->deleteScalarType: $@\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.ScalarsApi()
uuid = uuid_example # String | Uniq UUID of the Scalar Type
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Delete a Scalar type
    api_response = api_instance.delete_scalar_type(uuid, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->deleteScalarType: %s\n" % e)

Parameters

Path parameters

Name	Description
uuid*	String Uniq UUID of the Scalar Type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 - DELETE finished successfully

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 503 - HTTP 503 - Unable to communicate with Field Profile Service

Schema

getScalarAssetMappings

Get the scalar asset mappings

/scalar/assetmapping

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//scalar/assetmapping?assetUuid="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        try {
            ScalarAssetMappingResPayload result = apiInstance.getScalarAssetMappings(xProfileId, assetUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarAssetMappings");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String assetUuid = assetUuid_example; // String | Unique asset Uuid
        try {
            ScalarAssetMappingResPayload result = apiInstance.getScalarAssetMappings(xProfileId, assetUuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarAssetMappings");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *assetUuid = assetUuid_example; // Unique asset Uuid (optional)

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

// Get the scalar asset mappings
[apiInstance getScalarAssetMappingsWith:xProfileId
    assetUuid:assetUuid
              completionHandler: ^(ScalarAssetMappingResPayload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'assetUuid': assetUuid_example // {{String}} Unique asset Uuid
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScalarAssetMappings(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScalarAssetMappingsExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var assetUuid = assetUuid_example;  // String | Unique asset Uuid (optional) 

            try
            {
                // Get the scalar asset mappings
                ScalarAssetMappingResPayload result = apiInstance.getScalarAssetMappings(xProfileId, assetUuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.getScalarAssetMappings: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$assetUuid = assetUuid_example; // String | Unique asset Uuid

try {
    $result = $api_instance->getScalarAssetMappings($xProfileId, $assetUuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->getScalarAssetMappings: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $assetUuid = assetUuid_example; # String | Unique asset Uuid

eval { 
    my $result = $api_instance->getScalarAssetMappings(xProfileId => $xProfileId, assetUuid => $assetUuid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->getScalarAssetMappings: $@\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.ScalarsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
assetUuid = assetUuid_example # String | Unique asset Uuid (optional)

try: 
    # Get the scalar asset mappings
    api_response = api_instance.get_scalar_asset_mappings(xProfileId=xProfileId, assetUuid=assetUuid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->getScalarAssetMappings: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
assetUuid	String Unique asset Uuid

Responses

Status: 200 - HTTP 200 - scalar asset mapping returned successfully

Schema

Status: 400 - HTTP 400 - Invalid asset UUID supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getScalarData

Get the scalar data

/scalar/data

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//scalar/data"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarDataPayload result = apiInstance.getScalarData(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarData");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarDataPayload result = apiInstance.getScalarData(xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarData");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Get the scalar data
[apiInstance getScalarDataWith:xProfileId
              completionHandler: ^(ScalarDataPayload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScalarData(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScalarDataExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Get the scalar data
                ScalarDataPayload result = apiInstance.getScalarData(xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.getScalarData: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getScalarData($xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->getScalarData: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getScalarData(xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->getScalarData: $@\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.ScalarsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Get the scalar data
    api_response = api_instance.get_scalar_data(xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->getScalarData: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 200 - HTTP 200 - scalar data returned successfully

Schema

Status: 400 - HTTP 400 - Invalid asset UUID supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getScalarJobStatus

Get Scalar Job Status

/scalar/analytics/{jobId}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//scalar/analytics/{jobId}/status?includeStage="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeStage = true; // Boolean | Include stages - Return status with a list of stages
        try {
            JobResponse result = apiInstance.getScalarJobStatus(jobId, xProfileId, includeStage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarJobStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        String jobId = jobId_example; // String | Unique Job Id
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean includeStage = true; // Boolean | Include stages - Return status with a list of stages
        try {
            JobResponse result = apiInstance.getScalarJobStatus(jobId, xProfileId, includeStage);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarJobStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobId = jobId_example; // Unique Job Id
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *includeStage = true; // Include stages - Return status with a list of stages (optional) (default to false)

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

// Get Scalar Job Status
[apiInstance getScalarJobStatusWith:jobId
    xProfileId:xProfileId
    includeStage:includeStage
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var jobId = jobId_example; // {{String}} Unique Job Id
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'includeStage': true // {{Boolean}} Include stages - Return status with a list of stages
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScalarJobStatus(jobId, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScalarJobStatusExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var jobId = jobId_example;  // String | Unique Job Id
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var includeStage = true;  // Boolean | Include stages - Return status with a list of stages (optional)  (default to false)

            try
            {
                // Get Scalar Job Status
                JobResponse result = apiInstance.getScalarJobStatus(jobId, xProfileId, includeStage);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.getScalarJobStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$jobId = jobId_example; // String | Unique Job Id
$xProfileId = xProfileId_example; // String | Profile Id
$includeStage = true; // Boolean | Include stages - Return status with a list of stages

try {
    $result = $api_instance->getScalarJobStatus($jobId, $xProfileId, $includeStage);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->getScalarJobStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $jobId = jobId_example; # String | Unique Job Id
my $xProfileId = xProfileId_example; # String | Profile Id
my $includeStage = true; # Boolean | Include stages - Return status with a list of stages

eval { 
    my $result = $api_instance->getScalarJobStatus(jobId => $jobId, xProfileId => $xProfileId, includeStage => $includeStage);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->getScalarJobStatus: $@\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.ScalarsApi()
jobId = jobId_example # String | Unique Job Id
xProfileId = xProfileId_example # String | Profile Id (optional)
includeStage = true # Boolean | Include stages - Return status with a list of stages (optional) (default to false)

try: 
    # Get Scalar Job Status
    api_response = api_instance.get_scalar_job_status(jobId, xProfileId=xProfileId, includeStage=includeStage)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->getScalarJobStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
jobId*	String Unique Job Id Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
includeStage	Boolean Include stages - Return status with a list of stages

Responses

Status: 200 - HTTP 200 Job status successfully returned

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 Job not found

Schema

getScalarTypeByType

Get the scalar types

/scalar/type

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//scalar/type?type="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String type = type_example; // String | Scalar specific type[kpi,score,action]
        try {
            ScalarTypePayload result = apiInstance.getScalarTypeByType(xProfileId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarTypeByType");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String type = type_example; // String | Scalar specific type[kpi,score,action]
        try {
            ScalarTypePayload result = apiInstance.getScalarTypeByType(xProfileId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#getScalarTypeByType");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *type = type_example; // Scalar specific type[kpi,score,action] (optional)

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

// Get the scalar types
[apiInstance getScalarTypeByTypeWith:xProfileId
    type:type
              completionHandler: ^(ScalarTypePayload output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'type': type_example // {{String}} Scalar specific type[kpi,score,action]
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getScalarTypeByType(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getScalarTypeByTypeExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var type = type_example;  // String | Scalar specific type[kpi,score,action] (optional) 

            try
            {
                // Get the scalar types
                ScalarTypePayload result = apiInstance.getScalarTypeByType(xProfileId, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.getScalarTypeByType: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$type = type_example; // String | Scalar specific type[kpi,score,action]

try {
    $result = $api_instance->getScalarTypeByType($xProfileId, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->getScalarTypeByType: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $type = type_example; # String | Scalar specific type[kpi,score,action]

eval { 
    my $result = $api_instance->getScalarTypeByType(xProfileId => $xProfileId, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->getScalarTypeByType: $@\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.ScalarsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
type = type_example # String | Scalar specific type[kpi,score,action] (optional)

try: 
    # Get the scalar types
    api_response = api_instance.get_scalar_type_by_type(xProfileId=xProfileId, type=type)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->getScalarTypeByType: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
type	String Scalar specific type[kpi,score,action]

Responses

Status: 200 - HTTP 200 - scalar type returned successfully

Schema

Status: 400 - HTTP 400 - Invalid asset UUID supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

postScalarJob

Post scalar Job payload

Post Job payload

/scalar/analytics/job

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//scalar/analytics/job"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ScalarsApi;

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

public class ScalarsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        ScalarsApi apiInstance = new ScalarsApi();
        PostScalarPayload body = ; // PostScalarPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarJobListResponse result = apiInstance.postScalarJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#postScalarJob");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.ScalarsApi;

public class ScalarsApiExample {

    public static void main(String[] args) {
        ScalarsApi apiInstance = new ScalarsApi();
        PostScalarPayload body = ; // PostScalarPayload | Submit new Job payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            ScalarJobListResponse result = apiInstance.postScalarJob(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ScalarsApi#postScalarJob");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
PostScalarPayload *body = ; // Submit new Job payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Post scalar Job payload
[apiInstance postScalarJobWith:body
    xProfileId:xProfileId
              completionHandler: ^(ScalarJobListResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.ScalarsApi()
var body = ; // {{PostScalarPayload}} Submit new Job payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postScalarJob(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class postScalarJobExample
    {
        public void main()
        {


            var apiInstance = new ScalarsApi();
            var body = new PostScalarPayload(); // PostScalarPayload | Submit new Job payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Post scalar Job payload
                ScalarJobListResponse result = apiInstance.postScalarJob(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ScalarsApi.postScalarJob: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiScalarsApi();
$body = ; // PostScalarPayload | Submit new Job payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->postScalarJob($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ScalarsApi->postScalarJob: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ScalarsApi;


my $api_instance = WWW::SwaggerClient::ScalarsApi->new();
my $body = WWW::SwaggerClient::Object::PostScalarPayload->new(); # PostScalarPayload | Submit new Job payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->postScalarJob(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ScalarsApi->postScalarJob: $@\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.ScalarsApi()
body =  # PostScalarPayload | Submit new Job payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Post scalar Job payload
    api_response = api_instance.post_scalar_job(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ScalarsApi->postScalarJob: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 202 - HTTP 202 Job successfully created

Schema

Status: 302 - HTTP 302 uncompleted job found

Schema

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

State

getSubFieldStateExternal

Get current SubField state

Returns the current SubField profile state

/field/{fieldUuid}/subfield/{subFieldUuid}/state

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldUuid}/subfield/{subFieldUuid}/state?date="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StateApi;

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

public class StateApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StateApi apiInstance = new StateApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            StateResponse result = apiInstance.getSubFieldStateExternal(fieldUuid, subFieldUuid, xProfileId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StateApi#getSubFieldStateExternal");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.StateApi;

public class StateApiExample {

    public static void main(String[] args) {
        StateApi apiInstance = new StateApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
        UUID subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            StateResponse result = apiInstance.getSubFieldStateExternal(fieldUuid, subFieldUuid, xProfileId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StateApi#getSubFieldStateExternal");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field Uuid
UUID *subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)

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

// Get current SubField state
[apiInstance getSubFieldStateExternalWith:fieldUuid
    subFieldUuid:subFieldUuid
    xProfileId:xProfileId
    date:date
              completionHandler: ^(StateResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.StateApi()
var fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field Uuid
var subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField Uuid
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'date': date_example // {{String}} Query Date yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubFieldStateExternal(fieldUuid, subFieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSubFieldStateExternalExample
    {
        public void main()
        {


            var apiInstance = new StateApi();
            var fieldUuid = new UUID(); // UUID | Unique Field Uuid
            var subFieldUuid = new UUID(); // UUID | Unique SubField Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 

            try
            {
                // Get current SubField state
                StateResponse result = apiInstance.getSubFieldStateExternal(fieldUuid, subFieldUuid, xProfileId, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StateApi.getSubFieldStateExternal: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiStateApi();
$fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field Uuid
$subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField Uuid
$xProfileId = xProfileId_example; // String | Profile Id
$date = date_example; // String | Query Date yyyy-MM-dd

try {
    $result = $api_instance->getSubFieldStateExternal($fieldUuid, $subFieldUuid, $xProfileId, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StateApi->getSubFieldStateExternal: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StateApi;


my $api_instance = WWW::SwaggerClient::StateApi->new();
my $fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field Uuid
my $subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField Uuid
my $xProfileId = xProfileId_example; # String | Profile Id
my $date = date_example; # String | Query Date yyyy-MM-dd

eval { 
    my $result = $api_instance->getSubFieldStateExternal(fieldUuid => $fieldUuid, subFieldUuid => $subFieldUuid, xProfileId => $xProfileId, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StateApi->getSubFieldStateExternal: $@\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.StateApi()
fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field Uuid
subFieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)

try: 
    # Get current SubField state
    api_response = api_instance.get_sub_field_state_external(fieldUuid, subFieldUuid, xProfileId=xProfileId, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StateApi->getSubFieldStateExternal: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUID (uuid) Unique Field Uuid Required
subFieldUuid*	UUID (uuid) Unique SubField Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
date	String Query Date yyyy-MM-dd

Responses

Status: 200 - HTTP 200 SubField State Successfully Returned

Schema

Status: 400 - HTTP 400 Bad Organization Name Supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status

getLayerStatus

Get SubField Processing Status

Get the SubField processing status - by layer type, date, data range and/or processing status

/field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fielduuid}/subfield/{subfielduuid}/layer/{layer}/status?model=&status=&contextId=&date=&fromDate=&toDate="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.StatusApi;

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

public class StatusApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        StatusApi apiInstance = new StatusApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String model = model_example; // String | Image Layer Model Algorithm
        String status = status_example; // String | Layer Processing Status
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            StatusResponse result = apiInstance.getLayerStatus(fielduuid, subfielduuid, layer, xProfileId, model, status, contextId, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getLayerStatus");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.StatusApi;

public class StatusApiExample {

    public static void main(String[] args) {
        StatusApi apiInstance = new StatusApi();
        UUID fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String model = model_example; // String | Image Layer Model Algorithm
        String status = status_example; // String | Layer Processing Status
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        try {
            StatusResponse result = apiInstance.getLayerStatus(fielduuid, subfielduuid, layer, xProfileId, model, status, contextId, date, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling StatusApi#getLayerStatus");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique Field UUID
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *layer = layer_example; // Image Layer type
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *model = model_example; // Image Layer Model Algorithm (optional)
String *status = status_example; // Layer Processing Status (optional)
String *contextId = contextId_example; // Layer context ID (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)
String *fromDate = fromDate_example; // Query fromDate yyyy-MM-dd (optional)
String *toDate = toDate_example; // Query toDate yyyy-MM-dd (optional)

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

// Get SubField Processing Status
[apiInstance getLayerStatusWith:fielduuid
    subfielduuid:subfielduuid
    layer:layer
    xProfileId:xProfileId
    model:model
    status:status
    contextId:contextId
    date:date
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(StatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.StatusApi()
var fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique Field UUID
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var layer = layer_example; // {{String}} Image Layer type
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'model': model_example, // {{String}} Image Layer Model Algorithm
  'status': status_example, // {{String}} Layer Processing Status
  'contextId': contextId_example, // {{String}} Layer context ID
  'date': date_example, // {{String}} Query Date yyyy-MM-dd
  'fromDate': fromDate_example, // {{String}} Query fromDate yyyy-MM-dd
  'toDate': toDate_example // {{String}} Query toDate yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getLayerStatus(fielduuid, subfielduuid, layer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getLayerStatusExample
    {
        public void main()
        {


            var apiInstance = new StatusApi();
            var fielduuid = new UUID(); // UUID | Unique Field UUID
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var layer = layer_example;  // String | Image Layer type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var model = model_example;  // String | Image Layer Model Algorithm (optional) 
            var status = status_example;  // String | Layer Processing Status (optional) 
            var contextId = contextId_example;  // String | Layer context ID (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 
            var fromDate = fromDate_example;  // String | Query fromDate yyyy-MM-dd (optional) 
            var toDate = toDate_example;  // String | Query toDate yyyy-MM-dd (optional) 

            try
            {
                // Get SubField Processing Status
                StatusResponse result = apiInstance.getLayerStatus(fielduuid, subfielduuid, layer, xProfileId, model, status, contextId, date, fromDate, toDate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling StatusApi.getLayerStatus: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiStatusApi();
$fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique Field UUID
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$layer = layer_example; // String | Image Layer type
$xProfileId = xProfileId_example; // String | Profile Id
$model = model_example; // String | Image Layer Model Algorithm
$status = status_example; // String | Layer Processing Status
$contextId = contextId_example; // String | Layer context ID
$date = date_example; // String | Query Date yyyy-MM-dd
$fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
$toDate = toDate_example; // String | Query toDate yyyy-MM-dd

try {
    $result = $api_instance->getLayerStatus($fielduuid, $subfielduuid, $layer, $xProfileId, $model, $status, $contextId, $date, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StatusApi->getLayerStatus: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::StatusApi;


my $api_instance = WWW::SwaggerClient::StatusApi->new();
my $fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique Field UUID
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $layer = layer_example; # String | Image Layer type
my $xProfileId = xProfileId_example; # String | Profile Id
my $model = model_example; # String | Image Layer Model Algorithm
my $status = status_example; # String | Layer Processing Status
my $contextId = contextId_example; # String | Layer context ID
my $date = date_example; # String | Query Date yyyy-MM-dd
my $fromDate = fromDate_example; # String | Query fromDate yyyy-MM-dd
my $toDate = toDate_example; # String | Query toDate yyyy-MM-dd

eval { 
    my $result = $api_instance->getLayerStatus(fielduuid => $fielduuid, subfielduuid => $subfielduuid, layer => $layer, xProfileId => $xProfileId, model => $model, status => $status, contextId => $contextId, date => $date, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling StatusApi->getLayerStatus: $@\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.StatusApi()
fielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique Field UUID
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
layer = layer_example # String | Image Layer type
xProfileId = xProfileId_example # String | Profile Id (optional)
model = model_example # String | Image Layer Model Algorithm (optional)
status = status_example # String | Layer Processing Status (optional)
contextId = contextId_example # String | Layer context ID (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)
fromDate = fromDate_example # String | Query fromDate yyyy-MM-dd (optional)
toDate = toDate_example # String | Query toDate yyyy-MM-dd (optional)

try: 
    # Get SubField Processing Status
    api_response = api_instance.get_layer_status(fielduuid, subfielduuid, layer, xProfileId=xProfileId, model=model, status=status, contextId=contextId, date=date, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling StatusApi->getLayerStatus: %s\n" % e)

Parameters

Path parameters

Name	Description
fielduuid*	UUID (uuid) Unique Field UUID Required
subfielduuid*	UUID (uuid) Unique SubField UUID Required
layer*	String Image Layer type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
model	String Image Layer Model Algorithm
status	String Layer Processing Status
contextId	String Layer context ID
date	String Query Date yyyy-MM-dd
fromDate	String Query fromDate yyyy-MM-dd
toDate	String Query toDate yyyy-MM-dd

Responses

Status: 200 - HTTP 200 SubField layer successfully found

Schema

Status: 400 - HTTP 400 Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField layer record not found

Schema

SubFields

createSubFields

Create a subfield with Shapefile

Creates a subfield a with an associated JSON and Shapefile payload

/subfield

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        RequestJSON body = ; // RequestJSON | SubField create JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createSubFields(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#createSubFields");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        RequestJSON body = ; // RequestJSON | SubField create JSON payload
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            UUIDResponse result = apiInstance.createSubFields(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#createSubFields");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
RequestJSON *body = ; // SubField create JSON payload
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Create a subfield with Shapefile
[apiInstance createSubFieldsWith:body
    xProfileId:xProfileId
              completionHandler: ^(UUIDResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var body = ; // {{RequestJSON}} SubField create JSON payload
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createSubFields(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class createSubFieldsExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var body = new RequestJSON(); // RequestJSON | SubField create JSON payload
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Create a subfield with Shapefile
                UUIDResponse result = apiInstance.createSubFields(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.createSubFields: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$body = ; // RequestJSON | SubField create JSON payload
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->createSubFields($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->createSubFields: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $body = WWW::SwaggerClient::Object::RequestJSON->new(); # RequestJSON | SubField create JSON payload
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->createSubFields(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->createSubFields: $@\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.SubFieldsApi()
body =  # RequestJSON | SubField create JSON payload
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Create a subfield with Shapefile
    api_response = api_instance.create_sub_fields(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->createSubFields: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 201 - The subfield was successfully created for the provided Shapefile

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 530 - HTTP 530 Geo Parser Error

Schema

Status: 531 - HTTP 531 Subfield DB Error

Schema

deleteSubFieldsByFieldId

Delete all subfields

Delete all subfields for a given fieldId

/field/{fieldUuid}/subfield

Usage and SDK Samples

curl -X DELETE\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//field/{fieldUuid}/subfield"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique field Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteSubFieldsByFieldId(fieldUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#deleteSubFieldsByFieldId");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        UUID fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique field Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            APIResponseMessage result = apiInstance.deleteSubFieldsByFieldId(fieldUuid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#deleteSubFieldsByFieldId");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
UUID *fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique field Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Delete all subfields
[apiInstance deleteSubFieldsByFieldIdWith:fieldUuid
    xProfileId:xProfileId
              completionHandler: ^(APIResponseMessage output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique field Uuid
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteSubFieldsByFieldId(fieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class deleteSubFieldsByFieldIdExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var fieldUuid = new UUID(); // UUID | Unique field Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Delete all subfields
                APIResponseMessage result = apiInstance.deleteSubFieldsByFieldId(fieldUuid, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.deleteSubFieldsByFieldId: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique field Uuid
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->deleteSubFieldsByFieldId($fieldUuid, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->deleteSubFieldsByFieldId: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique field Uuid
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->deleteSubFieldsByFieldId(fieldUuid => $fieldUuid, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->deleteSubFieldsByFieldId: $@\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.SubFieldsApi()
fieldUuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique field Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Delete all subfields
    api_response = api_instance.delete_sub_fields_by_field_id(fieldUuid, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->deleteSubFieldsByFieldId: %s\n" % e)

Parameters

Path parameters

Name	Description
fieldUuid*	UUID (uuid) Unique field Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Responses

Status: 204 - SubField successfully deleted

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

getAllSubFields

Returns a list of subfields

Returns a list of subfields based on subfield id's or subfields within a given radius

/subfield

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//subfield?uuidsOnly=&lon=&lat=&radius=&start=&limit=&sort=&projection=&fieldUuid=&inputType=&includeDeleted=&bufferSize="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
        Double lon = 1.2; // Double | Longitude
        Double lat = 1.2; // Double | Latitude
        Double radius = 1.2; // Double | Search radius (in metres)
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        String fieldUuid = fieldUuid_example; // String | Unique field Uuid
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted subfields
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        try {
            Feature result = apiInstance.getAllSubFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, fieldUuid, inputType, includeDeleted, bufferSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFields");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        Boolean uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
        Double lon = 1.2; // Double | Longitude
        Double lat = 1.2; // Double | Latitude
        Double radius = 1.2; // Double | Search radius (in metres)
        Integer start = 56; // Integer | Start pagination offset
        Integer limit = 56; // Integer | Results per page
        String sort = sort_example; // String | Results sort order
        Integer projection = 56; // Integer | Image Projection
        String fieldUuid = fieldUuid_example; // String | Unique field Uuid
        String inputType = inputType_example; // String | Input type
        Boolean includeDeleted = true; // Boolean | Include deleted subfields
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        try {
            Feature result = apiInstance.getAllSubFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, fieldUuid, inputType, includeDeleted, bufferSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFields");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
Boolean *uuidsOnly = true; // UUIDs Only - Return an array of subfield UUID's (optional) (default to false)
Double *lon = 1.2; // Longitude (optional)
Double *lat = 1.2; // Latitude (optional)
Double *radius = 1.2; // Search radius (in metres) (optional) (default to 20000)
Integer *start = 56; // Start pagination offset (optional) (default to 0)
Integer *limit = 56; // Results per page (optional) (default to 10)
String *sort = sort_example; // Results sort order (optional) (default to id)
Integer *projection = 56; // Image Projection (optional) (default to 4326)
String *fieldUuid = fieldUuid_example; // Unique field Uuid (optional)
String *inputType = inputType_example; // Input type (optional) (default to SPECIFIED_FIELD)
Boolean *includeDeleted = true; // Include deleted subfields (optional) (default to false)
Double *bufferSize = 1.2; // Buffer size around geometry (optional)

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

// Returns a list of subfields
[apiInstance getAllSubFieldsWith:xProfileId
    uuidsOnly:uuidsOnly
    lon:lon
    lat:lat
    radius:radius
    start:start
    limit:limit
    sort:sort
    projection:projection
    fieldUuid:fieldUuid
    inputType:inputType
    includeDeleted:includeDeleted
    bufferSize:bufferSize
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'uuidsOnly': true, // {{Boolean}} UUIDs Only - Return an array of subfield UUID's
  'lon': 1.2, // {{Double}} Longitude
  'lat': 1.2, // {{Double}} Latitude
  'radius': 1.2, // {{Double}} Search radius (in metres)
  'start': 56, // {{Integer}} Start pagination offset
  'limit': 56, // {{Integer}} Results per page
  'sort': sort_example, // {{String}} Results sort order
  'projection': 56, // {{Integer}} Image Projection
  'fieldUuid': fieldUuid_example, // {{String}} Unique field Uuid
  'inputType': inputType_example, // {{String}} Input type
  'includeDeleted': true, // {{Boolean}} Include deleted subfields
  'bufferSize': 1.2 // {{Double}} Buffer size around geometry
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllSubFields(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllSubFieldsExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var uuidsOnly = true;  // Boolean | UUIDs Only - Return an array of subfield UUID's (optional)  (default to false)
            var lon = 1.2;  // Double | Longitude (optional) 
            var lat = 1.2;  // Double | Latitude (optional) 
            var radius = 1.2;  // Double | Search radius (in metres) (optional)  (default to 20000)
            var start = 56;  // Integer | Start pagination offset (optional)  (default to 0)
            var limit = 56;  // Integer | Results per page (optional)  (default to 10)
            var sort = sort_example;  // String | Results sort order (optional)  (default to id)
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)
            var fieldUuid = fieldUuid_example;  // String | Unique field Uuid (optional) 
            var inputType = inputType_example;  // String | Input type (optional)  (default to SPECIFIED_FIELD)
            var includeDeleted = true;  // Boolean | Include deleted subfields (optional)  (default to false)
            var bufferSize = 1.2;  // Double | Buffer size around geometry (optional) 

            try
            {
                // Returns a list of subfields
                Feature result = apiInstance.getAllSubFields(xProfileId, uuidsOnly, lon, lat, radius, start, limit, sort, projection, fieldUuid, inputType, includeDeleted, bufferSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.getAllSubFields: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$xProfileId = xProfileId_example; // String | Profile Id
$uuidsOnly = true; // Boolean | UUIDs Only - Return an array of subfield UUID's
$lon = 1.2; // Double | Longitude
$lat = 1.2; // Double | Latitude
$radius = 1.2; // Double | Search radius (in metres)
$start = 56; // Integer | Start pagination offset
$limit = 56; // Integer | Results per page
$sort = sort_example; // String | Results sort order
$projection = 56; // Integer | Image Projection
$fieldUuid = fieldUuid_example; // String | Unique field Uuid
$inputType = inputType_example; // String | Input type
$includeDeleted = true; // Boolean | Include deleted subfields
$bufferSize = 1.2; // Double | Buffer size around geometry

try {
    $result = $api_instance->getAllSubFields($xProfileId, $uuidsOnly, $lon, $lat, $radius, $start, $limit, $sort, $projection, $fieldUuid, $inputType, $includeDeleted, $bufferSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->getAllSubFields: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $uuidsOnly = true; # Boolean | UUIDs Only - Return an array of subfield UUID's
my $lon = 1.2; # Double | Longitude
my $lat = 1.2; # Double | Latitude
my $radius = 1.2; # Double | Search radius (in metres)
my $start = 56; # Integer | Start pagination offset
my $limit = 56; # Integer | Results per page
my $sort = sort_example; # String | Results sort order
my $projection = 56; # Integer | Image Projection
my $fieldUuid = fieldUuid_example; # String | Unique field Uuid
my $inputType = inputType_example; # String | Input type
my $includeDeleted = true; # Boolean | Include deleted subfields
my $bufferSize = 1.2; # Double | Buffer size around geometry

eval { 
    my $result = $api_instance->getAllSubFields(xProfileId => $xProfileId, uuidsOnly => $uuidsOnly, lon => $lon, lat => $lat, radius => $radius, start => $start, limit => $limit, sort => $sort, projection => $projection, fieldUuid => $fieldUuid, inputType => $inputType, includeDeleted => $includeDeleted, bufferSize => $bufferSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->getAllSubFields: $@\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.SubFieldsApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
uuidsOnly = true # Boolean | UUIDs Only - Return an array of subfield UUID's (optional) (default to false)
lon = 1.2 # Double | Longitude (optional)
lat = 1.2 # Double | Latitude (optional)
radius = 1.2 # Double | Search radius (in metres) (optional) (default to 20000)
start = 56 # Integer | Start pagination offset (optional) (default to 0)
limit = 56 # Integer | Results per page (optional) (default to 10)
sort = sort_example # String | Results sort order (optional) (default to id)
projection = 56 # Integer | Image Projection (optional) (default to 4326)
fieldUuid = fieldUuid_example # String | Unique field Uuid (optional)
inputType = inputType_example # String | Input type (optional) (default to SPECIFIED_FIELD)
includeDeleted = true # Boolean | Include deleted subfields (optional) (default to false)
bufferSize = 1.2 # Double | Buffer size around geometry (optional)

try: 
    # Returns a list of subfields
    api_response = api_instance.get_all_sub_fields(xProfileId=xProfileId, uuidsOnly=uuidsOnly, lon=lon, lat=lat, radius=radius, start=start, limit=limit, sort=sort, projection=projection, fieldUuid=fieldUuid, inputType=inputType, includeDeleted=includeDeleted, bufferSize=bufferSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->getAllSubFields: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
uuidsOnly	Boolean UUIDs Only - Return an array of subfield UUID's
lon	Double (double) Longitude
lat	Double (double) Latitude
radius	Double (double) Search radius (in metres)
start	Integer (int32) Start pagination offset
limit	Integer (int32) Results per page
sort	String Results sort order
projection	Integer (int32) Image Projection
fieldUuid	String Unique field Uuid
inputType	String Input type
includeDeleted	Boolean Include deleted subfields
bufferSize	Double (double) Buffer size around geometry

Responses

Status: 200 - SubField successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getAllSubFieldsByBoundingBox

Search for a list of subfields for a given bounding box

/subfield/search/box

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield/search/box"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByBoxPayload body = ; // SearchByBoxPayload | Search for a list of subfields for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByBoundingBox(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByBoundingBox");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByBoxPayload body = ; // SearchByBoxPayload | Search for a list of subfields for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByBoundingBox(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByBoundingBox");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByBoxPayload *body = ; // Search for a list of subfields for a given bounding box
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of subfields for a given bounding box
[apiInstance getAllSubFieldsByBoundingBoxWith:body
    xProfileId:xProfileId
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var body = ; // {{SearchByBoxPayload}} Search for a list of subfields for a given bounding box
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllSubFieldsByBoundingBox(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllSubFieldsByBoundingBoxExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var body = new SearchByBoxPayload(); // SearchByBoxPayload | Search for a list of subfields for a given bounding box
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of subfields for a given bounding box
                Feature result = apiInstance.getAllSubFieldsByBoundingBox(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.getAllSubFieldsByBoundingBox: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$body = ; // SearchByBoxPayload | Search for a list of subfields for a given bounding box
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllSubFieldsByBoundingBox($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->getAllSubFieldsByBoundingBox: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByBoxPayload->new(); # SearchByBoxPayload | Search for a list of subfields for a given bounding box
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllSubFieldsByBoundingBox(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->getAllSubFieldsByBoundingBox: $@\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.SubFieldsApi()
body =  # SearchByBoxPayload | Search for a list of subfields for a given bounding box
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of subfields for a given bounding box
    api_response = api_instance.get_all_sub_fields_by_bounding_box(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->getAllSubFieldsByBoundingBox: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - SubFields successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getAllSubFieldsByGeometry

Search for a list of subfields for a given GeoJson geometry

/subfield/search/geometry

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield/search/geometry"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByGeometryPayload body = ; // SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByGeometry");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByGeometryPayload body = ; // SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByGeometry(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByGeometry");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByGeometryPayload *body = ; // Search for a list of subfields for a given GeoJson geometry
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of subfields for a given GeoJson geometry
[apiInstance getAllSubFieldsByGeometryWith:body
    xProfileId:xProfileId
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var body = ; // {{SearchByGeometryPayload}} Search for a list of subfields for a given GeoJson geometry
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllSubFieldsByGeometry(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllSubFieldsByGeometryExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var body = new SearchByGeometryPayload(); // SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of subfields for a given GeoJson geometry
                Feature result = apiInstance.getAllSubFieldsByGeometry(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.getAllSubFieldsByGeometry: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$body = ; // SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllSubFieldsByGeometry($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->getAllSubFieldsByGeometry: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByGeometryPayload->new(); # SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllSubFieldsByGeometry(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->getAllSubFieldsByGeometry: $@\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.SubFieldsApi()
body =  # SearchByGeometryPayload | Search for a list of subfields for a given GeoJson geometry
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of subfields for a given GeoJson geometry
    api_response = api_instance.get_all_sub_fields_by_geometry(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->getAllSubFieldsByGeometry: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - SubFields successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getAllSubFieldsByProperties

Search for a list of subfields for a given set of properties

/subfield/search/property

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield/search/property"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByPropertiesPayload body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByProperties(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByProperties");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        SearchByPropertiesPayload body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            Feature result = apiInstance.getAllSubFieldsByProperties(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getAllSubFieldsByProperties");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
SearchByPropertiesPayload *body = ; // Search for a list of subfields for a given set of properties
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of subfields for a given set of properties
[apiInstance getAllSubFieldsByPropertiesWith:body
    xProfileId:xProfileId
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var body = ; // {{SearchByPropertiesPayload}} Search for a list of subfields for a given set of properties
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllSubFieldsByProperties(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllSubFieldsByPropertiesExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var body = new SearchByPropertiesPayload(); // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of subfields for a given set of properties
                Feature result = apiInstance.getAllSubFieldsByProperties(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.getAllSubFieldsByProperties: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$body = ; // SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllSubFieldsByProperties($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->getAllSubFieldsByProperties: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $body = WWW::SwaggerClient::Object::SearchByPropertiesPayload->new(); # SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllSubFieldsByProperties(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->getAllSubFieldsByProperties: $@\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.SubFieldsApi()
body =  # SearchByPropertiesPayload | Search for a list of subfields for a given set of properties
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of subfields for a given set of properties
    api_response = api_instance.get_all_sub_fields_by_properties(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->getAllSubFieldsByProperties: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - SubFields successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getSubField

Get a subfield

Return a subfield based on unique indentifier

/subfield/{subFieldUuid}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//subfield/{subFieldUuid}?projection=&bufferSize="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SubFieldsApi;

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

public class SubFieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        SubFieldsApi apiInstance = new SubFieldsApi();
        String subFieldUuid = subFieldUuid_example; // String | Unique subfield Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        try {
            Feature result = apiInstance.getSubField(subFieldUuid, xProfileId, projection, bufferSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getSubField");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.SubFieldsApi;

public class SubFieldsApiExample {

    public static void main(String[] args) {
        SubFieldsApi apiInstance = new SubFieldsApi();
        String subFieldUuid = subFieldUuid_example; // String | Unique subfield Uuid
        String xProfileId = xProfileId_example; // String | Profile Id
        Integer projection = 56; // Integer | Image Projection
        Double bufferSize = 1.2; // Double | Buffer size around geometry
        try {
            Feature result = apiInstance.getSubField(subFieldUuid, xProfileId, projection, bufferSize);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubFieldsApi#getSubField");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *subFieldUuid = subFieldUuid_example; // Unique subfield Uuid
String *xProfileId = xProfileId_example; // Profile Id (optional)
Integer *projection = 56; // Image Projection (optional) (default to 4326)
Double *bufferSize = 1.2; // Buffer size around geometry (optional)

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

// Get a subfield
[apiInstance getSubFieldWith:subFieldUuid
    xProfileId:xProfileId
    projection:projection
    bufferSize:bufferSize
              completionHandler: ^(Feature output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.SubFieldsApi()
var subFieldUuid = subFieldUuid_example; // {{String}} Unique subfield Uuid
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'projection': 56, // {{Integer}} Image Projection
  'bufferSize': 1.2 // {{Double}} Buffer size around geometry
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSubField(subFieldUuid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getSubFieldExample
    {
        public void main()
        {


            var apiInstance = new SubFieldsApi();
            var subFieldUuid = subFieldUuid_example;  // String | Unique subfield Uuid
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var projection = 56;  // Integer | Image Projection (optional)  (default to 4326)
            var bufferSize = 1.2;  // Double | Buffer size around geometry (optional) 

            try
            {
                // Get a subfield
                Feature result = apiInstance.getSubField(subFieldUuid, xProfileId, projection, bufferSize);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SubFieldsApi.getSubField: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiSubFieldsApi();
$subFieldUuid = subFieldUuid_example; // String | Unique subfield Uuid
$xProfileId = xProfileId_example; // String | Profile Id
$projection = 56; // Integer | Image Projection
$bufferSize = 1.2; // Double | Buffer size around geometry

try {
    $result = $api_instance->getSubField($subFieldUuid, $xProfileId, $projection, $bufferSize);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubFieldsApi->getSubField: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SubFieldsApi;


my $api_instance = WWW::SwaggerClient::SubFieldsApi->new();
my $subFieldUuid = subFieldUuid_example; # String | Unique subfield Uuid
my $xProfileId = xProfileId_example; # String | Profile Id
my $projection = 56; # Integer | Image Projection
my $bufferSize = 1.2; # Double | Buffer size around geometry

eval { 
    my $result = $api_instance->getSubField(subFieldUuid => $subFieldUuid, xProfileId => $xProfileId, projection => $projection, bufferSize => $bufferSize);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubFieldsApi->getSubField: $@\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.SubFieldsApi()
subFieldUuid = subFieldUuid_example # String | Unique subfield Uuid
xProfileId = xProfileId_example # String | Profile Id (optional)
projection = 56 # Integer | Image Projection (optional) (default to 4326)
bufferSize = 1.2 # Double | Buffer size around geometry (optional)

try: 
    # Get a subfield
    api_response = api_instance.get_sub_field(subFieldUuid, xProfileId=xProfileId, projection=projection, bufferSize=bufferSize)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubFieldsApi->getSubField: %s\n" % e)

Parameters

Path parameters

Name	Description
subFieldUuid*	String Unique subfield Uuid Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
projection	Integer (int32) Image Projection
bufferSize	Double (double) Buffer size around geometry

Responses

Status: 200 - SubField successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

Upload

statusHandler.get

Upload Status

Get Status of Upload

/upload/{jobid}/status

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//upload/{jobid}/status"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadApi;

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

public class UploadApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UploadApi apiInstance = new UploadApi();
        String jobid = jobid_example; // String | UUID
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        try {
            StatusResponse result = apiInstance.statusHandler.get(jobid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#statusHandler.get");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UploadApi;

public class UploadApiExample {

    public static void main(String[] args) {
        UploadApi apiInstance = new UploadApi();
        String jobid = jobid_example; // String | UUID
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        try {
            StatusResponse result = apiInstance.statusHandler.get(jobid, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#statusHandler.get");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *jobid = jobid_example; // UUID
String *xProfileId = xProfileId_example; // Different profile UUID for field creation to be associated with (must have admin scope). (optional)

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

// Upload Status
[apiInstance statusHandler.getWith:jobid
    xProfileId:xProfileId
              completionHandler: ^(StatusResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.UploadApi()
var jobid = jobid_example; // {{String}} UUID
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Different profile UUID for field creation to be associated with (must have admin scope).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.statusHandler.get(jobid, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class statusHandler.getExample
    {
        public void main()
        {


            var apiInstance = new UploadApi();
            var jobid = jobid_example;  // String | UUID
            var xProfileId = xProfileId_example;  // String | Different profile UUID for field creation to be associated with (must have admin scope). (optional) 

            try
            {
                // Upload Status
                StatusResponse result = apiInstance.statusHandler.get(jobid, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadApi.statusHandler.get: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUploadApi();
$jobid = jobid_example; // String | UUID
$xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).

try {
    $result = $api_instance->statusHandler.get($jobid, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadApi->statusHandler.get: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadApi;


my $api_instance = WWW::SwaggerClient::UploadApi->new();
my $jobid = jobid_example; # String | UUID
my $xProfileId = xProfileId_example; # String | Different profile UUID for field creation to be associated with (must have admin scope).

eval { 
    my $result = $api_instance->statusHandler.get(jobid => $jobid, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadApi->statusHandler.get: $@\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.UploadApi()
jobid = jobid_example # String | UUID
xProfileId = xProfileId_example # String | Different profile UUID for field creation to be associated with (must have admin scope). (optional)

try: 
    # Upload Status
    api_response = api_instance.status_handler/get(jobid, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadApi->statusHandler.get: %s\n" % e)

Parameters

Path parameters

Name	Description
jobid*	String UUID Required

Header parameters

Name	Description
X-Profile-Id	String Different profile UUID for field creation to be associated with (must have admin scope).

Responses

Status: 200 - Response Message

Schema

Status: 400 - Bad Request

Schema

Status: 530 - Upload Timeout Failure

Schema

uploadHandler.post

Upload Zip

Post a zip file and, optionally, an array of field events to the Upload Service.

/upload

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//upload?inputType=&nameColumn=&domain=&category="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadApi;

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

public class UploadApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UploadApi apiInstance = new UploadApi();
        array[byte[]] zip = ; // array[byte[]] | 
        array[byte[]] events = ; // array[byte[]] | 
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        String inputType = inputType_example; // String | Input type
        String nameColumn = nameColumn_example; // String | Input type
        String domain = domain_example; // String | Domain
        String category = category_example; // String | Category of infrastructure (FUSE, BREAKER etc)
        try {
            JobResponse result = apiInstance.uploadHandler.post(zip, events, xProfileId, inputType, nameColumn, domain, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#uploadHandler.post");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UploadApi;

public class UploadApiExample {

    public static void main(String[] args) {
        UploadApi apiInstance = new UploadApi();
        array[byte[]] zip = ; // array[byte[]] | 
        array[byte[]] events = ; // array[byte[]] | 
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        String inputType = inputType_example; // String | Input type
        String nameColumn = nameColumn_example; // String | Input type
        String domain = domain_example; // String | Domain
        String category = category_example; // String | Category of infrastructure (FUSE, BREAKER etc)
        try {
            JobResponse result = apiInstance.uploadHandler.post(zip, events, xProfileId, inputType, nameColumn, domain, category);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#uploadHandler.post");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
array[byte[]] *zip = ; // 
array[byte[]] *events = ; // 
String *xProfileId = xProfileId_example; // Different profile UUID for field creation to be associated with (must have admin scope). (optional)
String *inputType = inputType_example; // Input type (optional) (default to SPECIFIED_FIELD)
String *nameColumn = nameColumn_example; // Input type (optional) (default to UNIQUE_ROW_ID_COLS)
String *domain = domain_example; // Domain (optional) (default to AG)
String *category = category_example; // Category of infrastructure (FUSE, BREAKER etc) (optional)

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

// Upload Zip
[apiInstance uploadHandler.postWith:zip
    events:events
    xProfileId:xProfileId
    inputType:inputType
    nameColumn:nameColumn
    domain:domain
    category:category
              completionHandler: ^(JobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.UploadApi()
var zip = ; // {{array[byte[]]}} 
var events = ; // {{array[byte[]]}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Different profile UUID for field creation to be associated with (must have admin scope).
  'inputType': inputType_example // {{String}} Input type
  'nameColumn': nameColumn_example // {{String}} Input type
  'domain': domain_example // {{String}} Domain
  'category': category_example // {{String}} Category of infrastructure (FUSE, BREAKER etc)
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.uploadHandler.post(zipevents, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class uploadHandler.postExample
    {
        public void main()
        {


            var apiInstance = new UploadApi();
            var zip = new array[byte[]](); // array[byte[]] | 
            var events = new array[byte[]](); // array[byte[]] | 
            var xProfileId = xProfileId_example;  // String | Different profile UUID for field creation to be associated with (must have admin scope). (optional) 
            var inputType = inputType_example;  // String | Input type (optional)  (default to SPECIFIED_FIELD)
            var nameColumn = nameColumn_example;  // String | Input type (optional)  (default to UNIQUE_ROW_ID_COLS)
            var domain = domain_example;  // String | Domain (optional)  (default to AG)
            var category = category_example;  // String | Category of infrastructure (FUSE, BREAKER etc) (optional) 

            try
            {
                // Upload Zip
                JobResponse result = apiInstance.uploadHandler.post(zip, events, xProfileId, inputType, nameColumn, domain, category);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadApi.uploadHandler.post: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUploadApi();
$zip = ; // array[byte[]] | 
$events = ; // array[byte[]] | 
$xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
$inputType = inputType_example; // String | Input type
$nameColumn = nameColumn_example; // String | Input type
$domain = domain_example; // String | Domain
$category = category_example; // String | Category of infrastructure (FUSE, BREAKER etc)

try {
    $result = $api_instance->uploadHandler.post($zip, $events, $xProfileId, $inputType, $nameColumn, $domain, $category);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadApi->uploadHandler.post: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadApi;


my $api_instance = WWW::SwaggerClient::UploadApi->new();
my $zip = []; # array[byte[]] | 
my $events = []; # array[byte[]] | 
my $xProfileId = xProfileId_example; # String | Different profile UUID for field creation to be associated with (must have admin scope).
my $inputType = inputType_example; # String | Input type
my $nameColumn = nameColumn_example; # String | Input type
my $domain = domain_example; # String | Domain
my $category = category_example; # String | Category of infrastructure (FUSE, BREAKER etc)

eval { 
    my $result = $api_instance->uploadHandler.post(zip => $zip, events => $events, xProfileId => $xProfileId, inputType => $inputType, nameColumn => $nameColumn, domain => $domain, category => $category);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadApi->uploadHandler.post: $@\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.UploadApi()
zip =  # array[byte[]] | 
events =  # array[byte[]] | 
xProfileId = xProfileId_example # String | Different profile UUID for field creation to be associated with (must have admin scope). (optional)
inputType = inputType_example # String | Input type (optional) (default to SPECIFIED_FIELD)
nameColumn = nameColumn_example # String | Input type (optional) (default to UNIQUE_ROW_ID_COLS)
domain = domain_example # String | Domain (optional) (default to AG)
category = category_example # String | Category of infrastructure (FUSE, BREAKER etc) (optional)

try: 
    # Upload Zip
    api_response = api_instance.upload_handler/post(zip, events, xProfileId=xProfileId, inputType=inputType, nameColumn=nameColumn, domain=domain, category=category)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadApi->uploadHandler.post: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Different profile UUID for field creation to be associated with (must have admin scope).

Form parameters

Name	Description
zip*	array[byte[]] (binary) Required
events*	array[byte[]] (binary) Required

Query parameters

Name	Description
inputType	String Input type
nameColumn	String Input type
domain	String Domain
category	String Category of infrastructure (FUSE, BREAKER etc)

Responses

Status: 202 - Response Message

Schema

Status: 400 - Bad Request

Schema

vectorDataUploadHandler.post

Upload vectordata Zip

Post a vectordata zip file to the Upload Service.

/vectordata/upload

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"//vectordata/upload"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UploadApi;

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

public class UploadApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        UploadApi apiInstance = new UploadApi();
        array[byte[]] zip = ; // array[byte[]] | 
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        try {
            VectorDataJobResponse result = apiInstance.vectorDataUploadHandler.post(zip, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#vectorDataUploadHandler.post");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.UploadApi;

public class UploadApiExample {

    public static void main(String[] args) {
        UploadApi apiInstance = new UploadApi();
        array[byte[]] zip = ; // array[byte[]] | 
        String xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).
        try {
            VectorDataJobResponse result = apiInstance.vectorDataUploadHandler.post(zip, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UploadApi#vectorDataUploadHandler.post");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
array[byte[]] *zip = ; // 
String *xProfileId = xProfileId_example; // Different profile UUID for field creation to be associated with (must have admin scope). (optional)

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

// Upload vectordata Zip
[apiInstance vectorDataUploadHandler.postWith:zip
    xProfileId:xProfileId
              completionHandler: ^(VectorDataJobResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.UploadApi()
var zip = ; // {{array[byte[]]}} 
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Different profile UUID for field creation to be associated with (must have admin scope).
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vectorDataUploadHandler.post(zip, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vectorDataUploadHandler.postExample
    {
        public void main()
        {


            var apiInstance = new UploadApi();
            var zip = new array[byte[]](); // array[byte[]] | 
            var xProfileId = xProfileId_example;  // String | Different profile UUID for field creation to be associated with (must have admin scope). (optional) 

            try
            {
                // Upload vectordata Zip
                VectorDataJobResponse result = apiInstance.vectorDataUploadHandler.post(zip, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UploadApi.vectorDataUploadHandler.post: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiUploadApi();
$zip = ; // array[byte[]] | 
$xProfileId = xProfileId_example; // String | Different profile UUID for field creation to be associated with (must have admin scope).

try {
    $result = $api_instance->vectorDataUploadHandler.post($zip, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UploadApi->vectorDataUploadHandler.post: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::UploadApi;


my $api_instance = WWW::SwaggerClient::UploadApi->new();
my $zip = []; # array[byte[]] | 
my $xProfileId = xProfileId_example; # String | Different profile UUID for field creation to be associated with (must have admin scope).

eval { 
    my $result = $api_instance->vectorDataUploadHandler.post(zip => $zip, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UploadApi->vectorDataUploadHandler.post: $@\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.UploadApi()
zip =  # array[byte[]] | 
xProfileId = xProfileId_example # String | Different profile UUID for field creation to be associated with (must have admin scope). (optional)

try: 
    # Upload vectordata Zip
    api_response = api_instance.vector_data_upload_handler/post(zip, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UploadApi->vectorDataUploadHandler.post: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Different profile UUID for field creation to be associated with (must have admin scope).

Form parameters

Name	Description
zip*	array[byte[]] (binary) Required

Responses

Status: 202 - Response Message

Schema

Status: 400 - Bad Request

Schema

VectorData

getAllVectors

Search for a list of vector data for a given bounding box

/vectordata/search/box

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//vectordata/search/box"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VectorDataApi;

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

public class VectorDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataSearchByBoxPayload body = ; // VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            FeatureCollection result = apiInstance.getAllVectors(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getAllVectors");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.VectorDataApi;

public class VectorDataApiExample {

    public static void main(String[] args) {
        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataSearchByBoxPayload body = ; // VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            FeatureCollection result = apiInstance.getAllVectors(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getAllVectors");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
VectorDataSearchByBoxPayload *body = ; // Search for a list of vector data for a given bounding box
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of vector data for a given bounding box
[apiInstance getAllVectorsWith:body
    xProfileId:xProfileId
              completionHandler: ^(FeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.VectorDataApi()
var body = ; // {{VectorDataSearchByBoxPayload}} Search for a list of vector data for a given bounding box
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllVectors(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllVectorsExample
    {
        public void main()
        {


            var apiInstance = new VectorDataApi();
            var body = new VectorDataSearchByBoxPayload(); // VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of vector data for a given bounding box
                FeatureCollection result = apiInstance.getAllVectors(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VectorDataApi.getAllVectors: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVectorDataApi();
$body = ; // VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllVectors($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VectorDataApi->getAllVectors: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VectorDataApi;


my $api_instance = WWW::SwaggerClient::VectorDataApi->new();
my $body = WWW::SwaggerClient::Object::VectorDataSearchByBoxPayload->new(); # VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllVectors(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VectorDataApi->getAllVectors: $@\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.VectorDataApi()
body =  # VectorDataSearchByBoxPayload | Search for a list of vector data for a given bounding box
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of vector data for a given bounding box
    api_response = api_instance.get_all_vectors(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VectorDataApi->getAllVectors: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Vector data successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getAllVectors1

Search for a list of vector data for a given GeoJson geometry

/vectordata/search/geometry

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//vectordata/search/geometry"

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VectorDataApi;

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

public class VectorDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataSearchByGeometryPayload body = ; // VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            FeatureCollection result = apiInstance.getAllVectors1(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getAllVectors1");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.VectorDataApi;

public class VectorDataApiExample {

    public static void main(String[] args) {
        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataSearchByGeometryPayload body = ; // VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
        String xProfileId = xProfileId_example; // String | Profile Id
        try {
            FeatureCollection result = apiInstance.getAllVectors1(body, xProfileId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getAllVectors1");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
VectorDataSearchByGeometryPayload *body = ; // Search for a list of vector data for a given GeoJson geometry
String *xProfileId = xProfileId_example; // Profile Id (optional)

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

// Search for a list of vector data for a given GeoJson geometry
[apiInstance getAllVectors1With:body
    xProfileId:xProfileId
              completionHandler: ^(FeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.VectorDataApi()
var body = ; // {{VectorDataSearchByGeometryPayload}} Search for a list of vector data for a given GeoJson geometry
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAllVectors1(body, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getAllVectors1Example
    {
        public void main()
        {


            var apiInstance = new VectorDataApi();
            var body = new VectorDataSearchByGeometryPayload(); // VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 

            try
            {
                // Search for a list of vector data for a given GeoJson geometry
                FeatureCollection result = apiInstance.getAllVectors1(body, xProfileId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VectorDataApi.getAllVectors1: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVectorDataApi();
$body = ; // VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
$xProfileId = xProfileId_example; // String | Profile Id

try {
    $result = $api_instance->getAllVectors1($body, $xProfileId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VectorDataApi->getAllVectors1: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VectorDataApi;


my $api_instance = WWW::SwaggerClient::VectorDataApi->new();
my $body = WWW::SwaggerClient::Object::VectorDataSearchByGeometryPayload->new(); # VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
my $xProfileId = xProfileId_example; # String | Profile Id

eval { 
    my $result = $api_instance->getAllVectors1(body => $body, xProfileId => $xProfileId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VectorDataApi->getAllVectors1: $@\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.VectorDataApi()
body =  # VectorDataSearchByGeometryPayload | Search for a list of vector data for a given GeoJson geometry
xProfileId = xProfileId_example # String | Profile Id (optional)

try: 
    # Search for a list of vector data for a given GeoJson geometry
    api_response = api_instance.get_all_vectors1(body, xProfileId=xProfileId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VectorDataApi->getAllVectors1: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Responses

Status: 200 - Vector data successfully found

Schema

Status: 400 - HTTP 400 Bad Request

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 SubField not found

Schema

getVectorDataByAsset

Get the layer vector data

/vectordata

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//vectordata?assetUuid=&date=&fromDate=&toDate=&contextId=&includeUniqueRowId=&layer="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VectorDataApi;

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

public class VectorDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VectorDataApi apiInstance = new VectorDataApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String assetUuid = assetUuid_example; // String | Asset UUID
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        String contextId = contextId_example; // String | Layer context ID
        Boolean includeUniqueRowId = true; // Boolean | Include Unique Vector Row Id
        String layer = layer_example; // String | Image Layer type
        try {
            FeatureCollection result = apiInstance.getVectorDataByAsset(xProfileId, assetUuid, date, fromDate, toDate, contextId, includeUniqueRowId, layer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getVectorDataByAsset");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.VectorDataApi;

public class VectorDataApiExample {

    public static void main(String[] args) {
        VectorDataApi apiInstance = new VectorDataApi();
        String xProfileId = xProfileId_example; // String | Profile Id
        String assetUuid = assetUuid_example; // String | Asset UUID
        String date = date_example; // String | Query Date yyyy-MM-dd
        String fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
        String toDate = toDate_example; // String | Query toDate yyyy-MM-dd
        String contextId = contextId_example; // String | Layer context ID
        Boolean includeUniqueRowId = true; // Boolean | Include Unique Vector Row Id
        String layer = layer_example; // String | Image Layer type
        try {
            FeatureCollection result = apiInstance.getVectorDataByAsset(xProfileId, assetUuid, date, fromDate, toDate, contextId, includeUniqueRowId, layer);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#getVectorDataByAsset");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *assetUuid = assetUuid_example; // Asset UUID (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)
String *fromDate = fromDate_example; // Query fromDate yyyy-MM-dd (optional)
String *toDate = toDate_example; // Query toDate yyyy-MM-dd (optional)
String *contextId = contextId_example; // Layer context ID (optional)
Boolean *includeUniqueRowId = true; // Include Unique Vector Row Id (optional) (default to false)
String *layer = layer_example; // Image Layer type (optional)

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

// Get the layer vector data
[apiInstance getVectorDataByAssetWith:xProfileId
    assetUuid:assetUuid
    date:date
    fromDate:fromDate
    toDate:toDate
    contextId:contextId
    includeUniqueRowId:includeUniqueRowId
    layer:layer
              completionHandler: ^(FeatureCollection output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.VectorDataApi()
var opts = { 
  'xProfileId': xProfileId_example, // {{String}} Profile Id
  'assetUuid': assetUuid_example, // {{String}} Asset UUID
  'date': date_example, // {{String}} Query Date yyyy-MM-dd
  'fromDate': fromDate_example, // {{String}} Query fromDate yyyy-MM-dd
  'toDate': toDate_example, // {{String}} Query toDate yyyy-MM-dd
  'contextId': contextId_example, // {{String}} Layer context ID
  'includeUniqueRowId': true, // {{Boolean}} Include Unique Vector Row Id
  'layer': layer_example // {{String}} Image Layer type
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVectorDataByAsset(opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class getVectorDataByAssetExample
    {
        public void main()
        {


            var apiInstance = new VectorDataApi();
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var assetUuid = assetUuid_example;  // String | Asset UUID (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 
            var fromDate = fromDate_example;  // String | Query fromDate yyyy-MM-dd (optional) 
            var toDate = toDate_example;  // String | Query toDate yyyy-MM-dd (optional) 
            var contextId = contextId_example;  // String | Layer context ID (optional) 
            var includeUniqueRowId = true;  // Boolean | Include Unique Vector Row Id (optional)  (default to false)
            var layer = layer_example;  // String | Image Layer type (optional) 

            try
            {
                // Get the layer vector data
                FeatureCollection result = apiInstance.getVectorDataByAsset(xProfileId, assetUuid, date, fromDate, toDate, contextId, includeUniqueRowId, layer);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VectorDataApi.getVectorDataByAsset: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVectorDataApi();
$xProfileId = xProfileId_example; // String | Profile Id
$assetUuid = assetUuid_example; // String | Asset UUID
$date = date_example; // String | Query Date yyyy-MM-dd
$fromDate = fromDate_example; // String | Query fromDate yyyy-MM-dd
$toDate = toDate_example; // String | Query toDate yyyy-MM-dd
$contextId = contextId_example; // String | Layer context ID
$includeUniqueRowId = true; // Boolean | Include Unique Vector Row Id
$layer = layer_example; // String | Image Layer type

try {
    $result = $api_instance->getVectorDataByAsset($xProfileId, $assetUuid, $date, $fromDate, $toDate, $contextId, $includeUniqueRowId, $layer);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VectorDataApi->getVectorDataByAsset: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VectorDataApi;


my $api_instance = WWW::SwaggerClient::VectorDataApi->new();
my $xProfileId = xProfileId_example; # String | Profile Id
my $assetUuid = assetUuid_example; # String | Asset UUID
my $date = date_example; # String | Query Date yyyy-MM-dd
my $fromDate = fromDate_example; # String | Query fromDate yyyy-MM-dd
my $toDate = toDate_example; # String | Query toDate yyyy-MM-dd
my $contextId = contextId_example; # String | Layer context ID
my $includeUniqueRowId = true; # Boolean | Include Unique Vector Row Id
my $layer = layer_example; # String | Image Layer type

eval { 
    my $result = $api_instance->getVectorDataByAsset(xProfileId => $xProfileId, assetUuid => $assetUuid, date => $date, fromDate => $fromDate, toDate => $toDate, contextId => $contextId, includeUniqueRowId => $includeUniqueRowId, layer => $layer);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VectorDataApi->getVectorDataByAsset: $@\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.VectorDataApi()
xProfileId = xProfileId_example # String | Profile Id (optional)
assetUuid = assetUuid_example # String | Asset UUID (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)
fromDate = fromDate_example # String | Query fromDate yyyy-MM-dd (optional)
toDate = toDate_example # String | Query toDate yyyy-MM-dd (optional)
contextId = contextId_example # String | Layer context ID (optional)
includeUniqueRowId = true # Boolean | Include Unique Vector Row Id (optional) (default to false)
layer = layer_example # String | Image Layer type (optional)

try: 
    # Get the layer vector data
    api_response = api_instance.get_vector_data_by_asset(xProfileId=xProfileId, assetUuid=assetUuid, date=date, fromDate=fromDate, toDate=toDate, contextId=contextId, includeUniqueRowId=includeUniqueRowId, layer=layer)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VectorDataApi->getVectorDataByAsset: %s\n" % e)

Parameters

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Query parameters

Name	Description
assetUuid	String Asset UUID
date	String Query Date yyyy-MM-dd
fromDate	String Query fromDate yyyy-MM-dd
toDate	String Query toDate yyyy-MM-dd
contextId	String Layer context ID
includeUniqueRowId	Boolean Include Unique Vector Row Id
layer	String Image Layer type

Responses

Status: 200 - HTTP 200 - vector data returned successfully

Schema

Status: 400 - HTTP 400 - Invalid asset UUID supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

saveLayerVectorDataList

Save the layer vector data

/subfield/{subfielduuid}/layer/{layer}/vectordata

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json; charset=UTF-8"\
"//subfield/{subfielduuid}/layer/{layer}/vectordata?contextId=&date="

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.VectorDataApi;

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

public class VectorDataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();


        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataPayload body = ; // VectorDataPayload | 
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            PostVectorResponse result = apiInstance.saveLayerVectorDataList(body, subfielduuid, layer, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#saveLayerVectorDataList");
            e.printStackTrace();
        }
    }
}

import io.swagger.client.api.VectorDataApi;

public class VectorDataApiExample {

    public static void main(String[] args) {
        VectorDataApi apiInstance = new VectorDataApi();
        VectorDataPayload body = ; // VectorDataPayload | 
        UUID subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
        String layer = layer_example; // String | Image Layer type
        String xProfileId = xProfileId_example; // String | Profile Id
        String contextId = contextId_example; // String | Layer context ID
        String date = date_example; // String | Query Date yyyy-MM-dd
        try {
            PostVectorResponse result = apiInstance.saveLayerVectorDataList(body, subfielduuid, layer, xProfileId, contextId, date);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling VectorDataApi#saveLayerVectorDataList");
            e.printStackTrace();
        }
    }
}

Configuration *apiConfig = [Configuration sharedConfig];
VectorDataPayload *body = ; // 
UUID *subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // Unique SubField UUID
String *layer = layer_example; // Image Layer type
String *xProfileId = xProfileId_example; // Profile Id (optional)
String *contextId = contextId_example; // Layer context ID (optional)
String *date = date_example; // Query Date yyyy-MM-dd (optional)

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

// Save the layer vector data
[apiInstance saveLayerVectorDataListWith:body
    subfielduuid:subfielduuid
    layer:layer
    xProfileId:xProfileId
    contextId:contextId
    date:date
              completionHandler: ^(PostVectorResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

var IbmWatsonDecisionPlatformForAgriculture = require('ibm_watson_decision_platform_for_agriculture');
var defaultClient = IbmWatsonDecisionPlatformForAgriculture.ApiClient.instance;


var api = new IbmWatsonDecisionPlatformForAgriculture.VectorDataApi()
var body = ; // {{VectorDataPayload}} 
var subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // {{UUID}} Unique SubField UUID
var layer = layer_example; // {{String}} Image Layer type
var opts = { 
  'xProfileId': xProfileId_example // {{String}} Profile Id
  'contextId': contextId_example // {{String}} Layer context ID
  'date': date_example // {{String}} Query Date yyyy-MM-dd
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.saveLayerVectorDataList(bodysubfielduuidlayer, opts, callback);

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class saveLayerVectorDataListExample
    {
        public void main()
        {


            var apiInstance = new VectorDataApi();
            var body = new VectorDataPayload(); // VectorDataPayload | 
            var subfielduuid = new UUID(); // UUID | Unique SubField UUID
            var layer = layer_example;  // String | Image Layer type
            var xProfileId = xProfileId_example;  // String | Profile Id (optional) 
            var contextId = contextId_example;  // String | Layer context ID (optional) 
            var date = date_example;  // String | Query Date yyyy-MM-dd (optional) 

            try
            {
                // Save the layer vector data
                PostVectorResponse result = apiInstance.saveLayerVectorDataList(body, subfielduuid, layer, xProfileId, contextId, date);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling VectorDataApi.saveLayerVectorDataList: " + e.Message );
            }
        }
    }
}

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$api_instance = new Swagger\Client\ApiVectorDataApi();
$body = ; // VectorDataPayload | 
$subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // UUID | Unique SubField UUID
$layer = layer_example; // String | Image Layer type
$xProfileId = xProfileId_example; // String | Profile Id
$contextId = contextId_example; // String | Layer context ID
$date = date_example; // String | Query Date yyyy-MM-dd

try {
    $result = $api_instance->saveLayerVectorDataList($body, $subfielduuid, $layer, $xProfileId, $contextId, $date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VectorDataApi->saveLayerVectorDataList: ', $e->getMessage(), PHP_EOL;
}
?>

use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::VectorDataApi;


my $api_instance = WWW::SwaggerClient::VectorDataApi->new();
my $body = WWW::SwaggerClient::Object::VectorDataPayload->new(); # VectorDataPayload | 
my $subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d; # UUID | Unique SubField UUID
my $layer = layer_example; # String | Image Layer type
my $xProfileId = xProfileId_example; # String | Profile Id
my $contextId = contextId_example; # String | Layer context ID
my $date = date_example; # String | Query Date yyyy-MM-dd

eval { 
    my $result = $api_instance->saveLayerVectorDataList(body => $body, subfielduuid => $subfielduuid, layer => $layer, xProfileId => $xProfileId, contextId => $contextId, date => $date);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling VectorDataApi->saveLayerVectorDataList: $@\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.VectorDataApi()
body =  # VectorDataPayload | 
subfielduuid = 38400000-8cf0-11bd-b23e-10b96e4ef00d # UUID | Unique SubField UUID
layer = layer_example # String | Image Layer type
xProfileId = xProfileId_example # String | Profile Id (optional)
contextId = contextId_example # String | Layer context ID (optional)
date = date_example # String | Query Date yyyy-MM-dd (optional)

try: 
    # Save the layer vector data
    api_response = api_instance.save_layer_vector_data_list(body, subfielduuid, layer, xProfileId=xProfileId, contextId=contextId, date=date)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling VectorDataApi->saveLayerVectorDataList: %s\n" % e)

Parameters

Path parameters

Name	Description
subfielduuid*	UUID (uuid) Unique SubField UUID Required
layer*	String Image Layer type Required

Header parameters

Name	Description
X-Profile-Id	String Profile Id

Body parameters

Name	Description
body *

Query parameters

Name	Description
contextId	String Layer context ID
date	String Query Date yyyy-MM-dd

Responses

Status: 201 - HTTP 201 - Vector Data is saved successfully

Schema

Status: 400 - HTTP 400 - Invalid date format supplied

Schema

Status: 401 - HTTP 401 Unauthorized

Schema

Status: 404 - HTTP 404 - Data layer not found in object storage

Schema

Status: 409 - HTTP 409 - Entity with same layer_table_id and band_id already exists

Schema

Status: 503 - HTTP 503 - Unable to communicate with Field Profile Service

Schema

IBM Watson Decision Platform for Agriculture

API and SDK Documentation

Analytics

getAllJobs

Usage and SDK Samples

Parameters

Responses

Status: 200 - HTTP 200 Jobs list successfully returned

Status: 401 - HTTP 401 Unauthorized

Status: 404 - HTTP 404 Job not found

getAllJobsForStatus

Usage and SDK Samples

Parameters

Responses

Status: 200 - HTTP 200 Jobs list successfully returned

Status: 401 - HTTP 401 Unauthorized

Status: 404 - HTTP 404 Job not found

getJobData

Usage and SDK Samples

Parameters

Responses

Status: 200 - HTTP 200 SubField layer successfully found

Status: 400 - HTTP 400 Bad request; Job is not READY

Status: 401 - HTTP 401 Unauthorized

Status: 404 - HTTP 404 Job not found

Status: 500 - HTTP 500 Internal service error

getJobStatus

Usage and SDK Samples

Parameters

Responses

Status: 200 - HTTP 200 Job status successfully returned

Status: 401 - HTTP 401 Unauthorized

Status: 404 - HTTP 404 Job not found

postJob

Usage and SDK Samples

Parameters

Responses

Status: 202 - HTTP 202 Job successfully created

Status: 400 - HTTP 400 Bad request. Post job payload contains invalid data

Status: 401 - HTTP 401 Unauthorized

AssetImport

assetImportSourceHandler.post

Usage and SDK Samples

Parameters

Responses

Status: 200 - Response Message for e2e mode

Status: 202 - Response Message for single/default mode

Status: 500 - Bad Request

assetImportTargetHandler.delete

Usage and SDK Samples

Parameters

Responses

Status: 200 - Response Message for e2e mode

Status: 500 - Bad Request

assetImportTargetHandler.post

Usage and SDK Samples

Parameters

Responses

Status: 200 - Response Message for e2e mode

Status: 500 - Bad Request

assetImportTargetUpdateHandler.put

Usage and SDK Samples

Parameters

Responses

Status: 200 - Response Message for target update

Status: 500 - Bad Request

statusHandler.get

Usage and SDK Samples

Parameters

Responses

Status: 200 - Status for the asset import job.

Status: 500 - Bad Request

Assets

createAsset

Usage and SDK Samples

Parameters

Responses

Status: 201 - The asset was successfully created

Status: 400 - HTTP 400 Bad Request

Status: 401 - HTTP 401 Unauthorized