Cloudera Documentation

Atlas REST API

DiscoveryREST

addSavedSearch


/v2/search/saved

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/saved" \
 -d '{
  "name" : "...",
  "ownerName" : "...",
  "searchParameters" : {
    "attributes" : [ "...", "..." ],
    "classification" : "...",
    "entityFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "AND",
      "criterion" : [ { }, { } ],
      "operator" : "LT"
    },
    "excludeDeletedEntities" : true,
    "excludeHeaderAttributes" : true,
    "includeClassificationAttributes" : true,
    "includeSubClassifications" : true,
    "includeSubTypes" : true,
    "limit" : 12345,
    "marker" : "...",
    "offset" : 12345,
    "query" : "...",
    "relationshipFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "OR",
      "criterion" : [ { }, { } ],
      "operator" : "NEQ"
    },
    "relationshipName" : "...",
    "sortBy" : "...",
    "sortOrder" : "ASCENDING",
    "tagFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "OR",
      "criterion" : [ { }, { } ],
      "operator" : "NEQ"
    },
    "termName" : "...",
    "typeName" : "..."
  },
  "searchType" : "BASIC_RELATIONSHIP",
  "uiParameters" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        AtlasUserSavedSearch atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

        try {
            AtlasUserSavedSearch result = apiInstance.addSavedSearch(atlasUserSavedSearch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#addSavedSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasUserSavedSearch atlasUserSavedSearch = new AtlasUserSavedSearch(); // AtlasUserSavedSearch | 

try {
    final result = await api_instance.addSavedSearch(atlasUserSavedSearch);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addSavedSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        AtlasUserSavedSearch atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

        try {
            AtlasUserSavedSearch result = apiInstance.addSavedSearch(atlasUserSavedSearch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#addSavedSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
AtlasUserSavedSearch *atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."}; //  (optional)

[apiInstance addSavedSearchWith:atlasUserSavedSearch
              completionHandler: ^(AtlasUserSavedSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'atlasUserSavedSearch': {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."} // {AtlasUserSavedSearch} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var atlasUserSavedSearch = new AtlasUserSavedSearch(); // AtlasUserSavedSearch |  (optional) 

            try {
                AtlasUserSavedSearch result = apiInstance.addSavedSearch(atlasUserSavedSearch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.addSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $atlasUserSavedSearch = WWW::OPenAPIClient::Object::AtlasUserSavedSearch->new(); # AtlasUserSavedSearch | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."} # AtlasUserSavedSearch |  (optional)

try:
    api_response = api_instance.add_saved_search(atlasUserSavedSearch=atlasUserSavedSearch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->addSavedSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"GT"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IN"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"NOT_EMPTY"},"termName":"...","typeName":"..."},"searchType":"BASIC","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.addSavedSearch(atlasUserSavedSearch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasUserSavedSearch

Responses


basicSearchCreateFile


/v2/search/basic/download/create_file

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/basic/download/create_file" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.basicSearchCreateFile(requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#basicSearchCreateFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.basicSearchCreateFile(requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->basicSearchCreateFile: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.basicSearchCreateFile(requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#basicSearchCreateFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance basicSearchCreateFileWith:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'requestBody': Object // {map[String, Object]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.basicSearchCreateFile(requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.basicSearchCreateFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->basicSearchCreateFile($requestBody);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->basicSearchCreateFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.basic_search_create_file(requestBody=requestBody)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->basicSearchCreateFile: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let requestBody = Object; // map[String, Object]

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.basicSearchCreateFile(requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
requestBody

Responses


deleteSavedSearch


/v2/search/saved/{guid}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/search/saved/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String guid = guid_example; // String | Name of the saved search

        try {
            apiInstance.deleteSavedSearch(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#deleteSavedSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | Name of the saved search

try {
    final result = await api_instance.deleteSavedSearch(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteSavedSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String guid = guid_example; // String | Name of the saved search

        try {
            apiInstance.deleteSavedSearch(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#deleteSavedSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *guid = guid_example; // Name of the saved search (default to null)

[apiInstance deleteSavedSearchWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var guid = guid_example; // {String} Name of the saved search

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var guid = guid_example;  // String | Name of the saved search (default to null)

            try {
                apiInstance.deleteSavedSearch(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.deleteSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$guid = guid_example; // String | Name of the saved search

try {
    $api_instance->deleteSavedSearch($guid);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->deleteSavedSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $guid = guid_example; # String | Name of the saved search

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
guid = guid_example # String | Name of the saved search (default to null)

try:
    api_instance.delete_saved_search(guid)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->deleteSavedSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.deleteSavedSearch(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Name of the saved search
Required

Responses


downloadSearchResultFile


/v2/search/download/{filename}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/octet-stream" \
 "http://localhost/api/atlas/v2/search/download/{filename}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String filename = filename_example; // String | 

        try {
            'String' result = apiInstance.downloadSearchResultFile(filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#downloadSearchResultFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String filename = new String(); // String | 

try {
    final result = await api_instance.downloadSearchResultFile(filename);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->downloadSearchResultFile: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String filename = filename_example; // String | 

        try {
            'String' result = apiInstance.downloadSearchResultFile(filename);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#downloadSearchResultFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *filename = filename_example; //  (default to null)

[apiInstance downloadSearchResultFileWith:filename
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var filename = filename_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var filename = filename_example;  // String |  (default to null)

            try {
                'String' result = apiInstance.downloadSearchResultFile(filename);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.downloadSearchResultFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$filename = filename_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $filename = filename_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
filename = filename_example # String |  (default to null)

try:
    api_response = api_instance.download_search_result_file(filename)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->downloadSearchResultFile: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let filename = filename_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.downloadSearchResultFile(filename, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
filename*
String
Required

Responses


dslSearchCreateFile


/v2/search/dsl/download/create_file

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/dsl/download/create_file" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.dslSearchCreateFile(requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#dslSearchCreateFile");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.dslSearchCreateFile(requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->dslSearchCreateFile: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.dslSearchCreateFile(requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#dslSearchCreateFile");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance dslSearchCreateFileWith:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'requestBody': Object // {map[String, Object]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.dslSearchCreateFile(requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.dslSearchCreateFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->dslSearchCreateFile($requestBody);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->dslSearchCreateFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.dsl_search_create_file(requestBody=requestBody)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->dslSearchCreateFile: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let requestBody = Object; // map[String, Object]

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.dslSearchCreateFile(requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
requestBody

Responses


executeSavedSearchByGuid

Attribute based search for entities satisfying the search parameters


/v2/search/saved/execute/guid/{guid}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/saved/execute/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String guid = guid_example; // String | Guid identifying saved search

        try {
            AtlasSearchResult result = apiInstance.executeSavedSearchByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#executeSavedSearchByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | Guid identifying saved search

try {
    final result = await api_instance.executeSavedSearchByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeSavedSearchByGuid: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String guid = guid_example; // String | Guid identifying saved search

        try {
            AtlasSearchResult result = apiInstance.executeSavedSearchByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#executeSavedSearchByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *guid = guid_example; // Guid identifying saved search (default to null)

[apiInstance executeSavedSearchByGuidWith:guid
              completionHandler: ^(AtlasSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var guid = guid_example; // {String} Guid identifying saved search

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var guid = guid_example;  // String | Guid identifying saved search (default to null)

            try {
                AtlasSearchResult result = apiInstance.executeSavedSearchByGuid(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.executeSavedSearchByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$guid = guid_example; // String | Guid identifying saved search

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $guid = guid_example; # String | Guid identifying saved search

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
guid = guid_example # String | Guid identifying saved search (default to null)

try:
    api_response = api_instance.execute_saved_search_by_guid(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->executeSavedSearchByGuid: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.executeSavedSearchByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Guid identifying saved search
Required

Responses


executeSavedSearchByName

Attribute based search for entities satisfying the search parameters


/v2/search/saved/execute/{name}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/saved/execute/{name}?user=user_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String name = name_example; // String | name of saved-search
        String user = user_example; // String | saved-search owner

        try {
            AtlasSearchResult result = apiInstance.executeSavedSearchByName(name, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#executeSavedSearchByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | name of saved-search
final String user = new String(); // String | saved-search owner

try {
    final result = await api_instance.executeSavedSearchByName(name, user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->executeSavedSearchByName: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String name = name_example; // String | name of saved-search
        String user = user_example; // String | saved-search owner

        try {
            AtlasSearchResult result = apiInstance.executeSavedSearchByName(name, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#executeSavedSearchByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *name = name_example; // name of saved-search (default to null)
String *user = user_example; // saved-search owner (optional) (default to null)

[apiInstance executeSavedSearchByNameWith:name
    user:user
              completionHandler: ^(AtlasSearchResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var name = name_example; // {String} name of saved-search
var opts = {
  'user': user_example // {String} saved-search owner
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var name = name_example;  // String | name of saved-search (default to null)
            var user = user_example;  // String | saved-search owner (optional)  (default to null)

            try {
                AtlasSearchResult result = apiInstance.executeSavedSearchByName(name, user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.executeSavedSearchByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$name = name_example; // String | name of saved-search
$user = user_example; // String | saved-search owner

try {
    $result = $api_instance->executeSavedSearchByName($name, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->executeSavedSearchByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $name = name_example; # String | name of saved-search
my $user = user_example; # String | saved-search owner

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
name = name_example # String | name of saved-search (default to null)
user = user_example # String | saved-search owner (optional) (default to null)

try:
    api_response = api_instance.execute_saved_search_by_name(name, user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->executeSavedSearchByName: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let name = name_example; // String
    let user = user_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.executeSavedSearchByName(name, user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
name of saved-search
Required
Query parameters
Name Description
user
String
saved-search owner

Responses


getSavedSearch


/v2/search/saved/{name}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/saved/{name}?user=user_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String name = name_example; // String | Name of the saved search
        String user = user_example; // String | User for whom the search is retrieved

        try {
            AtlasUserSavedSearch result = apiInstance.getSavedSearch(name, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSavedSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Name of the saved search
final String user = new String(); // String | User for whom the search is retrieved

try {
    final result = await api_instance.getSavedSearch(name, user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSavedSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String name = name_example; // String | Name of the saved search
        String user = user_example; // String | User for whom the search is retrieved

        try {
            AtlasUserSavedSearch result = apiInstance.getSavedSearch(name, user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSavedSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *name = name_example; // Name of the saved search (default to null)
String *user = user_example; // User for whom the search is retrieved (optional) (default to null)

[apiInstance getSavedSearchWith:name
    user:user
              completionHandler: ^(AtlasUserSavedSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var name = name_example; // {String} Name of the saved search
var opts = {
  'user': user_example // {String} User for whom the search is retrieved
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var name = name_example;  // String | Name of the saved search (default to null)
            var user = user_example;  // String | User for whom the search is retrieved (optional)  (default to null)

            try {
                AtlasUserSavedSearch result = apiInstance.getSavedSearch(name, user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.getSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$name = name_example; // String | Name of the saved search
$user = user_example; // String | User for whom the search is retrieved

try {
    $result = $api_instance->getSavedSearch($name, $user);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->getSavedSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $name = name_example; # String | Name of the saved search
my $user = user_example; # String | User for whom the search is retrieved

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
name = name_example # String | Name of the saved search (default to null)
user = user_example # String | User for whom the search is retrieved (optional) (default to null)

try:
    api_response = api_instance.get_saved_search(name, user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->getSavedSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let name = name_example; // String
    let user = user_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.getSavedSearch(name, user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Name of the saved search
Required
Query parameters
Name Description
user
String
User for whom the search is retrieved

Responses


getSavedSearches


/v2/search/saved

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/saved?user=user_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String user = user_example; // String | User for whom the search is retrieved

        try {
            array[AtlasUserSavedSearch] result = apiInstance.getSavedSearches(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSavedSearches");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String user = new String(); // String | User for whom the search is retrieved

try {
    final result = await api_instance.getSavedSearches(user);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSavedSearches: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String user = user_example; // String | User for whom the search is retrieved

        try {
            array[AtlasUserSavedSearch] result = apiInstance.getSavedSearches(user);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSavedSearches");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *user = user_example; // User for whom the search is retrieved (optional) (default to null)

[apiInstance getSavedSearchesWith:user
              completionHandler: ^(array[AtlasUserSavedSearch] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'user': user_example // {String} User for whom the search is retrieved
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var user = user_example;  // String | User for whom the search is retrieved (optional)  (default to null)

            try {
                array[AtlasUserSavedSearch] result = apiInstance.getSavedSearches(user);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.getSavedSearches: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$user = user_example; // String | User for whom the search is retrieved

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $user = user_example; # String | User for whom the search is retrieved

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
user = user_example # String | User for whom the search is retrieved (optional) (default to null)

try:
    api_response = api_instance.get_saved_searches(user=user)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->getSavedSearches: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let user = user_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.getSavedSearches(user, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
user
String
User for whom the search is retrieved

Responses


getSearchResultDownloadStatus


/v2/search/download/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/download/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();

        try {
            AtlasSearchResultDownloadStatus result = apiInstance.getSearchResultDownloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSearchResultDownloadStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getSearchResultDownloadStatus();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSearchResultDownloadStatus: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();

        try {
            AtlasSearchResultDownloadStatus result = apiInstance.getSearchResultDownloadStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSearchResultDownloadStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];

[apiInstance getSearchResultDownloadStatusWithCompletionHandler: 
              ^(AtlasSearchResultDownloadStatus output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSearchResultDownloadStatus(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();

            try {
                AtlasSearchResultDownloadStatus result = apiInstance.getSearchResultDownloadStatus();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.getSearchResultDownloadStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()

try:
    api_response = api_instance.get_search_result_download_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->getSearchResultDownloadStatus: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.getSearchResultDownloadStatus(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getSuggestions


/v2/search/suggestions

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/search/suggestions?fieldName=fieldName_example&prefixString=prefixString_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String fieldName = fieldName_example; // String | 
        String prefixString = prefixString_example; // String | 

        try {
            AtlasSuggestionsResult result = apiInstance.getSuggestions(fieldName, prefixString);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSuggestions");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fieldName = new String(); // String | 
final String prefixString = new String(); // String | 

try {
    final result = await api_instance.getSuggestions(fieldName, prefixString);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getSuggestions: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        String fieldName = fieldName_example; // String | 
        String prefixString = prefixString_example; // String | 

        try {
            AtlasSuggestionsResult result = apiInstance.getSuggestions(fieldName, prefixString);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#getSuggestions");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
String *fieldName = fieldName_example; //  (optional) (default to null)
String *prefixString = prefixString_example; //  (optional) (default to null)

[apiInstance getSuggestionsWith:fieldName
    prefixString:prefixString
              completionHandler: ^(AtlasSuggestionsResult output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'fieldName': fieldName_example, // {String} 
  'prefixString': prefixString_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var fieldName = fieldName_example;  // String |  (optional)  (default to null)
            var prefixString = prefixString_example;  // String |  (optional)  (default to null)

            try {
                AtlasSuggestionsResult result = apiInstance.getSuggestions(fieldName, prefixString);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.getSuggestions: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$fieldName = fieldName_example; // String | 
$prefixString = prefixString_example; // String | 

try {
    $result = $api_instance->getSuggestions($fieldName, $prefixString);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->getSuggestions: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $fieldName = fieldName_example; # String | 
my $prefixString = prefixString_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
fieldName = fieldName_example # String |  (optional) (default to null)
prefixString = prefixString_example # String |  (optional) (default to null)

try:
    api_response = api_instance.get_suggestions(fieldName=fieldName, prefixString=prefixString)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->getSuggestions: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let fieldName = fieldName_example; // String
    let prefixString = prefixString_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.getSuggestions(fieldName, prefixString, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
fieldName
String
prefixString
String

Responses


quickSearch

Attribute based search for entities satisfying the search parameters


/v2/search/quick

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/quick?excludeDeletedEntities=true&limit=56&offset=56&query=query_example&sortBy=sortBy_example&sortOrder=sortOrder_example&typeName=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String query = query_example; // String | 
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String typeName = typeName_example; // String | 

        try {
            apiInstance.quickSearch(excludeDeletedEntities, limit, offset, query, sortBy, sortOrder, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#quickSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Boolean excludeDeletedEntities = new Boolean(); // Boolean | 
final Integer limit = new Integer(); // Integer | 
final Integer offset = new Integer(); // Integer | 
final String query = new String(); // String | 
final String sortBy = new String(); // String | 
final String sortOrder = new String(); // String | 
final String typeName = new String(); // String | 

try {
    final result = await api_instance.quickSearch(excludeDeletedEntities, limit, offset, query, sortBy, sortOrder, typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->quickSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String query = query_example; // String | 
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String typeName = typeName_example; // String | 

        try {
            apiInstance.quickSearch(excludeDeletedEntities, limit, offset, query, sortBy, sortOrder, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#quickSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Boolean *excludeDeletedEntities = true; //  (default to null)
Integer *limit = 56; //  (default to null)
Integer *offset = 56; //  (default to null)
String *query = query_example; //  (optional) (default to null)
String *sortBy = sortBy_example; //  (optional) (default to null)
String *sortOrder = sortOrder_example; //  (optional) (default to null)
String *typeName = typeName_example; //  (optional) (default to null)

[apiInstance quickSearchWith:excludeDeletedEntities
    limit:limit
    offset:offset
    query:query
    sortBy:sortBy
    sortOrder:sortOrder
    typeName:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var excludeDeletedEntities = true; // {Boolean} 
var limit = 56; // {Integer} 
var offset = 56; // {Integer} 
var opts = {
  'query': query_example, // {String} 
  'sortBy': sortBy_example, // {String} 
  'sortOrder': sortOrder_example, // {String} 
  'typeName': typeName_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.quickSearch(excludeDeletedEntities, limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var excludeDeletedEntities = true;  // Boolean |  (default to null)
            var limit = 56;  // Integer |  (default to null)
            var offset = 56;  // Integer |  (default to null)
            var query = query_example;  // String |  (optional)  (default to null)
            var sortBy = sortBy_example;  // String |  (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String |  (optional)  (default to null)
            var typeName = typeName_example;  // String |  (optional)  (default to null)

            try {
                apiInstance.quickSearch(excludeDeletedEntities, limit, offset, query, sortBy, sortOrder, typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.quickSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$excludeDeletedEntities = true; // Boolean | 
$limit = 56; // Integer | 
$offset = 56; // Integer | 
$query = query_example; // String | 
$sortBy = sortBy_example; // String | 
$sortOrder = sortOrder_example; // String | 
$typeName = typeName_example; // String | 

try {
    $api_instance->quickSearch($excludeDeletedEntities, $limit, $offset, $query, $sortBy, $sortOrder, $typeName);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->quickSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $excludeDeletedEntities = true; # Boolean | 
my $limit = 56; # Integer | 
my $offset = 56; # Integer | 
my $query = query_example; # String | 
my $sortBy = sortBy_example; # String | 
my $sortOrder = sortOrder_example; # String | 
my $typeName = typeName_example; # String | 

eval {
    $api_instance->quickSearch(excludeDeletedEntities => $excludeDeletedEntities, limit => $limit, offset => $offset, query => $query, sortBy => $sortBy, sortOrder => $sortOrder, typeName => $typeName);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->quickSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
excludeDeletedEntities = true # Boolean |  (default to null)
limit = 56 # Integer |  (default to null)
offset = 56 # Integer |  (default to null)
query = query_example # String |  (optional) (default to null)
sortBy = sortBy_example # String |  (optional) (default to null)
sortOrder = sortOrder_example # String |  (optional) (default to null)
typeName = typeName_example # String |  (optional) (default to null)

try:
    api_instance.quick_search(excludeDeletedEntities, limit, offset, query=query, sortBy=sortBy, sortOrder=sortOrder, typeName=typeName)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->quickSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let excludeDeletedEntities = true; // Boolean
    let limit = 56; // Integer
    let offset = 56; // Integer
    let query = query_example; // String
    let sortBy = sortBy_example; // String
    let sortOrder = sortOrder_example; // String
    let typeName = typeName_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.quickSearch(excludeDeletedEntities, limit, offset, query, sortBy, sortOrder, typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
excludeDeletedEntities*
Boolean
Required
limit*
Integer (int32)
Required
offset*
Integer (int32)
Required
query
String
sortBy
String
sortOrder
String
typeName
String

Responses


quickSearch2

Attribute based search for entities satisfying the search parameters


/v2/search/quick

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/quick" \
 -d '{
  "attributes" : [ "...", "..." ],
  "entityFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "AND",
    "criterion" : [ { }, { } ],
    "operator" : "NEQ"
  },
  "excludeDeletedEntities" : true,
  "excludeHeaderAttributes" : true,
  "includeSubTypes" : true,
  "limit" : 12345,
  "offset" : 12345,
  "query" : "...",
  "sortBy" : "...",
  "sortOrder" : "ASCENDING",
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        QuickSearchParameters quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."}; // QuickSearchParameters | 

        try {
            apiInstance.quickSearch2(quickSearchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#quickSearch2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final QuickSearchParameters quickSearchParameters = new QuickSearchParameters(); // QuickSearchParameters | 

try {
    final result = await api_instance.quickSearch2(quickSearchParameters);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->quickSearch2: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        QuickSearchParameters quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."}; // QuickSearchParameters | 

        try {
            apiInstance.quickSearch2(quickSearchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#quickSearch2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
QuickSearchParameters *quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."}; //  (optional)

[apiInstance quickSearch2With:quickSearchParameters
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'quickSearchParameters': {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."} // {QuickSearchParameters} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var quickSearchParameters = new QuickSearchParameters(); // QuickSearchParameters |  (optional) 

            try {
                apiInstance.quickSearch2(quickSearchParameters);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.quickSearch2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."}; // QuickSearchParameters | 

try {
    $api_instance->quickSearch2($quickSearchParameters);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->quickSearch2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $quickSearchParameters = WWW::OPenAPIClient::Object::QuickSearchParameters->new(); # QuickSearchParameters | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."} # QuickSearchParameters |  (optional)

try:
    api_instance.quick_search2(quickSearchParameters=quickSearchParameters)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->quickSearch2: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let quickSearchParameters = {"attributes":["...","..."],"entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeSubTypes":true,"limit":12345,"offset":12345,"query":"...","sortBy":"...","sortOrder":"DESCENDING","typeName":"..."}; // QuickSearchParameters

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.quickSearch2(quickSearchParameters, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
quickSearchParameters

Responses


relationSearch

Relationship search to search for relations(edges)


/v2/search/relations

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/relations?limit=56&marker=marker_example&offset=56&relationshipName=relationshipName_example&sortBy=sortBy_example&sortOrder=sortOrder_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String marker = marker_example; // String | 
        String relationshipName = relationshipName_example; // String | AtlasRelationshipType name
        String sortBy = sortBy_example; // String | sort the result using this attribute name, default value is 'name'
        String sortOrder = sortOrder_example; // String | sorting order

        try {
            apiInstance.relationSearch(limit, offset, marker, relationshipName, sortBy, sortOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#relationSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final String marker = new String(); // String | 
final String relationshipName = new String(); // String | AtlasRelationshipType name
final String sortBy = new String(); // String | sort the result using this attribute name, default value is 'name'
final String sortOrder = new String(); // String | sorting order

try {
    final result = await api_instance.relationSearch(limit, offset, marker, relationshipName, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->relationSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String marker = marker_example; // String | 
        String relationshipName = relationshipName_example; // String | AtlasRelationshipType name
        String sortBy = sortBy_example; // String | sort the result using this attribute name, default value is 'name'
        String sortOrder = sortOrder_example; // String | sorting order

        try {
            apiInstance.relationSearch(limit, offset, marker, relationshipName, sortBy, sortOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#relationSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
String *marker = marker_example; //  (optional) (default to null)
String *relationshipName = relationshipName_example; // AtlasRelationshipType name (optional) (default to null)
String *sortBy = sortBy_example; // sort the result using this attribute name, default value is 'name' (optional) (default to null)
String *sortOrder = sortOrder_example; // sorting order (optional) (default to null)

[apiInstance relationSearchWith:limit
    offset:offset
    marker:marker
    relationshipName:relationshipName
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'marker': marker_example, // {String} 
  'relationshipName': relationshipName_example, // {String} AtlasRelationshipType name
  'sortBy': sortBy_example, // {String} sort the result using this attribute name, default value is 'name'
  'sortOrder': sortOrder_example // {String} sorting order
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.relationSearch(limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var marker = marker_example;  // String |  (optional)  (default to null)
            var relationshipName = relationshipName_example;  // String | AtlasRelationshipType name (optional)  (default to null)
            var sortBy = sortBy_example;  // String | sort the result using this attribute name, default value is 'name' (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String | sorting order (optional)  (default to null)

            try {
                apiInstance.relationSearch(limit, offset, marker, relationshipName, sortBy, sortOrder);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.relationSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$marker = marker_example; // String | 
$relationshipName = relationshipName_example; // String | AtlasRelationshipType name
$sortBy = sortBy_example; // String | sort the result using this attribute name, default value is 'name'
$sortOrder = sortOrder_example; // String | sorting order

try {
    $api_instance->relationSearch($limit, $offset, $marker, $relationshipName, $sortBy, $sortOrder);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->relationSearch: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $marker = marker_example; # String | 
my $relationshipName = relationshipName_example; # String | AtlasRelationshipType name
my $sortBy = sortBy_example; # String | sort the result using this attribute name, default value is 'name'
my $sortOrder = sortOrder_example; # String | sorting order

eval {
    $api_instance->relationSearch(limit => $limit, offset => $offset, marker => $marker, relationshipName => $relationshipName, sortBy => $sortBy, sortOrder => $sortOrder);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->relationSearch: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
marker = marker_example # String |  (optional) (default to null)
relationshipName = relationshipName_example # String | AtlasRelationshipType name (optional) (default to null)
sortBy = sortBy_example # String | sort the result using this attribute name, default value is 'name' (optional) (default to null)
sortOrder = sortOrder_example # String | sorting order (optional) (default to null)

try:
    api_instance.relation_search(limit, offset, marker=marker, relationshipName=relationshipName, sortBy=sortBy, sortOrder=sortOrder)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->relationSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer
    let marker = marker_example; // String
    let relationshipName = relationshipName_example; // String
    let sortBy = sortBy_example; // String
    let sortOrder = sortOrder_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.relationSearch(limit, offset, marker, relationshipName, sortBy, sortOrder, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
marker
String
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
relationshipName
String
AtlasRelationshipType name
sortBy
String
sort the result using this attribute name, default value is 'name'
sortOrder
String
sorting order

Responses


relationSearch2

Relationship search to search for relations(edges)


/v2/search/relations

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/relations" \
 -d '{
  "includeSubTypes" : true,
  "limit" : 12345,
  "marker" : "...",
  "offset" : 12345,
  "relationshipFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "NOT_EMPTY"
  },
  "relationshipName" : "...",
  "sortBy" : "...",
  "sortOrder" : "ASCENDING"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        RelationshipSearchParameters relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"}; // RelationshipSearchParameters | 

        try {
            apiInstance.relationSearch2(relationshipSearchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#relationSearch2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final RelationshipSearchParameters relationshipSearchParameters = new RelationshipSearchParameters(); // RelationshipSearchParameters | 

try {
    final result = await api_instance.relationSearch2(relationshipSearchParameters);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->relationSearch2: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        RelationshipSearchParameters relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"}; // RelationshipSearchParameters | 

        try {
            apiInstance.relationSearch2(relationshipSearchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#relationSearch2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
RelationshipSearchParameters *relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"}; //  (optional)

[apiInstance relationSearch2With:relationshipSearchParameters
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'relationshipSearchParameters': {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"} // {RelationshipSearchParameters} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var relationshipSearchParameters = new RelationshipSearchParameters(); // RelationshipSearchParameters |  (optional) 

            try {
                apiInstance.relationSearch2(relationshipSearchParameters);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.relationSearch2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"}; // RelationshipSearchParameters | 

try {
    $api_instance->relationSearch2($relationshipSearchParameters);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->relationSearch2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $relationshipSearchParameters = WWW::OPenAPIClient::Object::RelationshipSearchParameters->new(); # RelationshipSearchParameters | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"} # RelationshipSearchParameters |  (optional)

try:
    api_instance.relation_search2(relationshipSearchParameters=relationshipSearchParameters)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->relationSearch2: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let relationshipSearchParameters = {"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"CONTAINS_ANY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING"}; // RelationshipSearchParameters

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.relationSearch2(relationshipSearchParameters, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
relationshipSearchParameters

RelationshipSearchParameters

Responses


searchRelatedEntities

Relationship search to search for related entities satisfying the search parameters


/v2/search/relationship

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/relationship?attributes=&disableDefaultSorting=true&excludeDeletedEntities=true&getApproximateCount=true&guid=guid_example&includeClassificationAttributes=true&limit=56&offset=56&relation=relation_example&sortBy=sortBy_example&sortOrder=sortOrder_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | exclude deleted entities from results
        Boolean getApproximateCount = true; // Boolean | calculate and return approximate count of total relationships
        Boolean includeClassificationAttributes = true; // Boolean | include classification attributes in result entities
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        array[String] attributes = ; // array[String] | set of attributes to include in search result
        Boolean disableDefaultSorting = true; // Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
        String guid = guid_example; // String | entity GUID
        String relation = relation_example; // String | relationship name or attribute name
        String sortBy = sortBy_example; // String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
        String sortOrder = sortOrder_example; // String | sorting order (ASCENDING or DESCENDING)

        try {
            apiInstance.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes, disableDefaultSorting, guid, relation, sortBy, sortOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchRelatedEntities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Boolean excludeDeletedEntities = new Boolean(); // Boolean | exclude deleted entities from results
final Boolean getApproximateCount = new Boolean(); // Boolean | calculate and return approximate count of total relationships
final Boolean includeClassificationAttributes = new Boolean(); // Boolean | include classification attributes in result entities
final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final array[String] attributes = new array[String](); // array[String] | set of attributes to include in search result
final Boolean disableDefaultSorting = new Boolean(); // Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
final String guid = new String(); // String | entity GUID
final String relation = new String(); // String | relationship name or attribute name
final String sortBy = new String(); // String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
final String sortOrder = new String(); // String | sorting order (ASCENDING or DESCENDING)

try {
    final result = await api_instance.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes, disableDefaultSorting, guid, relation, sortBy, sortOrder);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchRelatedEntities: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | exclude deleted entities from results
        Boolean getApproximateCount = true; // Boolean | calculate and return approximate count of total relationships
        Boolean includeClassificationAttributes = true; // Boolean | include classification attributes in result entities
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        array[String] attributes = ; // array[String] | set of attributes to include in search result
        Boolean disableDefaultSorting = true; // Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
        String guid = guid_example; // String | entity GUID
        String relation = relation_example; // String | relationship name or attribute name
        String sortBy = sortBy_example; // String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
        String sortOrder = sortOrder_example; // String | sorting order (ASCENDING or DESCENDING)

        try {
            apiInstance.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes, disableDefaultSorting, guid, relation, sortBy, sortOrder);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchRelatedEntities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Boolean *excludeDeletedEntities = true; // exclude deleted entities from results (default to null)
Boolean *getApproximateCount = true; // calculate and return approximate count of total relationships (default to null)
Boolean *includeClassificationAttributes = true; // include classification attributes in result entities (default to null)
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
array[String] *attributes = ; // set of attributes to include in search result (optional) (default to null)
Boolean *disableDefaultSorting = true; // if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance (optional) (default to false)
String *guid = guid_example; // entity GUID (optional) (default to null)
String *relation = relation_example; // relationship name or attribute name (optional) (default to null)
String *sortBy = sortBy_example; // attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name') (optional) (default to null)
String *sortOrder = sortOrder_example; // sorting order (ASCENDING or DESCENDING) (optional) (default to null)

[apiInstance searchRelatedEntitiesWith:excludeDeletedEntities
    getApproximateCount:getApproximateCount
    includeClassificationAttributes:includeClassificationAttributes
    limit:limit
    offset:offset
    attributes:attributes
    disableDefaultSorting:disableDefaultSorting
    guid:guid
    relation:relation
    sortBy:sortBy
    sortOrder:sortOrder
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var excludeDeletedEntities = true; // {Boolean} exclude deleted entities from results
var getApproximateCount = true; // {Boolean} calculate and return approximate count of total relationships
var includeClassificationAttributes = true; // {Boolean} include classification attributes in result entities
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'attributes': , // {array[String]} set of attributes to include in search result
  'disableDefaultSorting': true, // {Boolean} if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
  'guid': guid_example, // {String} entity GUID
  'relation': relation_example, // {String} relationship name or attribute name
  'sortBy': sortBy_example, // {String} attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
  'sortOrder': sortOrder_example // {String} sorting order (ASCENDING or DESCENDING)
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var excludeDeletedEntities = true;  // Boolean | exclude deleted entities from results (default to null)
            var getApproximateCount = true;  // Boolean | calculate and return approximate count of total relationships (default to null)
            var includeClassificationAttributes = true;  // Boolean | include classification attributes in result entities (default to null)
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var attributes = new array[String](); // array[String] | set of attributes to include in search result (optional)  (default to null)
            var disableDefaultSorting = true;  // Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance (optional)  (default to false)
            var guid = guid_example;  // String | entity GUID (optional)  (default to null)
            var relation = relation_example;  // String | relationship name or attribute name (optional)  (default to null)
            var sortBy = sortBy_example;  // String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name') (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String | sorting order (ASCENDING or DESCENDING) (optional)  (default to null)

            try {
                apiInstance.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes, disableDefaultSorting, guid, relation, sortBy, sortOrder);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchRelatedEntities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$excludeDeletedEntities = true; // Boolean | exclude deleted entities from results
$getApproximateCount = true; // Boolean | calculate and return approximate count of total relationships
$includeClassificationAttributes = true; // Boolean | include classification attributes in result entities
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$attributes = ; // array[String] | set of attributes to include in search result
$disableDefaultSorting = true; // Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
$guid = guid_example; // String | entity GUID
$relation = relation_example; // String | relationship name or attribute name
$sortBy = sortBy_example; // String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
$sortOrder = sortOrder_example; // String | sorting order (ASCENDING or DESCENDING)

try {
    $api_instance->searchRelatedEntities($excludeDeletedEntities, $getApproximateCount, $includeClassificationAttributes, $limit, $offset, $attributes, $disableDefaultSorting, $guid, $relation, $sortBy, $sortOrder);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchRelatedEntities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $excludeDeletedEntities = true; # Boolean | exclude deleted entities from results
my $getApproximateCount = true; # Boolean | calculate and return approximate count of total relationships
my $includeClassificationAttributes = true; # Boolean | include classification attributes in result entities
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $attributes = []; # array[String] | set of attributes to include in search result
my $disableDefaultSorting = true; # Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
my $guid = guid_example; # String | entity GUID
my $relation = relation_example; # String | relationship name or attribute name
my $sortBy = sortBy_example; # String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
my $sortOrder = sortOrder_example; # String | sorting order (ASCENDING or DESCENDING)

eval {
    $api_instance->searchRelatedEntities(excludeDeletedEntities => $excludeDeletedEntities, getApproximateCount => $getApproximateCount, includeClassificationAttributes => $includeClassificationAttributes, limit => $limit, offset => $offset, attributes => $attributes, disableDefaultSorting => $disableDefaultSorting, guid => $guid, relation => $relation, sortBy => $sortBy, sortOrder => $sortOrder);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->searchRelatedEntities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
excludeDeletedEntities = true # Boolean | exclude deleted entities from results (default to null)
getApproximateCount = true # Boolean | calculate and return approximate count of total relationships (default to null)
includeClassificationAttributes = true # Boolean | include classification attributes in result entities (default to null)
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
attributes =  # array[String] | set of attributes to include in search result (optional) (default to null)
disableDefaultSorting = true # Boolean | if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance (optional) (default to false)
guid = guid_example # String | entity GUID (optional) (default to null)
relation = relation_example # String | relationship name or attribute name (optional) (default to null)
sortBy = sortBy_example # String | attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name') (optional) (default to null)
sortOrder = sortOrder_example # String | sorting order (ASCENDING or DESCENDING) (optional) (default to null)

try:
    api_instance.search_related_entities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes=attributes, disableDefaultSorting=disableDefaultSorting, guid=guid, relation=relation, sortBy=sortBy, sortOrder=sortOrder)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchRelatedEntities: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let excludeDeletedEntities = true; // Boolean
    let getApproximateCount = true; // Boolean
    let includeClassificationAttributes = true; // Boolean
    let limit = 56; // Integer
    let offset = 56; // Integer
    let attributes = ; // array[String]
    let disableDefaultSorting = true; // Boolean
    let guid = guid_example; // String
    let relation = relation_example; // String
    let sortBy = sortBy_example; // String
    let sortOrder = sortOrder_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchRelatedEntities(excludeDeletedEntities, getApproximateCount, includeClassificationAttributes, limit, offset, attributes, disableDefaultSorting, guid, relation, sortBy, sortOrder, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
attributes
array[String]
set of attributes to include in search result
disableDefaultSorting
Boolean
if true, disables default sorting by 'name' when sortByAttribute is not specified; allows unsorted results for better performance
excludeDeletedEntities*
Boolean
exclude deleted entities from results
Required
getApproximateCount*
Boolean
calculate and return approximate count of total relationships
Required
guid
String
entity GUID
includeClassificationAttributes*
Boolean
include classification attributes in result entities
Required
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
relation
String
relationship name or attribute name
sortBy
String
attribute name to sort results by (if not specified and disableDefaultSorting=false, defaults to 'name')
sortOrder
String
sorting order (ASCENDING or DESCENDING)

Responses


searchUsingAttribute

Retrieve data for the specified attribute search query


/v2/search/attribute

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/attribute?attrName=attrName_example&attrValuePrefix=attrValuePrefix_example&limit=56&offset=56&typeName=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String attrName = attrName_example; // String | Attribute name
        String attrValuePrefix = attrValuePrefix_example; // String | Attibute value to search on
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingAttribute(limit, offset, attrName, attrValuePrefix, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final String attrName = new String(); // String | Attribute name
final String attrValuePrefix = new String(); // String | Attibute value to search on
final String typeName = new String(); // String | limit the result to only entities of specified type or its sub-types

try {
    final result = await api_instance.searchUsingAttribute(limit, offset, attrName, attrValuePrefix, typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsingAttribute: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String attrName = attrName_example; // String | Attribute name
        String attrValuePrefix = attrValuePrefix_example; // String | Attibute value to search on
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingAttribute(limit, offset, attrName, attrValuePrefix, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
String *attrName = attrName_example; // Attribute name (optional) (default to null)
String *attrValuePrefix = attrValuePrefix_example; // Attibute value to search on (optional) (default to null)
String *typeName = typeName_example; // limit the result to only entities of specified type or its sub-types (optional) (default to null)

[apiInstance searchUsingAttributeWith:limit
    offset:offset
    attrName:attrName
    attrValuePrefix:attrValuePrefix
    typeName:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'attrName': attrName_example, // {String} Attribute name
  'attrValuePrefix': attrValuePrefix_example, // {String} Attibute value to search on
  'typeName': typeName_example // {String} limit the result to only entities of specified type or its sub-types
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchUsingAttribute(limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var attrName = attrName_example;  // String | Attribute name (optional)  (default to null)
            var attrValuePrefix = attrValuePrefix_example;  // String | Attibute value to search on (optional)  (default to null)
            var typeName = typeName_example;  // String | limit the result to only entities of specified type or its sub-types (optional)  (default to null)

            try {
                apiInstance.searchUsingAttribute(limit, offset, attrName, attrValuePrefix, typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchUsingAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$attrName = attrName_example; // String | Attribute name
$attrValuePrefix = attrValuePrefix_example; // String | Attibute value to search on
$typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

try {
    $api_instance->searchUsingAttribute($limit, $offset, $attrName, $attrValuePrefix, $typeName);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchUsingAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $attrName = attrName_example; # String | Attribute name
my $attrValuePrefix = attrValuePrefix_example; # String | Attibute value to search on
my $typeName = typeName_example; # String | limit the result to only entities of specified type or its sub-types

eval {
    $api_instance->searchUsingAttribute(limit => $limit, offset => $offset, attrName => $attrName, attrValuePrefix => $attrValuePrefix, typeName => $typeName);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->searchUsingAttribute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
attrName = attrName_example # String | Attribute name (optional) (default to null)
attrValuePrefix = attrValuePrefix_example # String | Attibute value to search on (optional) (default to null)
typeName = typeName_example # String | limit the result to only entities of specified type or its sub-types (optional) (default to null)

try:
    api_instance.search_using_attribute(limit, offset, attrName=attrName, attrValuePrefix=attrValuePrefix, typeName=typeName)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchUsingAttribute: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer
    let attrName = attrName_example; // String
    let attrValuePrefix = attrValuePrefix_example; // String
    let typeName = typeName_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchUsingAttribute(limit, offset, attrName, attrValuePrefix, typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
attrName
String
Attribute name
attrValuePrefix
String
Attibute value to search on
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
typeName
String
limit the result to only entities of specified type or its sub-types

Responses


searchUsingBasic

Retrieve data for the specified fulltext query


/v2/search/basic

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/basic?classification=classification_example&excludeDeletedEntities=true&limit=56&marker=marker_example&offset=56&query=query_example&sortBy=sortBy_example&sortOrder=sortOrder_example&typeName=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
        String marker = marker_example; // String | 
        String query = query_example; // String | Fulltext query
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingBasic(excludeDeletedEntities, limit, offset, classification, marker, query, sortBy, sortOrder, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingBasic");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Boolean excludeDeletedEntities = new Boolean(); // Boolean | 
final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final String classification = new String(); // String | limit the result to only entities tagged with the given classification or or its sub-types
final String marker = new String(); // String | 
final String query = new String(); // String | Fulltext query
final String sortBy = new String(); // String | 
final String sortOrder = new String(); // String | 
final String typeName = new String(); // String | limit the result to only entities of specified type or its sub-types

try {
    final result = await api_instance.searchUsingBasic(excludeDeletedEntities, limit, offset, classification, marker, query, sortBy, sortOrder, typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsingBasic: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
        String marker = marker_example; // String | 
        String query = query_example; // String | Fulltext query
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingBasic(excludeDeletedEntities, limit, offset, classification, marker, query, sortBy, sortOrder, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingBasic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Boolean *excludeDeletedEntities = true; //  (default to null)
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
String *classification = classification_example; // limit the result to only entities tagged with the given classification or or its sub-types (optional) (default to null)
String *marker = marker_example; //  (optional) (default to null)
String *query = query_example; // Fulltext query (optional) (default to null)
String *sortBy = sortBy_example; //  (optional) (default to null)
String *sortOrder = sortOrder_example; //  (optional) (default to null)
String *typeName = typeName_example; // limit the result to only entities of specified type or its sub-types (optional) (default to null)

[apiInstance searchUsingBasicWith:excludeDeletedEntities
    limit:limit
    offset:offset
    classification:classification
    marker:marker
    query:query
    sortBy:sortBy
    sortOrder:sortOrder
    typeName:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var excludeDeletedEntities = true; // {Boolean} 
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'classification': classification_example, // {String} limit the result to only entities tagged with the given classification or or its sub-types
  'marker': marker_example, // {String} 
  'query': query_example, // {String} Fulltext query
  'sortBy': sortBy_example, // {String} 
  'sortOrder': sortOrder_example, // {String} 
  'typeName': typeName_example // {String} limit the result to only entities of specified type or its sub-types
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchUsingBasic(excludeDeletedEntities, limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var excludeDeletedEntities = true;  // Boolean |  (default to null)
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var classification = classification_example;  // String | limit the result to only entities tagged with the given classification or or its sub-types (optional)  (default to null)
            var marker = marker_example;  // String |  (optional)  (default to null)
            var query = query_example;  // String | Fulltext query (optional)  (default to null)
            var sortBy = sortBy_example;  // String |  (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String |  (optional)  (default to null)
            var typeName = typeName_example;  // String | limit the result to only entities of specified type or its sub-types (optional)  (default to null)

            try {
                apiInstance.searchUsingBasic(excludeDeletedEntities, limit, offset, classification, marker, query, sortBy, sortOrder, typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchUsingBasic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$excludeDeletedEntities = true; // Boolean | 
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
$marker = marker_example; // String | 
$query = query_example; // String | Fulltext query
$sortBy = sortBy_example; // String | 
$sortOrder = sortOrder_example; // String | 
$typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

try {
    $api_instance->searchUsingBasic($excludeDeletedEntities, $limit, $offset, $classification, $marker, $query, $sortBy, $sortOrder, $typeName);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchUsingBasic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $excludeDeletedEntities = true; # Boolean | 
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $classification = classification_example; # String | limit the result to only entities tagged with the given classification or or its sub-types
my $marker = marker_example; # String | 
my $query = query_example; # String | Fulltext query
my $sortBy = sortBy_example; # String | 
my $sortOrder = sortOrder_example; # String | 
my $typeName = typeName_example; # String | limit the result to only entities of specified type or its sub-types

eval {
    $api_instance->searchUsingBasic(excludeDeletedEntities => $excludeDeletedEntities, limit => $limit, offset => $offset, classification => $classification, marker => $marker, query => $query, sortBy => $sortBy, sortOrder => $sortOrder, typeName => $typeName);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->searchUsingBasic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
excludeDeletedEntities = true # Boolean |  (default to null)
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
classification = classification_example # String | limit the result to only entities tagged with the given classification or or its sub-types (optional) (default to null)
marker = marker_example # String |  (optional) (default to null)
query = query_example # String | Fulltext query (optional) (default to null)
sortBy = sortBy_example # String |  (optional) (default to null)
sortOrder = sortOrder_example # String |  (optional) (default to null)
typeName = typeName_example # String | limit the result to only entities of specified type or its sub-types (optional) (default to null)

try:
    api_instance.search_using_basic(excludeDeletedEntities, limit, offset, classification=classification, marker=marker, query=query, sortBy=sortBy, sortOrder=sortOrder, typeName=typeName)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchUsingBasic: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let excludeDeletedEntities = true; // Boolean
    let limit = 56; // Integer
    let offset = 56; // Integer
    let classification = classification_example; // String
    let marker = marker_example; // String
    let query = query_example; // String
    let sortBy = sortBy_example; // String
    let sortOrder = sortOrder_example; // String
    let typeName = typeName_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchUsingBasic(excludeDeletedEntities, limit, offset, classification, marker, query, sortBy, sortOrder, typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
classification
String
limit the result to only entities tagged with the given classification or or its sub-types
excludeDeletedEntities*
Boolean
Required
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
marker
String
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
query
String
Fulltext query
sortBy
String
sortOrder
String
typeName
String
limit the result to only entities of specified type or its sub-types

Responses


searchUsingDSL

Retrieve data for the specified DSL


/v2/search/dsl

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/dsl?classification=classification_example&limit=56&offset=56&query=query_example&typeName=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
        String query = query_example; // String | DSL query
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingDSL(limit, offset, classification, query, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingDSL");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final String classification = new String(); // String | limit the result to only entities tagged with the given classification or or its sub-types
final String query = new String(); // String | DSL query
final String typeName = new String(); // String | limit the result to only entities of specified type or its sub-types

try {
    final result = await api_instance.searchUsingDSL(limit, offset, classification, query, typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsingDSL: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
        String query = query_example; // String | DSL query
        String typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

        try {
            apiInstance.searchUsingDSL(limit, offset, classification, query, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingDSL");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
String *classification = classification_example; // limit the result to only entities tagged with the given classification or or its sub-types (optional) (default to null)
String *query = query_example; // DSL query (optional) (default to null)
String *typeName = typeName_example; // limit the result to only entities of specified type or its sub-types (optional) (default to null)

[apiInstance searchUsingDSLWith:limit
    offset:offset
    classification:classification
    query:query
    typeName:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'classification': classification_example, // {String} limit the result to only entities tagged with the given classification or or its sub-types
  'query': query_example, // {String} DSL query
  'typeName': typeName_example // {String} limit the result to only entities of specified type or its sub-types
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchUsingDSL(limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var classification = classification_example;  // String | limit the result to only entities tagged with the given classification or or its sub-types (optional)  (default to null)
            var query = query_example;  // String | DSL query (optional)  (default to null)
            var typeName = typeName_example;  // String | limit the result to only entities of specified type or its sub-types (optional)  (default to null)

            try {
                apiInstance.searchUsingDSL(limit, offset, classification, query, typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchUsingDSL: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$classification = classification_example; // String | limit the result to only entities tagged with the given classification or or its sub-types
$query = query_example; // String | DSL query
$typeName = typeName_example; // String | limit the result to only entities of specified type or its sub-types

try {
    $api_instance->searchUsingDSL($limit, $offset, $classification, $query, $typeName);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchUsingDSL: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $classification = classification_example; # String | limit the result to only entities tagged with the given classification or or its sub-types
my $query = query_example; # String | DSL query
my $typeName = typeName_example; # String | limit the result to only entities of specified type or its sub-types

eval {
    $api_instance->searchUsingDSL(limit => $limit, offset => $offset, classification => $classification, query => $query, typeName => $typeName);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->searchUsingDSL: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
classification = classification_example # String | limit the result to only entities tagged with the given classification or or its sub-types (optional) (default to null)
query = query_example # String | DSL query (optional) (default to null)
typeName = typeName_example # String | limit the result to only entities of specified type or its sub-types (optional) (default to null)

try:
    api_instance.search_using_dsl(limit, offset, classification=classification, query=query, typeName=typeName)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchUsingDSL: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let limit = 56; // Integer
    let offset = 56; // Integer
    let classification = classification_example; // String
    let query = query_example; // String
    let typeName = typeName_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchUsingDSL(limit, offset, classification, query, typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
classification
String
limit the result to only entities tagged with the given classification or or its sub-types
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
query
String
DSL query
typeName
String
limit the result to only entities of specified type or its sub-types

Responses


searchUsingFullText

Retrieve data for the specified fulltext query


/v2/search/fulltext

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/search/fulltext?excludeDeletedEntities=true&limit=56&offset=56&query=query_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String query = query_example; // String | Fulltext query

        try {
            apiInstance.searchUsingFullText(excludeDeletedEntities, limit, offset, query);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingFullText");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Boolean excludeDeletedEntities = new Boolean(); // Boolean | 
final Integer limit = new Integer(); // Integer | limit the result set to only include the specified number of entries
final Integer offset = new Integer(); // Integer | start offset of the result set (useful for pagination)
final String query = new String(); // String | Fulltext query

try {
    final result = await api_instance.searchUsingFullText(excludeDeletedEntities, limit, offset, query);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchUsingFullText: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        Boolean excludeDeletedEntities = true; // Boolean | 
        Integer limit = 56; // Integer | limit the result set to only include the specified number of entries
        Integer offset = 56; // Integer | start offset of the result set (useful for pagination)
        String query = query_example; // String | Fulltext query

        try {
            apiInstance.searchUsingFullText(excludeDeletedEntities, limit, offset, query);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchUsingFullText");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
Boolean *excludeDeletedEntities = true; //  (default to null)
Integer *limit = 56; // limit the result set to only include the specified number of entries (default to null)
Integer *offset = 56; // start offset of the result set (useful for pagination) (default to null)
String *query = query_example; // Fulltext query (optional) (default to null)

[apiInstance searchUsingFullTextWith:excludeDeletedEntities
    limit:limit
    offset:offset
    query:query
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var excludeDeletedEntities = true; // {Boolean} 
var limit = 56; // {Integer} limit the result set to only include the specified number of entries
var offset = 56; // {Integer} start offset of the result set (useful for pagination)
var opts = {
  'query': query_example // {String} Fulltext query
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.searchUsingFullText(excludeDeletedEntities, limit, offset, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var excludeDeletedEntities = true;  // Boolean |  (default to null)
            var limit = 56;  // Integer | limit the result set to only include the specified number of entries (default to null)
            var offset = 56;  // Integer | start offset of the result set (useful for pagination) (default to null)
            var query = query_example;  // String | Fulltext query (optional)  (default to null)

            try {
                apiInstance.searchUsingFullText(excludeDeletedEntities, limit, offset, query);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchUsingFullText: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$excludeDeletedEntities = true; // Boolean | 
$limit = 56; // Integer | limit the result set to only include the specified number of entries
$offset = 56; // Integer | start offset of the result set (useful for pagination)
$query = query_example; // String | Fulltext query

try {
    $api_instance->searchUsingFullText($excludeDeletedEntities, $limit, $offset, $query);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchUsingFullText: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $excludeDeletedEntities = true; # Boolean | 
my $limit = 56; # Integer | limit the result set to only include the specified number of entries
my $offset = 56; # Integer | start offset of the result set (useful for pagination)
my $query = query_example; # String | Fulltext query

eval {
    $api_instance->searchUsingFullText(excludeDeletedEntities => $excludeDeletedEntities, limit => $limit, offset => $offset, query => $query);
};
if ($@) {
    warn "Exception when calling DiscoveryRESTApi->searchUsingFullText: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
excludeDeletedEntities = true # Boolean |  (default to null)
limit = 56 # Integer | limit the result set to only include the specified number of entries (default to null)
offset = 56 # Integer | start offset of the result set (useful for pagination) (default to null)
query = query_example # String | Fulltext query (optional) (default to null)

try:
    api_instance.search_using_full_text(excludeDeletedEntities, limit, offset, query=query)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchUsingFullText: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let excludeDeletedEntities = true; // Boolean
    let limit = 56; // Integer
    let offset = 56; // Integer
    let query = query_example; // String

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchUsingFullText(excludeDeletedEntities, limit, offset, query, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
excludeDeletedEntities*
Boolean
Required
limit*
Integer (int32)
limit the result set to only include the specified number of entries
Required
offset*
Integer (int32)
start offset of the result set (useful for pagination)
Required
query
String
Fulltext query

Responses


searchWithParameters

Attribute based search for entities satisfying the search parameters


/v2/search/basic

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/basic" \
 -d '{
  "attributes" : [ "...", "..." ],
  "classification" : "...",
  "entityFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "OR",
    "criterion" : [ { }, { } ],
    "operator" : "NOT_EMPTY"
  },
  "excludeDeletedEntities" : true,
  "excludeHeaderAttributes" : true,
  "includeClassificationAttributes" : true,
  "includeSubClassifications" : true,
  "includeSubTypes" : true,
  "limit" : 12345,
  "marker" : "...",
  "offset" : 12345,
  "query" : "...",
  "relationshipFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "AND",
    "criterion" : [ { }, { } ],
    "operator" : "IS_NULL"
  },
  "relationshipName" : "...",
  "sortBy" : "...",
  "sortOrder" : "ASCENDING",
  "tagFilters" : {
    "attributeName" : "...",
    "attributeValue" : "...",
    "condition" : "AND",
    "criterion" : [ { }, { } ],
    "operator" : "CONTAINS"
  },
  "termName" : "...",
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        SearchParameters searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."}; // SearchParameters | 

        try {
            apiInstance.searchWithParameters(searchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchWithParameters");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final SearchParameters searchParameters = new SearchParameters(); // SearchParameters | 

try {
    final result = await api_instance.searchWithParameters(searchParameters);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->searchWithParameters: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        SearchParameters searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."}; // SearchParameters | 

        try {
            apiInstance.searchWithParameters(searchParameters);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#searchWithParameters");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
SearchParameters *searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."}; //  (optional)

[apiInstance searchWithParametersWith:searchParameters
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'searchParameters': {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."} // {SearchParameters} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var searchParameters = new SearchParameters(); // SearchParameters |  (optional) 

            try {
                apiInstance.searchWithParameters(searchParameters);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.searchWithParameters: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."}; // SearchParameters | 

try {
    $api_instance->searchWithParameters($searchParameters);
} catch (Exception $e) {
    echo 'Exception when calling DiscoveryRESTApi->searchWithParameters: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DiscoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $searchParameters = WWW::OPenAPIClient::Object::SearchParameters->new(); # SearchParameters | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."} # SearchParameters |  (optional)

try:
    api_instance.search_with_parameters(searchParameters=searchParameters)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->searchWithParameters: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let searchParameters = {"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS_ALL"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"ASCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"CONTAINS"},"termName":"...","typeName":"..."}; // SearchParameters

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.searchWithParameters(searchParameters, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
searchParameters

Search parameters

Responses


updateSavedSearch


/v2/search/saved

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/search/saved" \
 -d '{
  "name" : "...",
  "ownerName" : "...",
  "searchParameters" : {
    "attributes" : [ "...", "..." ],
    "classification" : "...",
    "entityFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "AND",
      "criterion" : [ { }, { } ],
      "operator" : "LT"
    },
    "excludeDeletedEntities" : true,
    "excludeHeaderAttributes" : true,
    "includeClassificationAttributes" : true,
    "includeSubClassifications" : true,
    "includeSubTypes" : true,
    "limit" : 12345,
    "marker" : "...",
    "offset" : 12345,
    "query" : "...",
    "relationshipFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "OR",
      "criterion" : [ { }, { } ],
      "operator" : "NEQ"
    },
    "relationshipName" : "...",
    "sortBy" : "...",
    "sortOrder" : "ASCENDING",
    "tagFilters" : {
      "attributeName" : "...",
      "attributeValue" : "...",
      "condition" : "OR",
      "criterion" : [ { }, { } ],
      "operator" : "NEQ"
    },
    "termName" : "...",
    "typeName" : "..."
  },
  "searchType" : "BASIC_RELATIONSHIP",
  "uiParameters" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DiscoveryRESTApi;

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

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        AtlasUserSavedSearch atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

        try {
            AtlasUserSavedSearch result = apiInstance.updateSavedSearch(atlasUserSavedSearch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#updateSavedSearch");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasUserSavedSearch atlasUserSavedSearch = new AtlasUserSavedSearch(); // AtlasUserSavedSearch | 

try {
    final result = await api_instance.updateSavedSearch(atlasUserSavedSearch);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateSavedSearch: $e\n');
}

import org.openapitools.client.api.DiscoveryRESTApi;

public class DiscoveryRESTApiExample {
    public static void main(String[] args) {
        DiscoveryRESTApi apiInstance = new DiscoveryRESTApi();
        AtlasUserSavedSearch atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

        try {
            AtlasUserSavedSearch result = apiInstance.updateSavedSearch(atlasUserSavedSearch);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DiscoveryRESTApi#updateSavedSearch");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
DiscoveryRESTApi *apiInstance = [[DiscoveryRESTApi alloc] init];
AtlasUserSavedSearch *atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."}; //  (optional)

[apiInstance updateSavedSearchWith:atlasUserSavedSearch
              completionHandler: ^(AtlasUserSavedSearch output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.DiscoveryRESTApi()
var opts = {
  'atlasUserSavedSearch': {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."} // {AtlasUserSavedSearch} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new DiscoveryRESTApi();
            var atlasUserSavedSearch = new AtlasUserSavedSearch(); // AtlasUserSavedSearch |  (optional) 

            try {
                AtlasUserSavedSearch result = apiInstance.updateSavedSearch(atlasUserSavedSearch);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DiscoveryRESTApi.updateSavedSearch: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DiscoveryRESTApi();
$atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DiscoveryRESTApi->new();
my $atlasUserSavedSearch = WWW::OPenAPIClient::Object::AtlasUserSavedSearch->new(); # AtlasUserSavedSearch | 

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

# Create an instance of the API class
api_instance = openapi_client.DiscoveryRESTApi()
atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."} # AtlasUserSavedSearch |  (optional)

try:
    api_response = api_instance.update_saved_search(atlasUserSavedSearch=atlasUserSavedSearch)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DiscoveryRESTApi->updateSavedSearch: %s\n" % e)
extern crate DiscoveryRESTApi;

pub fn main() {
    let atlasUserSavedSearch = {"name":"...","ownerName":"...","searchParameters":{"attributes":["...","..."],"classification":"...","entityFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"ENDS_WITH"},"excludeDeletedEntities":true,"excludeHeaderAttributes":true,"includeClassificationAttributes":true,"includeSubClassifications":true,"includeSubTypes":true,"limit":12345,"marker":"...","offset":12345,"query":"...","relationshipFilters":{"attributeName":"...","attributeValue":"...","condition":"AND","criterion":[{},{}],"operator":"IS_EMPTY"},"relationshipName":"...","sortBy":"...","sortOrder":"DESCENDING","tagFilters":{"attributeName":"...","attributeValue":"...","condition":"OR","criterion":[{},{}],"operator":"EQ"},"termName":"...","typeName":"..."},"searchType":"ADVANCED","uiParameters":"...","guid":"..."}; // AtlasUserSavedSearch

    let mut context = DiscoveryRESTApi::Context::default();
    let result = client.updateSavedSearch(atlasUserSavedSearch, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasUserSavedSearch

Responses


EntityREST

addClassification

Bulk API to associate a tag to multiple entities. Option 1: List of GUIDs to associate a tag Option 2: Typename and list of uniq attributes for entities to associate a tag Option 3: List of GUIDs and Typename with list of uniq attributes for entities to associate a tag


/v2/entity/bulk/classification

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk/classification" \
 -d '{
  "classification" : {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "entitiesUniqueAttributes" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "entityGuids" : [ "...", "..." ],
  "entityTypeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        ClassificationAssociateRequest classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."}; // ClassificationAssociateRequest | 

        try {
            apiInstance.addClassification(classificationAssociateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ClassificationAssociateRequest classificationAssociateRequest = new ClassificationAssociateRequest(); // ClassificationAssociateRequest | 

try {
    final result = await api_instance.addClassification(classificationAssociateRequest);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addClassification: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        ClassificationAssociateRequest classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."}; // ClassificationAssociateRequest | 

        try {
            apiInstance.addClassification(classificationAssociateRequest);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
ClassificationAssociateRequest *classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."}; //  (optional)

[apiInstance addClassificationWith:classificationAssociateRequest
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'classificationAssociateRequest': {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."} // {ClassificationAssociateRequest} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var classificationAssociateRequest = new ClassificationAssociateRequest(); // ClassificationAssociateRequest |  (optional) 

            try {
                apiInstance.addClassification(classificationAssociateRequest);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addClassification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."}; // ClassificationAssociateRequest | 

try {
    $api_instance->addClassification($classificationAssociateRequest);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addClassification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $classificationAssociateRequest = WWW::OPenAPIClient::Object::ClassificationAssociateRequest->new(); # ClassificationAssociateRequest | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."} # ClassificationAssociateRequest |  (optional)

try:
    api_instance.add_classification(classificationAssociateRequest=classificationAssociateRequest)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addClassification: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let classificationAssociateRequest = {"classification":{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},"entitiesUniqueAttributes":[{"property1":{},"property2":{}},{"property1":{},"property2":{}}],"entityGuids":["...","..."],"entityTypeName":"..."}; // ClassificationAssociateRequest

    let mut context = EntityRESTApi::Context::default();
    let result = client.addClassification(classificationAssociateRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
classificationAssociateRequest

Responses


addClassifications

Adds classifications to an existing entity represented by a guid.


/v2/entity/guid/{guid}/classifications

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/classifications" \
 -d '{
  "entityGuid" : "...",
  "entityStatus" : "ACTIVE",
  "propagate" : true,
  "removePropagationsOnEntityDelete" : true,
  "validityPeriods" : [ {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  }, {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  } ],
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.addClassifications(guid, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassifications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | globally unique identifier for the entity
final array[AtlasClassification] atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] | 

try {
    final result = await api_instance.addClassifications(guid, atlasClassification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addClassifications: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.addClassifications(guid, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassifications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // globally unique identifier for the entity (default to null)
array[AtlasClassification] *atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; //  (optional)

[apiInstance addClassificationsWith:guid
    atlasClassification:atlasClassification
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} globally unique identifier for the entity
var opts = {
  'atlasClassification': [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] // {array[AtlasClassification]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | globally unique identifier for the entity (default to null)
            var atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] |  (optional) 

            try {
                apiInstance.addClassifications(guid, atlasClassification);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addClassifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | globally unique identifier for the entity
$atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

try {
    $api_instance->addClassifications($guid, $atlasClassification);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addClassifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | globally unique identifier for the entity
my $atlasClassification = [WWW::OPenAPIClient::Object::array[AtlasClassification]->new()]; # array[AtlasClassification] | 

eval {
    $api_instance->addClassifications(guid => $guid, atlasClassification => $atlasClassification);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addClassifications: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | globally unique identifier for the entity (default to null)
atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] # array[AtlasClassification] |  (optional)

try:
    api_instance.add_classifications(guid, atlasClassification=atlasClassification)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addClassifications: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addClassifications(guid, atlasClassification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
globally unique identifier for the entity
Required
Body parameters
Name Description
atlasClassification

Responses


addClassificationsByUniqueAttribute

Adds classification to the entity identified by its type and unique attributes.


/v2/entity/uniqueAttribute/type/{typeName}/classifications

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications" \
 -d '{
  "entityGuid" : "...",
  "entityStatus" : "ACTIVE",
  "propagate" : true,
  "removePropagationsOnEntityDelete" : true,
  "validityPeriods" : [ {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  }, {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  } ],
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.addClassificationsByUniqueAttribute(typeName, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassificationsByUniqueAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final array[AtlasClassification] atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] | 

try {
    final result = await api_instance.addClassificationsByUniqueAttribute(typeName, atlasClassification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addClassificationsByUniqueAttribute: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.addClassificationsByUniqueAttribute(typeName, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addClassificationsByUniqueAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
array[AtlasClassification] *atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; //  (optional)

[apiInstance addClassificationsByUniqueAttributeWith:typeName
    atlasClassification:atlasClassification
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'atlasClassification': [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] // {array[AtlasClassification]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] |  (optional) 

            try {
                apiInstance.addClassificationsByUniqueAttribute(typeName, atlasClassification);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addClassificationsByUniqueAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

try {
    $api_instance->addClassificationsByUniqueAttribute($typeName, $atlasClassification);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addClassificationsByUniqueAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $atlasClassification = [WWW::OPenAPIClient::Object::array[AtlasClassification]->new()]; # array[AtlasClassification] | 

eval {
    $api_instance->addClassificationsByUniqueAttribute(typeName => $typeName, atlasClassification => $atlasClassification);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addClassificationsByUniqueAttribute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] # array[AtlasClassification] |  (optional)

try:
    api_instance.add_classifications_by_unique_attribute(typeName, atlasClassification=atlasClassification)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addClassificationsByUniqueAttribute: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let atlasClassification = [{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addClassificationsByUniqueAttribute(typeName, atlasClassification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
atlasClassification

Responses


addLabels

add given labels to a given entity


/v2/entity/guid/{guid}/labels

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.addLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | - Unique entity identifier
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.addLabels(guid, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addLabels: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.addLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addLabels");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // - Unique entity identifier (default to null)
array[String] *string = ; //  (optional)

[apiInstance addLabelsWith:guid
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} - Unique entity identifier
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | - Unique entity identifier (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.addLabels(guid, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | - Unique entity identifier
$string = ; // array[String] | 

try {
    $api_instance->addLabels($guid, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | - Unique entity identifier
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->addLabels(guid => $guid, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | - Unique entity identifier (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.add_labels(guid, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addLabels: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addLabels(guid, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
- Unique entity identifier
Required
Body parameters
Name Description
string

Responses


addLabels2


/v2/entity/uniqueAttribute/type/{typeName}/labels

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.addLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addLabels2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.addLabels2(typeName, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addLabels2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.addLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addLabels2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
array[String] *string = ; //  (optional)

[apiInstance addLabels2With:typeName
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.addLabels2(typeName, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addLabels2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$string = ; // array[String] | 

try {
    $api_instance->addLabels2($typeName, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addLabels2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->addLabels2(typeName => $typeName, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addLabels2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.add_labels2(typeName, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addLabels2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addLabels2(typeName, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
string

Responses


addOrUpdateBusinessAttributes


/v2/entity/guid/{guid}/businessmetadata

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/businessmetadata?isOverwrite=true" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        Boolean isOverwrite = true; // Boolean | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.addOrUpdateBusinessAttributes(guid, isOverwrite, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addOrUpdateBusinessAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final Boolean isOverwrite = new Boolean(); // Boolean | 
final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.addOrUpdateBusinessAttributes(guid, isOverwrite, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOrUpdateBusinessAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        Boolean isOverwrite = true; // Boolean | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.addOrUpdateBusinessAttributes(guid, isOverwrite, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addOrUpdateBusinessAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
Boolean *isOverwrite = true; //  (optional) (default to false)
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance addOrUpdateBusinessAttributesWith:guid
    isOverwrite:isOverwrite
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'isOverwrite': true, // {Boolean} 
  'requestBody': Object // {map[String, Object]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var isOverwrite = true;  // Boolean |  (optional)  (default to false)
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.addOrUpdateBusinessAttributes(guid, isOverwrite, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addOrUpdateBusinessAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | 
$isOverwrite = true; // Boolean | 
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->addOrUpdateBusinessAttributes($guid, $isOverwrite, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | 
my $isOverwrite = true; # Boolean | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval {
    $api_instance->addOrUpdateBusinessAttributes(guid => $guid, isOverwrite => $isOverwrite, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String |  (default to null)
isOverwrite = true # Boolean |  (optional) (default to false)
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.add_or_update_business_attributes(guid, isOverwrite=isOverwrite, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let isOverwrite = true; // Boolean
    let requestBody = Object; // map[String, Object]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addOrUpdateBusinessAttributes(guid, isOverwrite, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Body parameters
Name Description
requestBody

Query parameters
Name Description
isOverwrite
Boolean

Responses


addOrUpdateBusinessAttributes2


/v2/entity/guid/{guid}/businessmetadata/{bmName}

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String bmName = bmName_example; // String | 
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.addOrUpdateBusinessAttributes2(bmName, guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addOrUpdateBusinessAttributes2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String bmName = new String(); // String | 
final String guid = new String(); // String | 
final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.addOrUpdateBusinessAttributes2(bmName, guid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->addOrUpdateBusinessAttributes2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String bmName = bmName_example; // String | 
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.addOrUpdateBusinessAttributes2(bmName, guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#addOrUpdateBusinessAttributes2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *bmName = bmName_example; //  (default to null)
String *guid = guid_example; //  (default to null)
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance addOrUpdateBusinessAttributes2With:bmName
    guid:guid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var bmName = bmName_example; // {String} 
var guid = guid_example; // {String} 
var opts = {
  'requestBody': Object // {map[String, Object]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.addOrUpdateBusinessAttributes2(bmName, guid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var bmName = bmName_example;  // String |  (default to null)
            var guid = guid_example;  // String |  (default to null)
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.addOrUpdateBusinessAttributes2(bmName, guid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.addOrUpdateBusinessAttributes2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$bmName = bmName_example; // String | 
$guid = guid_example; // String | 
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->addOrUpdateBusinessAttributes2($bmName, $guid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $bmName = bmName_example; # String | 
my $guid = guid_example; # String | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval {
    $api_instance->addOrUpdateBusinessAttributes2(bmName => $bmName, guid => $guid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
bmName = bmName_example # String |  (default to null)
guid = guid_example # String |  (default to null)
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.add_or_update_business_attributes2(bmName, guid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling EntityRESTApi->addOrUpdateBusinessAttributes2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let bmName = bmName_example; // String
    let guid = guid_example; // String
    let requestBody = Object; // map[String, Object]

    let mut context = EntityRESTApi::Context::default();
    let result = client.addOrUpdateBusinessAttributes2(bmName, guid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
bmName*
String
Required
guid*
String
Required
Body parameters
Name Description
requestBody

Responses


createOrUpdate

Create new entity or update existing entity in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName


/v2/entity

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity" \
 -d '{
  "entity" : {
    "businessAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "classifications" : [ {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }, {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    } ],
    "createTime" : 12345,
    "createdBy" : "...",
    "customAttributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "guid" : "...",
    "homeId" : "...",
    "isIncomplete" : true,
    "labels" : [ "...", "..." ],
    "meanings" : [ {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "DEPRECATED",
      "steward" : "...",
      "termGuid" : "..."
    }, {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "VALIDATED",
      "steward" : "...",
      "termGuid" : "..."
    } ],
    "pendingTasks" : [ "...", "..." ],
    "provenanceType" : 12345,
    "proxy" : true,
    "relationshipAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "status" : "ACTIVE",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "referredEntities" : {
    "property1" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "IMPORTED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "DELETED",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "property2" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "ACTIVE",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntityWithExtInfo atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.createOrUpdate(atlasEntityWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#createOrUpdate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasEntityWithExtInfo atlasEntityWithExtInfo = new AtlasEntityWithExtInfo(); // AtlasEntityWithExtInfo | 

try {
    final result = await api_instance.createOrUpdate(atlasEntityWithExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createOrUpdate: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntityWithExtInfo atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.createOrUpdate(atlasEntityWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#createOrUpdate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
AtlasEntityWithExtInfo *atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; //  (optional)

[apiInstance createOrUpdateWith:atlasEntityWithExtInfo
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'atlasEntityWithExtInfo': {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} // {AtlasEntityWithExtInfo} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var atlasEntityWithExtInfo = new AtlasEntityWithExtInfo(); // AtlasEntityWithExtInfo |  (optional) 

            try {
                EntityMutationResponse result = apiInstance.createOrUpdate(atlasEntityWithExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.createOrUpdate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $atlasEntityWithExtInfo = WWW::OPenAPIClient::Object::AtlasEntityWithExtInfo->new(); # AtlasEntityWithExtInfo | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} # AtlasEntityWithExtInfo |  (optional)

try:
    api_response = api_instance.create_or_update(atlasEntityWithExtInfo=atlasEntityWithExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->createOrUpdate: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo

    let mut context = EntityRESTApi::Context::default();
    let result = client.createOrUpdate(atlasEntityWithExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasEntityWithExtInfo

Responses


createOrUpdate2

Bulk API to create new entities or updates existing entities in Atlas. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName


/v2/entity/bulk

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk" \
 -d '{
  "entities" : [ {
    "businessAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "classifications" : [ {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }, {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    } ],
    "createTime" : 12345,
    "createdBy" : "...",
    "customAttributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "guid" : "...",
    "homeId" : "...",
    "isIncomplete" : true,
    "labels" : [ "...", "..." ],
    "meanings" : [ {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "IMPORTED",
      "steward" : "...",
      "termGuid" : "..."
    }, {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "DISCOVERED",
      "steward" : "...",
      "termGuid" : "..."
    } ],
    "pendingTasks" : [ "...", "..." ],
    "provenanceType" : 12345,
    "proxy" : true,
    "relationshipAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "status" : "ACTIVE",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "businessAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "classifications" : [ {
      "entityGuid" : "...",
      "entityStatus" : "ACTIVE",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }, {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    } ],
    "createTime" : 12345,
    "createdBy" : "...",
    "customAttributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "guid" : "...",
    "homeId" : "...",
    "isIncomplete" : true,
    "labels" : [ "...", "..." ],
    "meanings" : [ {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "IMPORTED",
      "steward" : "...",
      "termGuid" : "..."
    }, {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "OBSOLETE",
      "steward" : "...",
      "termGuid" : "..."
    } ],
    "pendingTasks" : [ "...", "..." ],
    "provenanceType" : 12345,
    "proxy" : true,
    "relationshipAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "status" : "ACTIVE",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "referredEntities" : {
    "property1" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "DELETED",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "property2" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "PROPOSED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "DELETED",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntitiesWithExtInfo atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntitiesWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.createOrUpdate2(atlasEntitiesWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#createOrUpdate2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasEntitiesWithExtInfo atlasEntitiesWithExtInfo = new AtlasEntitiesWithExtInfo(); // AtlasEntitiesWithExtInfo | 

try {
    final result = await api_instance.createOrUpdate2(atlasEntitiesWithExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createOrUpdate2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntitiesWithExtInfo atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntitiesWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.createOrUpdate2(atlasEntitiesWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#createOrUpdate2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
AtlasEntitiesWithExtInfo *atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; //  (optional)

[apiInstance createOrUpdate2With:atlasEntitiesWithExtInfo
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'atlasEntitiesWithExtInfo': {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} // {AtlasEntitiesWithExtInfo} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var atlasEntitiesWithExtInfo = new AtlasEntitiesWithExtInfo(); // AtlasEntitiesWithExtInfo |  (optional) 

            try {
                EntityMutationResponse result = apiInstance.createOrUpdate2(atlasEntitiesWithExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.createOrUpdate2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntitiesWithExtInfo | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $atlasEntitiesWithExtInfo = WWW::OPenAPIClient::Object::AtlasEntitiesWithExtInfo->new(); # AtlasEntitiesWithExtInfo | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} # AtlasEntitiesWithExtInfo |  (optional)

try:
    api_response = api_instance.create_or_update2(atlasEntitiesWithExtInfo=atlasEntitiesWithExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->createOrUpdate2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let atlasEntitiesWithExtInfo = {"entities":[{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"IMPORTED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"PURGED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DISCOVERED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntitiesWithExtInfo

    let mut context = EntityRESTApi::Context::default();
    let result = client.createOrUpdate2(atlasEntitiesWithExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasEntitiesWithExtInfo

Responses


deleteByGuid

Delete an entity identified by its GUID.


/v2/entity/guid/{guid}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity

        try {
            EntityMutationResponse result = apiInstance.deleteByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | GUID for the entity

try {
    final result = await api_instance.deleteByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteByGuid: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity

        try {
            EntityMutationResponse result = apiInstance.deleteByGuid(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // GUID for the entity (default to null)

[apiInstance deleteByGuidWith:guid
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} GUID for the entity

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | GUID for the entity (default to null)

            try {
                EntityMutationResponse result = apiInstance.deleteByGuid(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.deleteByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | GUID for the entity

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | GUID for the entity

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | GUID for the entity (default to null)

try:
    api_response = api_instance.delete_by_guid(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->deleteByGuid: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.deleteByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
GUID for the entity
Required

Responses


deleteByGuids

Bulk API to delete list of entities identified by its GUIDs


/v2/entity/bulk

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk?guid="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        array[String] guid = ; // array[String] | 

        try {
            EntityMutationResponse result = apiInstance.deleteByGuids(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByGuids");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[String] guid = new array[String](); // array[String] | 

try {
    final result = await api_instance.deleteByGuids(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteByGuids: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        array[String] guid = ; // array[String] | 

        try {
            EntityMutationResponse result = apiInstance.deleteByGuids(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByGuids");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
array[String] *guid = ; //  (optional) (default to null)

[apiInstance deleteByGuidsWith:guid
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'guid':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = new array[String](); // array[String] |  (optional)  (default to null)

            try {
                EntityMutationResponse result = apiInstance.deleteByGuids(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.deleteByGuids: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = ; // array[String] | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = []; # array[String] | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid =  # array[String] |  (optional) (default to null)

try:
    api_response = api_instance.delete_by_guids(guid=guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->deleteByGuids: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.deleteByGuids(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
guid
array[String]

Responses


deleteByUniqueAttribute

Delete an entity identified by its type and unique attributes. <p> In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format <p> attr:<attrName>=<attrValue> <p> NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName <p> The REST request would look something like this <p> DELETE /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue


/v2/entity/uniqueAttribute/type/{typeName}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | - entity type to be deleted

        try {
            EntityMutationResponse result = apiInstance.deleteByUniqueAttribute(typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByUniqueAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | - entity type to be deleted

try {
    final result = await api_instance.deleteByUniqueAttribute(typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteByUniqueAttribute: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | - entity type to be deleted

        try {
            EntityMutationResponse result = apiInstance.deleteByUniqueAttribute(typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteByUniqueAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; // - entity type to be deleted (default to null)

[apiInstance deleteByUniqueAttributeWith:typeName
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} - entity type to be deleted

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String | - entity type to be deleted (default to null)

            try {
                EntityMutationResponse result = apiInstance.deleteByUniqueAttribute(typeName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.deleteByUniqueAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | - entity type to be deleted

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | - entity type to be deleted

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String | - entity type to be deleted (default to null)

try:
    api_response = api_instance.delete_by_unique_attribute(typeName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->deleteByUniqueAttribute: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.deleteByUniqueAttribute(typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
- entity type to be deleted
Required

Responses


deleteClassification

Deletes a given classification from an existing entity represented by a guid.


/v2/entity/guid/{guid}/classification/{classificationName}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/classification/{classificationName}?associatedEntityGuid=associatedEntityGuid_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | name of the classifcation
        String guid = guid_example; // String | globally unique identifier for the entity
        String associatedEntityGuid = associatedEntityGuid_example; // String | 

        try {
            apiInstance.deleteClassification(classificationName, guid, associatedEntityGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteClassification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String classificationName = new String(); // String | name of the classifcation
final String guid = new String(); // String | globally unique identifier for the entity
final String associatedEntityGuid = new String(); // String | 

try {
    final result = await api_instance.deleteClassification(classificationName, guid, associatedEntityGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteClassification: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | name of the classifcation
        String guid = guid_example; // String | globally unique identifier for the entity
        String associatedEntityGuid = associatedEntityGuid_example; // String | 

        try {
            apiInstance.deleteClassification(classificationName, guid, associatedEntityGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteClassification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *classificationName = classificationName_example; // name of the classifcation (default to null)
String *guid = guid_example; // globally unique identifier for the entity (default to null)
String *associatedEntityGuid = associatedEntityGuid_example; //  (optional) (default to null)

[apiInstance deleteClassificationWith:classificationName
    guid:guid
    associatedEntityGuid:associatedEntityGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var classificationName = classificationName_example; // {String} name of the classifcation
var guid = guid_example; // {String} globally unique identifier for the entity
var opts = {
  'associatedEntityGuid': associatedEntityGuid_example // {String} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteClassification(classificationName, guid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var classificationName = classificationName_example;  // String | name of the classifcation (default to null)
            var guid = guid_example;  // String | globally unique identifier for the entity (default to null)
            var associatedEntityGuid = associatedEntityGuid_example;  // String |  (optional)  (default to null)

            try {
                apiInstance.deleteClassification(classificationName, guid, associatedEntityGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.deleteClassification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$classificationName = classificationName_example; // String | name of the classifcation
$guid = guid_example; // String | globally unique identifier for the entity
$associatedEntityGuid = associatedEntityGuid_example; // String | 

try {
    $api_instance->deleteClassification($classificationName, $guid, $associatedEntityGuid);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->deleteClassification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $classificationName = classificationName_example; # String | name of the classifcation
my $guid = guid_example; # String | globally unique identifier for the entity
my $associatedEntityGuid = associatedEntityGuid_example; # String | 

eval {
    $api_instance->deleteClassification(classificationName => $classificationName, guid => $guid, associatedEntityGuid => $associatedEntityGuid);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->deleteClassification: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
classificationName = classificationName_example # String | name of the classifcation (default to null)
guid = guid_example # String | globally unique identifier for the entity (default to null)
associatedEntityGuid = associatedEntityGuid_example # String |  (optional) (default to null)

try:
    api_instance.delete_classification(classificationName, guid, associatedEntityGuid=associatedEntityGuid)
except ApiException as e:
    print("Exception when calling EntityRESTApi->deleteClassification: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let classificationName = classificationName_example; // String
    let guid = guid_example; // String
    let associatedEntityGuid = associatedEntityGuid_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.deleteClassification(classificationName, guid, associatedEntityGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
classificationName*
String
name of the classifcation
Required
guid*
String
globally unique identifier for the entity
Required
Query parameters
Name Description
associatedEntityGuid
String

Responses


deleteClassificationByUniqueAttribute

Deletes a given classification from an entity identified by its type and unique attributes.


/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | name of the classification
        String typeName = typeName_example; // String | 

        try {
            apiInstance.deleteClassificationByUniqueAttribute(classificationName, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteClassificationByUniqueAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String classificationName = new String(); // String | name of the classification
final String typeName = new String(); // String | 

try {
    final result = await api_instance.deleteClassificationByUniqueAttribute(classificationName, typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteClassificationByUniqueAttribute: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | name of the classification
        String typeName = typeName_example; // String | 

        try {
            apiInstance.deleteClassificationByUniqueAttribute(classificationName, typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#deleteClassificationByUniqueAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *classificationName = classificationName_example; // name of the classification (default to null)
String *typeName = typeName_example; //  (default to null)

[apiInstance deleteClassificationByUniqueAttributeWith:classificationName
    typeName:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var classificationName = classificationName_example; // {String} name of the classification
var typeName = typeName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var classificationName = classificationName_example;  // String | name of the classification (default to null)
            var typeName = typeName_example;  // String |  (default to null)

            try {
                apiInstance.deleteClassificationByUniqueAttribute(classificationName, typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.deleteClassificationByUniqueAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$classificationName = classificationName_example; // String | name of the classification
$typeName = typeName_example; // String | 

try {
    $api_instance->deleteClassificationByUniqueAttribute($classificationName, $typeName);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->deleteClassificationByUniqueAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $classificationName = classificationName_example; # String | name of the classification
my $typeName = typeName_example; # String | 

eval {
    $api_instance->deleteClassificationByUniqueAttribute(classificationName => $classificationName, typeName => $typeName);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->deleteClassificationByUniqueAttribute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
classificationName = classificationName_example # String | name of the classification (default to null)
typeName = typeName_example # String |  (default to null)

try:
    api_instance.delete_classification_by_unique_attribute(classificationName, typeName)
except ApiException as e:
    print("Exception when calling EntityRESTApi->deleteClassificationByUniqueAttribute: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let classificationName = classificationName_example; // String
    let typeName = typeName_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.deleteClassificationByUniqueAttribute(classificationName, typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
classificationName*
String
name of the classification
Required
typeName*
String
Required

Responses


getAuditEvents


/v2/entity/{guid}/audit

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/{guid}/audit?auditAction=auditAction_example&count=56&offset=56&sortBy=sortBy_example&sortOrder=sortOrder_example&startKey=startKey_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        String auditAction = auditAction_example; // String | 
        Integer count = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String startKey = startKey_example; // String | 

        try {
            array[EntityAuditEventV2] result = apiInstance.getAuditEvents(guid, auditAction, count, offset, sortBy, sortOrder, startKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getAuditEvents");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final String auditAction = new String(); // String | 
final Integer count = new Integer(); // Integer | 
final Integer offset = new Integer(); // Integer | 
final String sortBy = new String(); // String | 
final String sortOrder = new String(); // String | 
final String startKey = new String(); // String | 

try {
    final result = await api_instance.getAuditEvents(guid, auditAction, count, offset, sortBy, sortOrder, startKey);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAuditEvents: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        String auditAction = auditAction_example; // String | 
        Integer count = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String sortBy = sortBy_example; // String | 
        String sortOrder = sortOrder_example; // String | 
        String startKey = startKey_example; // String | 

        try {
            array[EntityAuditEventV2] result = apiInstance.getAuditEvents(guid, auditAction, count, offset, sortBy, sortOrder, startKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getAuditEvents");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
String *auditAction = auditAction_example; //  (optional) (default to null)
Integer *count = 56; //  (optional) (default to null)
Integer *offset = 56; //  (optional) (default to null)
String *sortBy = sortBy_example; //  (optional) (default to null)
String *sortOrder = sortOrder_example; //  (optional) (default to null)
String *startKey = startKey_example; //  (optional) (default to null)

[apiInstance getAuditEventsWith:guid
    auditAction:auditAction
    count:count
    offset:offset
    sortBy:sortBy
    sortOrder:sortOrder
    startKey:startKey
              completionHandler: ^(array[EntityAuditEventV2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'auditAction': auditAction_example, // {String} 
  'count': 56, // {Integer} 
  'offset': 56, // {Integer} 
  'sortBy': sortBy_example, // {String} 
  'sortOrder': sortOrder_example, // {String} 
  'startKey': startKey_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var auditAction = auditAction_example;  // String |  (optional)  (default to null)
            var count = 56;  // Integer |  (optional)  (default to null)
            var offset = 56;  // Integer |  (optional)  (default to null)
            var sortBy = sortBy_example;  // String |  (optional)  (default to null)
            var sortOrder = sortOrder_example;  // String |  (optional)  (default to null)
            var startKey = startKey_example;  // String |  (optional)  (default to null)

            try {
                array[EntityAuditEventV2] result = apiInstance.getAuditEvents(guid, auditAction, count, offset, sortBy, sortOrder, startKey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getAuditEvents: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | 
$auditAction = auditAction_example; // String | 
$count = 56; // Integer | 
$offset = 56; // Integer | 
$sortBy = sortBy_example; // String | 
$sortOrder = sortOrder_example; // String | 
$startKey = startKey_example; // String | 

try {
    $result = $api_instance->getAuditEvents($guid, $auditAction, $count, $offset, $sortBy, $sortOrder, $startKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getAuditEvents: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | 
my $auditAction = auditAction_example; # String | 
my $count = 56; # Integer | 
my $offset = 56; # Integer | 
my $sortBy = sortBy_example; # String | 
my $sortOrder = sortOrder_example; # String | 
my $startKey = startKey_example; # String | 

eval {
    my $result = $api_instance->getAuditEvents(guid => $guid, auditAction => $auditAction, count => $count, offset => $offset, sortBy => $sortBy, sortOrder => $sortOrder, startKey => $startKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->getAuditEvents: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String |  (default to null)
auditAction = auditAction_example # String |  (optional) (default to null)
count = 56 # Integer |  (optional) (default to null)
offset = 56 # Integer |  (optional) (default to null)
sortBy = sortBy_example # String |  (optional) (default to null)
sortOrder = sortOrder_example # String |  (optional) (default to null)
startKey = startKey_example # String |  (optional) (default to null)

try:
    api_response = api_instance.get_audit_events(guid, auditAction=auditAction, count=count, offset=offset, sortBy=sortBy, sortOrder=sortOrder, startKey=startKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getAuditEvents: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let auditAction = auditAction_example; // String
    let count = 56; // Integer
    let offset = 56; // Integer
    let sortBy = sortBy_example; // String
    let sortOrder = sortOrder_example; // String
    let startKey = startKey_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.getAuditEvents(guid, auditAction, count, offset, sortBy, sortOrder, startKey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Query parameters
Name Description
auditAction
String
count
Integer (int32)
offset
Integer (int32)
sortBy
String
sortOrder
String
startKey
String

Responses


getByGuids

Bulk API to retrieve list of entities identified by its GUIDs.


/v2/entity/bulk

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk?guid=&ignoreRelationships=true&minExtInfo=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        array[String] guid = ; // array[String] | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntitiesWithExtInfo result = apiInstance.getByGuids(guid, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getByGuids");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[String] guid = new array[String](); // array[String] | 
final Boolean ignoreRelationships = new Boolean(); // Boolean | 
final Boolean minExtInfo = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getByGuids(guid, ignoreRelationships, minExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getByGuids: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        array[String] guid = ; // array[String] | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntitiesWithExtInfo result = apiInstance.getByGuids(guid, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getByGuids");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
array[String] *guid = ; //  (optional) (default to null)
Boolean *ignoreRelationships = true; //  (optional) (default to false)
Boolean *minExtInfo = true; //  (optional) (default to false)

[apiInstance getByGuidsWith:guid
    ignoreRelationships:ignoreRelationships
    minExtInfo:minExtInfo
              completionHandler: ^(AtlasEntitiesWithExtInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'guid': , // {array[String]} 
  'ignoreRelationships': true, // {Boolean} 
  'minExtInfo': true // {Boolean} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = new array[String](); // array[String] |  (optional)  (default to null)
            var ignoreRelationships = true;  // Boolean |  (optional)  (default to false)
            var minExtInfo = true;  // Boolean |  (optional)  (default to false)

            try {
                AtlasEntitiesWithExtInfo result = apiInstance.getByGuids(guid, ignoreRelationships, minExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getByGuids: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = ; // array[String] | 
$ignoreRelationships = true; // Boolean | 
$minExtInfo = true; // Boolean | 

try {
    $result = $api_instance->getByGuids($guid, $ignoreRelationships, $minExtInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getByGuids: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = []; # array[String] | 
my $ignoreRelationships = true; # Boolean | 
my $minExtInfo = true; # Boolean | 

eval {
    my $result = $api_instance->getByGuids(guid => $guid, ignoreRelationships => $ignoreRelationships, minExtInfo => $minExtInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->getByGuids: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid =  # array[String] |  (optional) (default to null)
ignoreRelationships = true # Boolean |  (optional) (default to false)
minExtInfo = true # Boolean |  (optional) (default to false)

try:
    api_response = api_instance.get_by_guids(guid=guid, ignoreRelationships=ignoreRelationships, minExtInfo=minExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getByGuids: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = ; // array[String]
    let ignoreRelationships = true; // Boolean
    let minExtInfo = true; // Boolean

    let mut context = EntityRESTApi::Context::default();
    let result = client.getByGuids(guid, ignoreRelationships, minExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
guid
array[String]
ignoreRelationships
Boolean
minExtInfo
Boolean

Responses


getById

Fetch complete definition of an entity given its GUID.


/v2/entity/guid/{guid}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}?ignoreRelationships=true&minExtInfo=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntityWithExtInfo result = apiInstance.getById(guid, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | GUID for the entity
final Boolean ignoreRelationships = new Boolean(); // Boolean | 
final Boolean minExtInfo = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getById(guid, ignoreRelationships, minExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getById: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntityWithExtInfo result = apiInstance.getById(guid, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // GUID for the entity (default to null)
Boolean *ignoreRelationships = true; //  (optional) (default to false)
Boolean *minExtInfo = true; //  (optional) (default to false)

[apiInstance getByIdWith:guid
    ignoreRelationships:ignoreRelationships
    minExtInfo:minExtInfo
              completionHandler: ^(AtlasEntityWithExtInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} GUID for the entity
var opts = {
  'ignoreRelationships': true, // {Boolean} 
  'minExtInfo': true // {Boolean} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | GUID for the entity (default to null)
            var ignoreRelationships = true;  // Boolean |  (optional)  (default to false)
            var minExtInfo = true;  // Boolean |  (optional)  (default to false)

            try {
                AtlasEntityWithExtInfo result = apiInstance.getById(guid, ignoreRelationships, minExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | GUID for the entity
$ignoreRelationships = true; // Boolean | 
$minExtInfo = true; // Boolean | 

try {
    $result = $api_instance->getById($guid, $ignoreRelationships, $minExtInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | GUID for the entity
my $ignoreRelationships = true; # Boolean | 
my $minExtInfo = true; # Boolean | 

eval {
    my $result = $api_instance->getById(guid => $guid, ignoreRelationships => $ignoreRelationships, minExtInfo => $minExtInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->getById: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | GUID for the entity (default to null)
ignoreRelationships = true # Boolean |  (optional) (default to false)
minExtInfo = true # Boolean |  (optional) (default to false)

try:
    api_response = api_instance.get_by_id(guid, ignoreRelationships=ignoreRelationships, minExtInfo=minExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getById: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let ignoreRelationships = true; // Boolean
    let minExtInfo = true; // Boolean

    let mut context = EntityRESTApi::Context::default();
    let result = client.getById(guid, ignoreRelationships, minExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
GUID for the entity
Required
Query parameters
Name Description
ignoreRelationships
Boolean
minExtInfo
Boolean

Responses


getByUniqueAttributes

Fetch complete definition of an entity given its type and unique attribute. <p> In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format <p> attr:<attrName>=<attrValue> <p> NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName <p> The REST request would look something like this <p> GET /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue


/v2/entity/uniqueAttribute/type/{typeName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}?ignoreRelationships=true&minExtInfo=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntityWithExtInfo result = apiInstance.getByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getByUniqueAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final Boolean ignoreRelationships = new Boolean(); // Boolean | 
final Boolean minExtInfo = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getByUniqueAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntityWithExtInfo result = apiInstance.getByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getByUniqueAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
Boolean *ignoreRelationships = true; //  (optional) (default to false)
Boolean *minExtInfo = true; //  (optional) (default to false)

[apiInstance getByUniqueAttributesWith:typeName
    ignoreRelationships:ignoreRelationships
    minExtInfo:minExtInfo
              completionHandler: ^(AtlasEntityWithExtInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'ignoreRelationships': true, // {Boolean} 
  'minExtInfo': true // {Boolean} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var ignoreRelationships = true;  // Boolean |  (optional)  (default to false)
            var minExtInfo = true;  // Boolean |  (optional)  (default to false)

            try {
                AtlasEntityWithExtInfo result = apiInstance.getByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getByUniqueAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$ignoreRelationships = true; // Boolean | 
$minExtInfo = true; // Boolean | 

try {
    $result = $api_instance->getByUniqueAttributes($typeName, $ignoreRelationships, $minExtInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getByUniqueAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $ignoreRelationships = true; # Boolean | 
my $minExtInfo = true; # Boolean | 

eval {
    my $result = $api_instance->getByUniqueAttributes(typeName => $typeName, ignoreRelationships => $ignoreRelationships, minExtInfo => $minExtInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->getByUniqueAttributes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
ignoreRelationships = true # Boolean |  (optional) (default to false)
minExtInfo = true # Boolean |  (optional) (default to false)

try:
    api_response = api_instance.get_by_unique_attributes(typeName, ignoreRelationships=ignoreRelationships, minExtInfo=minExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getByUniqueAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let ignoreRelationships = true; // Boolean
    let minExtInfo = true; // Boolean

    let mut context = EntityRESTApi::Context::default();
    let result = client.getByUniqueAttributes(typeName, ignoreRelationships, minExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Query parameters
Name Description
ignoreRelationships
Boolean
minExtInfo
Boolean

Responses


getClassification

Gets the list of classifications for a given entity represented by a guid.


/v2/entity/guid/{guid}/classification/{classificationName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/classification/{classificationName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | 
        String guid = guid_example; // String | globally unique identifier for the entity

        try {
            AtlasClassification result = apiInstance.getClassification(classificationName, guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getClassification");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String classificationName = new String(); // String | 
final String guid = new String(); // String | globally unique identifier for the entity

try {
    final result = await api_instance.getClassification(classificationName, guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getClassification: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String classificationName = classificationName_example; // String | 
        String guid = guid_example; // String | globally unique identifier for the entity

        try {
            AtlasClassification result = apiInstance.getClassification(classificationName, guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getClassification");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *classificationName = classificationName_example; //  (default to null)
String *guid = guid_example; // globally unique identifier for the entity (default to null)

[apiInstance getClassificationWith:classificationName
    guid:guid
              completionHandler: ^(AtlasClassification output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var classificationName = classificationName_example; // {String} 
var guid = guid_example; // {String} globally unique identifier for the entity

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var classificationName = classificationName_example;  // String |  (default to null)
            var guid = guid_example;  // String | globally unique identifier for the entity (default to null)

            try {
                AtlasClassification result = apiInstance.getClassification(classificationName, guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getClassification: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$classificationName = classificationName_example; // String | 
$guid = guid_example; // String | globally unique identifier for the entity

try {
    $result = $api_instance->getClassification($classificationName, $guid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getClassification: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $classificationName = classificationName_example; # String | 
my $guid = guid_example; # String | globally unique identifier for the entity

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
classificationName = classificationName_example # String |  (default to null)
guid = guid_example # String | globally unique identifier for the entity (default to null)

try:
    api_response = api_instance.get_classification(classificationName, guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getClassification: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let classificationName = classificationName_example; // String
    let guid = guid_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.getClassification(classificationName, guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
classificationName*
String
Required
guid*
String
globally unique identifier for the entity
Required

Responses


getClassifications

Gets the list of classifications for a given entity represented by a guid.


/v2/entity/guid/{guid}/classifications

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/classifications"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity

        try {
            AtlasClassifications result = apiInstance.getClassifications(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getClassifications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | globally unique identifier for the entity

try {
    final result = await api_instance.getClassifications(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getClassifications: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity

        try {
            AtlasClassifications result = apiInstance.getClassifications(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getClassifications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // globally unique identifier for the entity (default to null)

[apiInstance getClassificationsWith:guid
              completionHandler: ^(AtlasClassifications output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} globally unique identifier for the entity

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | globally unique identifier for the entity (default to null)

            try {
                AtlasClassifications result = apiInstance.getClassifications(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getClassifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | globally unique identifier for the entity

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | globally unique identifier for the entity

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | globally unique identifier for the entity (default to null)

try:
    api_response = api_instance.get_classifications(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getClassifications: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.getClassifications(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
globally unique identifier for the entity
Required

Responses


getEntitiesByUniqueAttributes

Bulk API to retrieve list of entities identified by its unique attributes. <p> In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format <p> typeName=<typeName>&attr_1:<attrName>=<attrValue>&attr_2:<attrName>=<attrValue>&attr_3:<attrName>=<attrValue> <p> NOTE: The attrName should be an unique attribute for the given entity-type <p> The REST request would look something like this <p> GET /v2/entity/bulk/uniqueAttribute/type/hive_db?attr_0:qualifiedName=db1@cl1&attr_2:qualifiedName=db2@cl1


/v2/entity/bulk/uniqueAttribute/type/{typeName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk/uniqueAttribute/type/{typeName}?ignoreRelationships=true&minExtInfo=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntitiesWithExtInfo result = apiInstance.getEntitiesByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntitiesByUniqueAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final Boolean ignoreRelationships = new Boolean(); // Boolean | 
final Boolean minExtInfo = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getEntitiesByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntitiesByUniqueAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        Boolean ignoreRelationships = true; // Boolean | 
        Boolean minExtInfo = true; // Boolean | 

        try {
            AtlasEntitiesWithExtInfo result = apiInstance.getEntitiesByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntitiesByUniqueAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
Boolean *ignoreRelationships = true; //  (optional) (default to false)
Boolean *minExtInfo = true; //  (optional) (default to false)

[apiInstance getEntitiesByUniqueAttributesWith:typeName
    ignoreRelationships:ignoreRelationships
    minExtInfo:minExtInfo
              completionHandler: ^(AtlasEntitiesWithExtInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'ignoreRelationships': true, // {Boolean} 
  'minExtInfo': true // {Boolean} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var ignoreRelationships = true;  // Boolean |  (optional)  (default to false)
            var minExtInfo = true;  // Boolean |  (optional)  (default to false)

            try {
                AtlasEntitiesWithExtInfo result = apiInstance.getEntitiesByUniqueAttributes(typeName, ignoreRelationships, minExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getEntitiesByUniqueAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$ignoreRelationships = true; // Boolean | 
$minExtInfo = true; // Boolean | 

try {
    $result = $api_instance->getEntitiesByUniqueAttributes($typeName, $ignoreRelationships, $minExtInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->getEntitiesByUniqueAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $ignoreRelationships = true; # Boolean | 
my $minExtInfo = true; # Boolean | 

eval {
    my $result = $api_instance->getEntitiesByUniqueAttributes(typeName => $typeName, ignoreRelationships => $ignoreRelationships, minExtInfo => $minExtInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->getEntitiesByUniqueAttributes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
ignoreRelationships = true # Boolean |  (optional) (default to false)
minExtInfo = true # Boolean |  (optional) (default to false)

try:
    api_response = api_instance.get_entities_by_unique_attributes(typeName, ignoreRelationships=ignoreRelationships, minExtInfo=minExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getEntitiesByUniqueAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let ignoreRelationships = true; // Boolean
    let minExtInfo = true; // Boolean

    let mut context = EntityRESTApi::Context::default();
    let result = client.getEntitiesByUniqueAttributes(typeName, ignoreRelationships, minExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Query parameters
Name Description
ignoreRelationships
Boolean
minExtInfo
Boolean

Responses


getEntityHeaderByUniqueAttributes

Fetch AtlasEntityHeader given its type and unique attribute. <p> In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format <p> attr:<attrName>=<attrValue> <p> NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName <p> The REST request would look something like this <p> GET /v2/entity/uniqueAttribute/type/aType/header?attr:aTypeAttribute=someValue


/v2/entity/uniqueAttribute/type/{typeName}/header

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/header"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 

        try {
            AtlasEntityHeader result = apiInstance.getEntityHeaderByUniqueAttributes(typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntityHeaderByUniqueAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 

try {
    final result = await api_instance.getEntityHeaderByUniqueAttributes(typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntityHeaderByUniqueAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 

        try {
            AtlasEntityHeader result = apiInstance.getEntityHeaderByUniqueAttributes(typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntityHeaderByUniqueAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)

[apiInstance getEntityHeaderByUniqueAttributesWith:typeName
              completionHandler: ^(AtlasEntityHeader output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)

            try {
                AtlasEntityHeader result = apiInstance.getEntityHeaderByUniqueAttributes(typeName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getEntityHeaderByUniqueAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)

try:
    api_response = api_instance.get_entity_header_by_unique_attributes(typeName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getEntityHeaderByUniqueAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.getEntityHeaderByUniqueAttributes(typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required

Responses


getEntityHeaders


/v2/entity/bulk/headers

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk/headers?tagUpdateStartTime=789"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        Long tagUpdateStartTime = 789; // Long | 

        try {
            AtlasEntityHeaders result = apiInstance.getEntityHeaders(tagUpdateStartTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntityHeaders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Long tagUpdateStartTime = new Long(); // Long | 

try {
    final result = await api_instance.getEntityHeaders(tagUpdateStartTime);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntityHeaders: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        Long tagUpdateStartTime = 789; // Long | 

        try {
            AtlasEntityHeaders result = apiInstance.getEntityHeaders(tagUpdateStartTime);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getEntityHeaders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
Long *tagUpdateStartTime = 789; //  (default to null)

[apiInstance getEntityHeadersWith:tagUpdateStartTime
              completionHandler: ^(AtlasEntityHeaders output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var tagUpdateStartTime = 789; // {Long} 

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var tagUpdateStartTime = 789;  // Long |  (default to null)

            try {
                AtlasEntityHeaders result = apiInstance.getEntityHeaders(tagUpdateStartTime);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getEntityHeaders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$tagUpdateStartTime = 789; // Long | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $tagUpdateStartTime = 789; # Long | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
tagUpdateStartTime = 789 # Long |  (default to null)

try:
    api_response = api_instance.get_entity_headers(tagUpdateStartTime)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getEntityHeaders: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let tagUpdateStartTime = 789; // Long

    let mut context = EntityRESTApi::Context::default();
    let result = client.getEntityHeaders(tagUpdateStartTime, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
tagUpdateStartTime*
Long (int64)
Required

Responses


getHeaderById

Get entity header given its GUID.


/v2/entity/guid/{guid}/header

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/header"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity

        try {
            AtlasEntityHeader result = apiInstance.getHeaderById(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getHeaderById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | GUID for the entity

try {
    final result = await api_instance.getHeaderById(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getHeaderById: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | GUID for the entity

        try {
            AtlasEntityHeader result = apiInstance.getHeaderById(guid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#getHeaderById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // GUID for the entity (default to null)

[apiInstance getHeaderByIdWith:guid
              completionHandler: ^(AtlasEntityHeader output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} GUID for the entity

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | GUID for the entity (default to null)

            try {
                AtlasEntityHeader result = apiInstance.getHeaderById(guid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.getHeaderById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | GUID for the entity

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | GUID for the entity

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | GUID for the entity (default to null)

try:
    api_response = api_instance.get_header_by_id(guid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->getHeaderById: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.getHeaderById(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
GUID for the entity
Required

Responses


importBMAttributes

Upload the file for creating Business Metadata in BULK


/v2/entity/businessmetadata/import

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/atlas/v2/entity/businessmetadata/import"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
        String uploadedInputStream = uploadedInputStream_example; // String | InputStream of file

        try {
            apiInstance.importBMAttributes(fileDetail, uploadedInputStream);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#importBMAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fileDetail = new String(); // String | FormDataContentDisposition metadata of file
final String uploadedInputStream = new String(); // String | InputStream of file

try {
    final result = await api_instance.importBMAttributes(fileDetail, uploadedInputStream);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importBMAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
        String uploadedInputStream = uploadedInputStream_example; // String | InputStream of file

        try {
            apiInstance.importBMAttributes(fileDetail, uploadedInputStream);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#importBMAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *fileDetail = fileDetail_example; // FormDataContentDisposition metadata of file (optional) (default to null)
String *uploadedInputStream = uploadedInputStream_example; // InputStream of file (optional) (default to null)

[apiInstance importBMAttributesWith:fileDetail
    uploadedInputStream:uploadedInputStream
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'fileDetail': fileDetail_example, // {String} FormDataContentDisposition metadata of file
  'uploadedInputStream': uploadedInputStream_example // {String} InputStream of file
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var fileDetail = fileDetail_example;  // String | FormDataContentDisposition metadata of file (optional)  (default to null)
            var uploadedInputStream = uploadedInputStream_example;  // String | InputStream of file (optional)  (default to null)

            try {
                apiInstance.importBMAttributes(fileDetail, uploadedInputStream);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.importBMAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
$uploadedInputStream = uploadedInputStream_example; // String | InputStream of file

try {
    $api_instance->importBMAttributes($fileDetail, $uploadedInputStream);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->importBMAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $fileDetail = fileDetail_example; # String | FormDataContentDisposition metadata of file
my $uploadedInputStream = uploadedInputStream_example; # String | InputStream of file

eval {
    $api_instance->importBMAttributes(fileDetail => $fileDetail, uploadedInputStream => $uploadedInputStream);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->importBMAttributes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
fileDetail = fileDetail_example # String | FormDataContentDisposition metadata of file (optional) (default to null)
uploadedInputStream = uploadedInputStream_example # String | InputStream of file (optional) (default to null)

try:
    api_instance.import_bm_attributes(fileDetail=fileDetail, uploadedInputStream=uploadedInputStream)
except ApiException as e:
    print("Exception when calling EntityRESTApi->importBMAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let fileDetail = fileDetail_example; // String
    let uploadedInputStream = uploadedInputStream_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.importBMAttributes(fileDetail, uploadedInputStream, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
fileDetail
String
FormDataContentDisposition metadata of file
uploadedInputStream
String
InputStream of file

Responses


partialUpdateEntityAttrByGuid

Entity Partial Update - Add/Update entity attribute identified by its GUID. Supports only uprimitive attribute type and entity references. does not support updation of complex types like arrays, maps Null updates are not possible


/v2/entity/guid/{guid}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}?name=name_example" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        String name = name_example; // String | 
        String body = body_example; // String | 

        try {
            EntityMutationResponse result = apiInstance.partialUpdateEntityAttrByGuid(guid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#partialUpdateEntityAttrByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final String name = new String(); // String | 
final String body = new String(); // String | 

try {
    final result = await api_instance.partialUpdateEntityAttrByGuid(guid, name, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->partialUpdateEntityAttrByGuid: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        String name = name_example; // String | 
        String body = body_example; // String | 

        try {
            EntityMutationResponse result = apiInstance.partialUpdateEntityAttrByGuid(guid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#partialUpdateEntityAttrByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
String *name = name_example; //  (optional) (default to null)
String *body = body_example; //  (optional)

[apiInstance partialUpdateEntityAttrByGuidWith:guid
    name:name
    body:body
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'name': name_example, // {String} 
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var name = name_example;  // String |  (optional)  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                EntityMutationResponse result = apiInstance.partialUpdateEntityAttrByGuid(guid, name, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.partialUpdateEntityAttrByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | 
$name = name_example; // String | 
$body = body_example; // String | 

try {
    $result = $api_instance->partialUpdateEntityAttrByGuid($guid, $name, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->partialUpdateEntityAttrByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | 
my $name = name_example; # String | 
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String |  (default to null)
name = name_example # String |  (optional) (default to null)
body = body_example # String |  (optional)

try:
    api_response = api_instance.partial_update_entity_attr_by_guid(guid, name=name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->partialUpdateEntityAttrByGuid: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let name = name_example; // String
    let body = body_example; // String

    let mut context = EntityRESTApi::Context::default();
    let result = client.partialUpdateEntityAttrByGuid(guid, name, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Body parameters
Name Description
body

Query parameters
Name Description
name
String

Responses


partialUpdateEntityByUniqueAttrs

Entity Partial Update - Allows a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg: Referenceable.qualifiedName. Null updates are not possible In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format attr:<attrName>=<attrValue> NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName The REST request would look something like this PUT /v2/entity/uniqueAttribute/type/aType?attr:aTypeAttribute=someValue


/v2/entity/uniqueAttribute/type/{typeName}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}" \
 -d '{
  "entity" : {
    "businessAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "classifications" : [ {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }, {
      "entityGuid" : "...",
      "entityStatus" : "PURGED",
      "propagate" : true,
      "removePropagationsOnEntityDelete" : true,
      "validityPeriods" : [ { }, { } ],
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    } ],
    "createTime" : 12345,
    "createdBy" : "...",
    "customAttributes" : {
      "property1" : "...",
      "property2" : "..."
    },
    "guid" : "...",
    "homeId" : "...",
    "isIncomplete" : true,
    "labels" : [ "...", "..." ],
    "meanings" : [ {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "DEPRECATED",
      "steward" : "...",
      "termGuid" : "..."
    }, {
      "confidence" : 12345,
      "createdBy" : "...",
      "description" : "...",
      "displayText" : "...",
      "expression" : "...",
      "qualifiedName" : "...",
      "relationGuid" : "...",
      "source" : "...",
      "status" : "VALIDATED",
      "steward" : "...",
      "termGuid" : "..."
    } ],
    "pendingTasks" : [ "...", "..." ],
    "provenanceType" : 12345,
    "proxy" : true,
    "relationshipAttributes" : {
      "property1" : { },
      "property2" : { }
    },
    "status" : "ACTIVE",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345,
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "referredEntities" : {
    "property1" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "IMPORTED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "DELETED",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "property2" : {
      "businessAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "PURGED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "createTime" : 12345,
      "createdBy" : "...",
      "customAttributes" : {
        "property1" : "...",
        "property2" : "..."
      },
      "guid" : "...",
      "homeId" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "DEPRECATED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "OBSOLETE",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "pendingTasks" : [ "...", "..." ],
      "provenanceType" : 12345,
      "proxy" : true,
      "relationshipAttributes" : {
        "property1" : { },
        "property2" : { }
      },
      "status" : "ACTIVE",
      "updateTime" : 12345,
      "updatedBy" : "...",
      "version" : 12345,
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        AtlasEntityWithExtInfo atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.partialUpdateEntityByUniqueAttrs(typeName, atlasEntityWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#partialUpdateEntityByUniqueAttrs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final AtlasEntityWithExtInfo atlasEntityWithExtInfo = new AtlasEntityWithExtInfo(); // AtlasEntityWithExtInfo | 

try {
    final result = await api_instance.partialUpdateEntityByUniqueAttrs(typeName, atlasEntityWithExtInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->partialUpdateEntityByUniqueAttrs: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        AtlasEntityWithExtInfo atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

        try {
            EntityMutationResponse result = apiInstance.partialUpdateEntityByUniqueAttrs(typeName, atlasEntityWithExtInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#partialUpdateEntityByUniqueAttrs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
AtlasEntityWithExtInfo *atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; //  (optional)

[apiInstance partialUpdateEntityByUniqueAttrsWith:typeName
    atlasEntityWithExtInfo:atlasEntityWithExtInfo
              completionHandler: ^(EntityMutationResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'atlasEntityWithExtInfo': {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} // {AtlasEntityWithExtInfo} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var atlasEntityWithExtInfo = new AtlasEntityWithExtInfo(); // AtlasEntityWithExtInfo |  (optional) 

            try {
                EntityMutationResponse result = apiInstance.partialUpdateEntityByUniqueAttrs(typeName, atlasEntityWithExtInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.partialUpdateEntityByUniqueAttrs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo | 

try {
    $result = $api_instance->partialUpdateEntityByUniqueAttrs($typeName, $atlasEntityWithExtInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->partialUpdateEntityByUniqueAttrs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $atlasEntityWithExtInfo = WWW::OPenAPIClient::Object::AtlasEntityWithExtInfo->new(); # AtlasEntityWithExtInfo | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}} # AtlasEntityWithExtInfo |  (optional)

try:
    api_response = api_instance.partial_update_entity_by_unique_attrs(typeName, atlasEntityWithExtInfo=atlasEntityWithExtInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->partialUpdateEntityByUniqueAttrs: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let atlasEntityWithExtInfo = {"entity":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"DELETED","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"referredEntities":{"property1":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"businessAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","customAttributes":{"property1":"...","property2":"..."},"guid":"...","homeId":"...","isIncomplete":true,"labels":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."}],"pendingTasks":["...","..."],"provenanceType":12345,"proxy":true,"relationshipAttributes":{"property1":{},"property2":{}},"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityWithExtInfo

    let mut context = EntityRESTApi::Context::default();
    let result = client.partialUpdateEntityByUniqueAttrs(typeName, atlasEntityWithExtInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
atlasEntityWithExtInfo

Responses


produceTemplate

Get the sample Template for uploading/creating bulk BusinessMetaData


/v2/entity/businessmetadata/import/template

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/octet-stream" \
 "http://localhost/api/atlas/v2/entity/businessmetadata/import/template"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();

        try {
            'String' result = apiInstance.produceTemplate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#produceTemplate");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.produceTemplate();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->produceTemplate: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();

        try {
            'String' result = apiInstance.produceTemplate();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#produceTemplate");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];

[apiInstance produceTemplateWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.produceTemplate(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()

try:
    api_response = api_instance.produce_template()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->produceTemplate: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {

    let mut context = EntityRESTApi::Context::default();
    let result = client.produceTemplate(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeBusinessAttributes


/v2/entity/guid/{guid}/businessmetadata

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/businessmetadata" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.removeBusinessAttributes(guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeBusinessAttributes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.removeBusinessAttributes(guid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeBusinessAttributes: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.removeBusinessAttributes(guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeBusinessAttributes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance removeBusinessAttributesWith:guid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'requestBody': Object // {map[String, Object]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.removeBusinessAttributes(guid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.removeBusinessAttributes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | 
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->removeBusinessAttributes($guid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->removeBusinessAttributes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval {
    $api_instance->removeBusinessAttributes(guid => $guid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->removeBusinessAttributes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String |  (default to null)
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.remove_business_attributes(guid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling EntityRESTApi->removeBusinessAttributes: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let requestBody = Object; // map[String, Object]

    let mut context = EntityRESTApi::Context::default();
    let result = client.removeBusinessAttributes(guid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Body parameters
Name Description
requestBody

Responses


removeBusinessAttributes2


/v2/entity/guid/{guid}/businessmetadata/{bmName}

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/businessmetadata/{bmName}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String bmName = bmName_example; // String | 
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.removeBusinessAttributes2(bmName, guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeBusinessAttributes2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String bmName = new String(); // String | 
final String guid = new String(); // String | 
final map[String, Object] requestBody = new map[String, Object](); // map[String, Object] | 

try {
    final result = await api_instance.removeBusinessAttributes2(bmName, guid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeBusinessAttributes2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String bmName = bmName_example; // String | 
        String guid = guid_example; // String | 
        map[String, Object] requestBody = Object; // map[String, Object] | 

        try {
            apiInstance.removeBusinessAttributes2(bmName, guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeBusinessAttributes2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *bmName = bmName_example; //  (default to null)
String *guid = guid_example; //  (default to null)
map[String, Object] *requestBody = Object; //  (optional)

[apiInstance removeBusinessAttributes2With:bmName
    guid:guid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var bmName = bmName_example; // {String} 
var guid = guid_example; // {String} 
var opts = {
  'requestBody': Object // {map[String, Object]} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.removeBusinessAttributes2(bmName, guid, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var bmName = bmName_example;  // String |  (default to null)
            var guid = guid_example;  // String |  (default to null)
            var requestBody = new map[String, Object](); // map[String, Object] |  (optional) 

            try {
                apiInstance.removeBusinessAttributes2(bmName, guid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.removeBusinessAttributes2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$bmName = bmName_example; // String | 
$guid = guid_example; // String | 
$requestBody = Object; // map[String, Object] | 

try {
    $api_instance->removeBusinessAttributes2($bmName, $guid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->removeBusinessAttributes2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $bmName = bmName_example; # String | 
my $guid = guid_example; # String | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, Object]->new(); # map[String, Object] | 

eval {
    $api_instance->removeBusinessAttributes2(bmName => $bmName, guid => $guid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->removeBusinessAttributes2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
bmName = bmName_example # String |  (default to null)
guid = guid_example # String |  (default to null)
requestBody = Object # map[String, Object] |  (optional)

try:
    api_instance.remove_business_attributes2(bmName, guid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling EntityRESTApi->removeBusinessAttributes2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let bmName = bmName_example; // String
    let guid = guid_example; // String
    let requestBody = Object; // map[String, Object]

    let mut context = EntityRESTApi::Context::default();
    let result = client.removeBusinessAttributes2(bmName, guid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
bmName*
String
Required
guid*
String
Required
Body parameters
Name Description
requestBody

Responses


removeLabels

delete given labels to a given entity


/v2/entity/guid/{guid}/labels

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.removeLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | - Unique entity identifier
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.removeLabels(guid, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeLabels: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.removeLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeLabels");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // - Unique entity identifier (default to null)
array[String] *string = ; //  (optional)

[apiInstance removeLabelsWith:guid
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} - Unique entity identifier
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | - Unique entity identifier (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.removeLabels(guid, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.removeLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | - Unique entity identifier
$string = ; // array[String] | 

try {
    $api_instance->removeLabels($guid, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->removeLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | - Unique entity identifier
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->removeLabels(guid => $guid, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->removeLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | - Unique entity identifier (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.remove_labels(guid, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->removeLabels: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.removeLabels(guid, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
- Unique entity identifier
Required
Body parameters
Name Description
string

Responses


removeLabels2


/v2/entity/uniqueAttribute/type/{typeName}/labels

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.removeLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeLabels2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.removeLabels2(typeName, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeLabels2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.removeLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#removeLabels2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
array[String] *string = ; //  (optional)

[apiInstance removeLabels2With:typeName
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.removeLabels2(typeName, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.removeLabels2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$string = ; // array[String] | 

try {
    $api_instance->removeLabels2($typeName, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->removeLabels2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->removeLabels2(typeName => $typeName, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->removeLabels2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.remove_labels2(typeName, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->removeLabels2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.removeLabels2(typeName, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
string

Responses


setClassifications


/v2/entity/bulk/setClassifications

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/bulk/setClassifications" \
 -d '{
  "guidHeaderMap" : {
    "property1" : {
      "classificationNames" : [ "...", "..." ],
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "displayText" : "...",
      "guid" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meaningNames" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "PROPOSED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "PROPOSED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "status" : "ACTIVE",
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "property2" : {
      "classificationNames" : [ "...", "..." ],
      "classifications" : [ {
        "entityGuid" : "...",
        "entityStatus" : "DELETED",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      }, {
        "entityGuid" : "...",
        "entityStatus" : "ACTIVE",
        "propagate" : true,
        "removePropagationsOnEntityDelete" : true,
        "validityPeriods" : [ { }, { } ],
        "attributes" : {
          "property1" : { },
          "property2" : { }
        },
        "typeName" : "..."
      } ],
      "displayText" : "...",
      "guid" : "...",
      "isIncomplete" : true,
      "labels" : [ "...", "..." ],
      "meaningNames" : [ "...", "..." ],
      "meanings" : [ {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "PROPOSED",
        "steward" : "...",
        "termGuid" : "..."
      }, {
        "confidence" : 12345,
        "createdBy" : "...",
        "description" : "...",
        "displayText" : "...",
        "expression" : "...",
        "qualifiedName" : "...",
        "relationGuid" : "...",
        "source" : "...",
        "status" : "IMPORTED",
        "steward" : "...",
        "termGuid" : "..."
      } ],
      "status" : "PURGED",
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntityHeaders atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityHeaders | 

        try {
            'String' result = apiInstance.setClassifications(atlasEntityHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setClassifications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasEntityHeaders atlasEntityHeaders = new AtlasEntityHeaders(); // AtlasEntityHeaders | 

try {
    final result = await api_instance.setClassifications(atlasEntityHeaders);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setClassifications: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        AtlasEntityHeaders atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityHeaders | 

        try {
            'String' result = apiInstance.setClassifications(atlasEntityHeaders);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setClassifications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
AtlasEntityHeaders *atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; //  (optional)

[apiInstance setClassificationsWith:atlasEntityHeaders
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var opts = {
  'atlasEntityHeaders': {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}} // {AtlasEntityHeaders} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var atlasEntityHeaders = new AtlasEntityHeaders(); // AtlasEntityHeaders |  (optional) 

            try {
                'String' result = apiInstance.setClassifications(atlasEntityHeaders);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.setClassifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityHeaders | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $atlasEntityHeaders = WWW::OPenAPIClient::Object::AtlasEntityHeaders->new(); # AtlasEntityHeaders | 

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

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}} # AtlasEntityHeaders |  (optional)

try:
    api_response = api_instance.set_classifications(atlasEntityHeaders=atlasEntityHeaders)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EntityRESTApi->setClassifications: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let atlasEntityHeaders = {"guidHeaderMap":{"property1":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."},"property2":{"classificationNames":["...","..."],"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{},{}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"displayText":"...","guid":"...","isIncomplete":true,"labels":["...","..."],"meaningNames":["...","..."],"meanings":[{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"VALIDATED","steward":"...","termGuid":"..."},{"confidence":12345,"createdBy":"...","description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"PROPOSED","steward":"...","termGuid":"..."}],"status":"PURGED","attributes":{"property1":{},"property2":{}},"typeName":"..."}}}; // AtlasEntityHeaders

    let mut context = EntityRESTApi::Context::default();
    let result = client.setClassifications(atlasEntityHeaders, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasEntityHeaders

Responses


setLabels

Set labels to a given entity


/v2/entity/guid/{guid}/labels

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.setLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setLabels");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | - Unique entity identifier
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.setLabels(guid, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setLabels: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | - Unique entity identifier
        array[String] string = ; // array[String] | 

        try {
            apiInstance.setLabels(guid, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setLabels");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // - Unique entity identifier (default to null)
array[String] *string = ; //  (optional)

[apiInstance setLabelsWith:guid
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} - Unique entity identifier
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | - Unique entity identifier (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.setLabels(guid, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.setLabels: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | - Unique entity identifier
$string = ; // array[String] | 

try {
    $api_instance->setLabels($guid, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->setLabels: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | - Unique entity identifier
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->setLabels(guid => $guid, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->setLabels: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | - Unique entity identifier (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.set_labels(guid, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->setLabels: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.setLabels(guid, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
- Unique entity identifier
Required
Body parameters
Name Description
string

- set of labels to be set to the entity

Responses


setLabels2


/v2/entity/uniqueAttribute/type/{typeName}/labels

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/labels" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.setLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setLabels2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final array[String] string = new array[String](); // array[String] | 

try {
    final result = await api_instance.setLabels2(typeName, string);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->setLabels2: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[String] string = ; // array[String] | 

        try {
            apiInstance.setLabels2(typeName, string);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#setLabels2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
array[String] *string = ; //  (optional)

[apiInstance setLabels2With:typeName
    string:string
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'string':  // {array[String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var string = new array[String](); // array[String] |  (optional) 

            try {
                apiInstance.setLabels2(typeName, string);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.setLabels2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$string = ; // array[String] | 

try {
    $api_instance->setLabels2($typeName, $string);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->setLabels2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $string = [WWW::OPenAPIClient::Object::array[String]->new()]; # array[String] | 

eval {
    $api_instance->setLabels2(typeName => $typeName, string => $string);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->setLabels2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
string =  # array[String] |  (optional)

try:
    api_instance.set_labels2(typeName, string=string)
except ApiException as e:
    print("Exception when calling EntityRESTApi->setLabels2: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let string = ; // array[String]

    let mut context = EntityRESTApi::Context::default();
    let result = client.setLabels2(typeName, string, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
string

Responses


updateClassifications

Updates classifications to an existing entity represented by a guid.


/v2/entity/guid/{guid}/classifications

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/guid/{guid}/classifications" \
 -d '{
  "entityGuid" : "...",
  "entityStatus" : "ACTIVE",
  "propagate" : true,
  "removePropagationsOnEntityDelete" : true,
  "validityPeriods" : [ {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  }, {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  } ],
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.updateClassifications(guid, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#updateClassifications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | globally unique identifier for the entity
final array[AtlasClassification] atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] | 

try {
    final result = await api_instance.updateClassifications(guid, atlasClassification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateClassifications: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String guid = guid_example; // String | globally unique identifier for the entity
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.updateClassifications(guid, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#updateClassifications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *guid = guid_example; // globally unique identifier for the entity (default to null)
array[AtlasClassification] *atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; //  (optional)

[apiInstance updateClassificationsWith:guid
    atlasClassification:atlasClassification
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var guid = guid_example; // {String} globally unique identifier for the entity
var opts = {
  'atlasClassification': [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] // {array[AtlasClassification]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var guid = guid_example;  // String | globally unique identifier for the entity (default to null)
            var atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] |  (optional) 

            try {
                apiInstance.updateClassifications(guid, atlasClassification);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.updateClassifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$guid = guid_example; // String | globally unique identifier for the entity
$atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

try {
    $api_instance->updateClassifications($guid, $atlasClassification);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->updateClassifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $guid = guid_example; # String | globally unique identifier for the entity
my $atlasClassification = [WWW::OPenAPIClient::Object::array[AtlasClassification]->new()]; # array[AtlasClassification] | 

eval {
    $api_instance->updateClassifications(guid => $guid, atlasClassification => $atlasClassification);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->updateClassifications: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
guid = guid_example # String | globally unique identifier for the entity (default to null)
atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] # array[AtlasClassification] |  (optional)

try:
    api_instance.update_classifications(guid, atlasClassification=atlasClassification)
except ApiException as e:
    print("Exception when calling EntityRESTApi->updateClassifications: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let atlasClassification = [{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification]

    let mut context = EntityRESTApi::Context::default();
    let result = client.updateClassifications(guid, atlasClassification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
globally unique identifier for the entity
Required
Body parameters
Name Description
atlasClassification

Responses


updateClassificationsByUniqueAttribute

Updates classification on an entity identified by its type and unique attributes.


/v2/entity/uniqueAttribute/type/{typeName}/classifications

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/entity/uniqueAttribute/type/{typeName}/classifications" \
 -d '{
  "entityGuid" : "...",
  "entityStatus" : "ACTIVE",
  "propagate" : true,
  "removePropagationsOnEntityDelete" : true,
  "validityPeriods" : [ {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  }, {
    "endTime" : "...",
    "startTime" : "...",
    "timeZone" : "..."
  } ],
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EntityRESTApi;

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

public class EntityRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.updateClassificationsByUniqueAttribute(typeName, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#updateClassificationsByUniqueAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | 
final array[AtlasClassification] atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] | 

try {
    final result = await api_instance.updateClassificationsByUniqueAttribute(typeName, atlasClassification);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateClassificationsByUniqueAttribute: $e\n');
}

import org.openapitools.client.api.EntityRESTApi;

public class EntityRESTApiExample {
    public static void main(String[] args) {
        EntityRESTApi apiInstance = new EntityRESTApi();
        String typeName = typeName_example; // String | 
        array[AtlasClassification] atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

        try {
            apiInstance.updateClassificationsByUniqueAttribute(typeName, atlasClassification);
        } catch (ApiException e) {
            System.err.println("Exception when calling EntityRESTApi#updateClassificationsByUniqueAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EntityRESTApi *apiInstance = [[EntityRESTApi alloc] init];
String *typeName = typeName_example; //  (default to null)
array[AtlasClassification] *atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; //  (optional)

[apiInstance updateClassificationsByUniqueAttributeWith:typeName
    atlasClassification:atlasClassification
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.EntityRESTApi()
var typeName = typeName_example; // {String} 
var opts = {
  'atlasClassification': [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] // {array[AtlasClassification]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new EntityRESTApi();
            var typeName = typeName_example;  // String |  (default to null)
            var atlasClassification = new array[AtlasClassification](); // array[AtlasClassification] |  (optional) 

            try {
                apiInstance.updateClassificationsByUniqueAttribute(typeName, atlasClassification);
            } catch (Exception e) {
                Debug.Print("Exception when calling EntityRESTApi.updateClassificationsByUniqueAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EntityRESTApi();
$typeName = typeName_example; // String | 
$atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification] | 

try {
    $api_instance->updateClassificationsByUniqueAttribute($typeName, $atlasClassification);
} catch (Exception $e) {
    echo 'Exception when calling EntityRESTApi->updateClassificationsByUniqueAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EntityRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EntityRESTApi->new();
my $typeName = typeName_example; # String | 
my $atlasClassification = [WWW::OPenAPIClient::Object::array[AtlasClassification]->new()]; # array[AtlasClassification] | 

eval {
    $api_instance->updateClassificationsByUniqueAttribute(typeName => $typeName, atlasClassification => $atlasClassification);
};
if ($@) {
    warn "Exception when calling EntityRESTApi->updateClassificationsByUniqueAttribute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EntityRESTApi()
typeName = typeName_example # String |  (default to null)
atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}] # array[AtlasClassification] |  (optional)

try:
    api_instance.update_classifications_by_unique_attribute(typeName, atlasClassification=atlasClassification)
except ApiException as e:
    print("Exception when calling EntityRESTApi->updateClassificationsByUniqueAttribute: %s\n" % e)
extern crate EntityRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let atlasClassification = [{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}]; // array[AtlasClassification]

    let mut context = EntityRESTApi::Context::default();
    let result = client.updateClassificationsByUniqueAttribute(typeName, atlasClassification, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Required
Body parameters
Name Description
atlasClassification

Responses


GlossaryREST

assignTermToEntities

Assign the given term to the provided list of entity headers


/v2/glossary/terms/{termGuid}/assignedEntities

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities" \
 -d '{
  "displayText" : "...",
  "entityStatus" : "DELETED",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.assignTermToEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#assignTermToEntities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | Glossary term GUID
final array[AtlasRelatedObjectId] atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] | 

try {
    final result = await api_instance.assignTermToEntities(termGuid, atlasRelatedObjectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->assignTermToEntities: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.assignTermToEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#assignTermToEntities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // Glossary term GUID (default to null)
array[AtlasRelatedObjectId] *atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; //  (optional)

[apiInstance assignTermToEntitiesWith:termGuid
    atlasRelatedObjectId:atlasRelatedObjectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} Glossary term GUID
var opts = {
  'atlasRelatedObjectId': [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] // {array[AtlasRelatedObjectId]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | Glossary term GUID (default to null)
            var atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] |  (optional) 

            try {
                apiInstance.assignTermToEntities(termGuid, atlasRelatedObjectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.assignTermToEntities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | Glossary term GUID
$atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

try {
    $api_instance->assignTermToEntities($termGuid, $atlasRelatedObjectId);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->assignTermToEntities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | Glossary term GUID
my $atlasRelatedObjectId = [WWW::OPenAPIClient::Object::array[AtlasRelatedObjectId]->new()]; # array[AtlasRelatedObjectId] | 

eval {
    $api_instance->assignTermToEntities(termGuid => $termGuid, atlasRelatedObjectId => $atlasRelatedObjectId);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->assignTermToEntities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | Glossary term GUID (default to null)
atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] # array[AtlasRelatedObjectId] |  (optional)

try:
    api_instance.assign_term_to_entities(termGuid, atlasRelatedObjectId=atlasRelatedObjectId)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->assignTermToEntities: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.assignTermToEntities(termGuid, atlasRelatedObjectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
Glossary term GUID
Required
Body parameters
Name Description
atlasRelatedObjectId

Related Entity IDs to which the term has to be associated

Responses


createGlossary

Create a glossary


/v2/glossary

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary" \
 -d '{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossary atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

        try {
            apiInstance.createGlossary(atlasGlossary);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasGlossary atlasGlossary = new AtlasGlossary(); // AtlasGlossary | 

try {
    final result = await api_instance.createGlossary(atlasGlossary);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossary atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

        try {
            apiInstance.createGlossary(atlasGlossary);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
AtlasGlossary *atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance createGlossaryWith:atlasGlossary
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'atlasGlossary': {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossary} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var atlasGlossary = new AtlasGlossary(); // AtlasGlossary |  (optional) 

            try {
                apiInstance.createGlossary(atlasGlossary);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.createGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

try {
    $api_instance->createGlossary($atlasGlossary);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->createGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $atlasGlossary = WWW::OPenAPIClient::Object::AtlasGlossary->new(); # AtlasGlossary | 

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossary |  (optional)

try:
    api_instance.create_glossary(atlasGlossary=atlasGlossary)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->createGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.createGlossary(atlasGlossary, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasGlossary

Glossary definition, terms & categories can be anchored to a glossary using the anchor attribute when creating the Term/Category

Responses


createGlossaryCategories

Create glossary category in bulk


/v2/glossary/categories

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/categories" \
 -d '{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        array[AtlasGlossaryCategory] atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryCategory] | 

        try {
            apiInstance.createGlossaryCategories(atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryCategories");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[AtlasGlossaryCategory] atlasGlossaryCategory = new array[AtlasGlossaryCategory](); // array[AtlasGlossaryCategory] | 

try {
    final result = await api_instance.createGlossaryCategories(atlasGlossaryCategory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createGlossaryCategories: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        array[AtlasGlossaryCategory] atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryCategory] | 

        try {
            apiInstance.createGlossaryCategories(atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryCategories");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
array[AtlasGlossaryCategory] *atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; //  (optional)

[apiInstance createGlossaryCategoriesWith:atlasGlossaryCategory
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'atlasGlossaryCategory': [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}] // {array[AtlasGlossaryCategory]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var atlasGlossaryCategory = new array[AtlasGlossaryCategory](); // array[AtlasGlossaryCategory] |  (optional) 

            try {
                apiInstance.createGlossaryCategories(atlasGlossaryCategory);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.createGlossaryCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryCategory] | 

try {
    $api_instance->createGlossaryCategories($atlasGlossaryCategory);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->createGlossaryCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $atlasGlossaryCategory = [WWW::OPenAPIClient::Object::array[AtlasGlossaryCategory]->new()]; # array[AtlasGlossaryCategory] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}] # array[AtlasGlossaryCategory] |  (optional)

try:
    api_instance.create_glossary_categories(atlasGlossaryCategory=atlasGlossaryCategory)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->createGlossaryCategories: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let atlasGlossaryCategory = [{"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryCategory]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.createGlossaryCategories(atlasGlossaryCategory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasGlossaryCategory

glossary category definitions

Responses


createGlossaryCategory

Create glossary category


/v2/glossary/category

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/category" \
 -d '{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossaryCategory atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

        try {
            apiInstance.createGlossaryCategory(atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryCategory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasGlossaryCategory atlasGlossaryCategory = new AtlasGlossaryCategory(); // AtlasGlossaryCategory | 

try {
    final result = await api_instance.createGlossaryCategory(atlasGlossaryCategory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createGlossaryCategory: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossaryCategory atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

        try {
            apiInstance.createGlossaryCategory(atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryCategory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
AtlasGlossaryCategory *atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance createGlossaryCategoryWith:atlasGlossaryCategory
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'atlasGlossaryCategory': {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossaryCategory} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var atlasGlossaryCategory = new AtlasGlossaryCategory(); // AtlasGlossaryCategory |  (optional) 

            try {
                apiInstance.createGlossaryCategory(atlasGlossaryCategory);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.createGlossaryCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

try {
    $api_instance->createGlossaryCategory($atlasGlossaryCategory);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->createGlossaryCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $atlasGlossaryCategory = WWW::OPenAPIClient::Object::AtlasGlossaryCategory->new(); # AtlasGlossaryCategory | 

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossaryCategory |  (optional)

try:
    api_instance.create_glossary_category(atlasGlossaryCategory=atlasGlossaryCategory)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->createGlossaryCategory: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.createGlossaryCategory(atlasGlossaryCategory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasGlossaryCategory

glossary category definition, a category must be anchored to a Glossary when creating Optionally, terms belonging to the category and the hierarchy can also be defined during creation

Responses


createGlossaryTerm

Create a glossary term


/v2/glossary/term

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/term" \
 -d '{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossaryTerm atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

        try {
            apiInstance.createGlossaryTerm(atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasGlossaryTerm atlasGlossaryTerm = new AtlasGlossaryTerm(); // AtlasGlossaryTerm | 

try {
    final result = await api_instance.createGlossaryTerm(atlasGlossaryTerm);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createGlossaryTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        AtlasGlossaryTerm atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

        try {
            apiInstance.createGlossaryTerm(atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
AtlasGlossaryTerm *atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance createGlossaryTermWith:atlasGlossaryTerm
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'atlasGlossaryTerm': {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossaryTerm} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var atlasGlossaryTerm = new AtlasGlossaryTerm(); // AtlasGlossaryTerm |  (optional) 

            try {
                apiInstance.createGlossaryTerm(atlasGlossaryTerm);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.createGlossaryTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

try {
    $api_instance->createGlossaryTerm($atlasGlossaryTerm);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->createGlossaryTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $atlasGlossaryTerm = WWW::OPenAPIClient::Object::AtlasGlossaryTerm->new(); # AtlasGlossaryTerm | 

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossaryTerm |  (optional)

try:
    api_instance.create_glossary_term(atlasGlossaryTerm=atlasGlossaryTerm)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->createGlossaryTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OBSOLETE"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.createGlossaryTerm(atlasGlossaryTerm, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasGlossaryTerm

Glossary term definition, a term must be anchored to a Glossary at the time of creation optionally it can be categorized as well

Responses


createGlossaryTerms

Create glossary terms in bulk


/v2/glossary/terms

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/terms" \
 -d '{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        array[AtlasGlossaryTerm] atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryTerm] | 

        try {
            apiInstance.createGlossaryTerms(atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final array[AtlasGlossaryTerm] atlasGlossaryTerm = new array[AtlasGlossaryTerm](); // array[AtlasGlossaryTerm] | 

try {
    final result = await api_instance.createGlossaryTerms(atlasGlossaryTerm);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createGlossaryTerms: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        array[AtlasGlossaryTerm] atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryTerm] | 

        try {
            apiInstance.createGlossaryTerms(atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#createGlossaryTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
array[AtlasGlossaryTerm] *atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; //  (optional)

[apiInstance createGlossaryTermsWith:atlasGlossaryTerm
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'atlasGlossaryTerm': [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}] // {array[AtlasGlossaryTerm]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var atlasGlossaryTerm = new array[AtlasGlossaryTerm](); // array[AtlasGlossaryTerm] |  (optional) 

            try {
                apiInstance.createGlossaryTerms(atlasGlossaryTerm);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.createGlossaryTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryTerm] | 

try {
    $api_instance->createGlossaryTerms($atlasGlossaryTerm);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->createGlossaryTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $atlasGlossaryTerm = [WWW::OPenAPIClient::Object::array[AtlasGlossaryTerm]->new()]; # array[AtlasGlossaryTerm] | 

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}] # array[AtlasGlossaryTerm] |  (optional)

try:
    api_instance.create_glossary_terms(atlasGlossaryTerm=atlasGlossaryTerm)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->createGlossaryTerms: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let atlasGlossaryTerm = [{"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"DEPRECATED"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}]; // array[AtlasGlossaryTerm]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.createGlossaryTerms(atlasGlossaryTerm, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasGlossaryTerm

glossary term definitions

Responses


deleteGlossary

Delete a glossary


/v2/glossary/{glossaryGuid}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary

        try {
            apiInstance.deleteGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary

try {
    final result = await api_instance.deleteGlossary(glossaryGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary

        try {
            apiInstance.deleteGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary (default to null)

[apiInstance deleteGlossaryWith:glossaryGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary (default to null)

            try {
                apiInstance.deleteGlossary(glossaryGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.deleteGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary

try {
    $api_instance->deleteGlossary($glossaryGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->deleteGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary (default to null)

try:
    api_instance.delete_glossary(glossaryGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->deleteGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.deleteGlossary(glossaryGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary
Required

Responses


deleteGlossaryCategory

Delete a glossary category


/v2/glossary/category/{categoryGuid}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

        try {
            apiInstance.deleteGlossaryCategory(categoryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossaryCategory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary category

try {
    final result = await api_instance.deleteGlossaryCategory(categoryGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGlossaryCategory: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

        try {
            apiInstance.deleteGlossaryCategory(categoryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossaryCategory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary category (default to null)

[apiInstance deleteGlossaryCategoryWith:categoryGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary category

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary category (default to null)

            try {
                apiInstance.deleteGlossaryCategory(categoryGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.deleteGlossaryCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

try {
    $api_instance->deleteGlossaryCategory($categoryGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->deleteGlossaryCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary category

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary category (default to null)

try:
    api_instance.delete_glossary_category(categoryGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->deleteGlossaryCategory: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.deleteGlossaryCategory(categoryGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary category
Required

Responses


deleteGlossaryTerm

Delete a glossary term


/v2/glossary/term/{termGuid}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/glossary/term/{termGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term

        try {
            apiInstance.deleteGlossaryTerm(termGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossaryTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | unique identifier for glossary term

try {
    final result = await api_instance.deleteGlossaryTerm(termGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteGlossaryTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term

        try {
            apiInstance.deleteGlossaryTerm(termGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#deleteGlossaryTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // unique identifier for glossary term (default to null)

[apiInstance deleteGlossaryTermWith:termGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} unique identifier for glossary term

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | unique identifier for glossary term (default to null)

            try {
                apiInstance.deleteGlossaryTerm(termGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.deleteGlossaryTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | unique identifier for glossary term

try {
    $api_instance->deleteGlossaryTerm($termGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->deleteGlossaryTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | unique identifier for glossary term

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | unique identifier for glossary term (default to null)

try:
    api_instance.delete_glossary_term(termGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->deleteGlossaryTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.deleteGlossaryTerm(termGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
unique identifier for glossary term
Required

Responses


disassociateTermAssignmentFromEntities

Remove the term assignment for the given list of entity headers


/v2/glossary/terms/{termGuid}/assignedEntities

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities" \
 -d '{
  "displayText" : "...",
  "entityStatus" : "DELETED",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.disassociateTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#disassociateTermAssignmentFromEntities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | Glossary term GUID
final array[AtlasRelatedObjectId] atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] | 

try {
    final result = await api_instance.disassociateTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->disassociateTermAssignmentFromEntities: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.disassociateTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#disassociateTermAssignmentFromEntities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // Glossary term GUID (default to null)
array[AtlasRelatedObjectId] *atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; //  (optional)

[apiInstance disassociateTermAssignmentFromEntitiesWith:termGuid
    atlasRelatedObjectId:atlasRelatedObjectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} Glossary term GUID
var opts = {
  'atlasRelatedObjectId': [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] // {array[AtlasRelatedObjectId]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | Glossary term GUID (default to null)
            var atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] |  (optional) 

            try {
                apiInstance.disassociateTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.disassociateTermAssignmentFromEntities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | Glossary term GUID
$atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

try {
    $api_instance->disassociateTermAssignmentFromEntities($termGuid, $atlasRelatedObjectId);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->disassociateTermAssignmentFromEntities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | Glossary term GUID
my $atlasRelatedObjectId = [WWW::OPenAPIClient::Object::array[AtlasRelatedObjectId]->new()]; # array[AtlasRelatedObjectId] | 

eval {
    $api_instance->disassociateTermAssignmentFromEntities(termGuid => $termGuid, atlasRelatedObjectId => $atlasRelatedObjectId);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->disassociateTermAssignmentFromEntities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | Glossary term GUID (default to null)
atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] # array[AtlasRelatedObjectId] |  (optional)

try:
    api_instance.disassociate_term_assignment_from_entities(termGuid, atlasRelatedObjectId=atlasRelatedObjectId)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->disassociateTermAssignmentFromEntities: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let atlasRelatedObjectId = [{"displayText":"...","entityStatus":"PURGED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.disassociateTermAssignmentFromEntities(termGuid, atlasRelatedObjectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
Glossary term GUID
Required
Body parameters
Name Description
atlasRelatedObjectId

List of related entity IDs from which the term has to be dissociated

Responses


getCategoryTerms

Get all terms associated with the specific category


/v2/glossary/category/{categoryGuid}/terms

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}/terms?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getCategoryTerms(categoryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getCategoryTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary category
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getCategoryTerms(categoryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getCategoryTerms: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getCategoryTerms(categoryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getCategoryTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary category (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getCategoryTermsWith:categoryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary category
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary category (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getCategoryTerms(categoryGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getCategoryTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $api_instance->getCategoryTerms($categoryGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getCategoryTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary category
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    $api_instance->getCategoryTerms(categoryGuid => $categoryGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getCategoryTerms: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary category (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_category_terms(categoryGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getCategoryTerms: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getCategoryTerms(categoryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary category
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


getDetailedGlossary

Get a specific Glossary


/v2/glossary/{glossaryGuid}/detailed

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/detailed"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

        try {
            apiInstance.getDetailedGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getDetailedGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique glossary identifier

try {
    final result = await api_instance.getDetailedGlossary(glossaryGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getDetailedGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

        try {
            apiInstance.getDetailedGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getDetailedGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique glossary identifier (default to null)

[apiInstance getDetailedGlossaryWith:glossaryGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique glossary identifier

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique glossary identifier (default to null)

            try {
                apiInstance.getDetailedGlossary(glossaryGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getDetailedGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

try {
    $api_instance->getDetailedGlossary($glossaryGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getDetailedGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique glossary identifier

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique glossary identifier (default to null)

try:
    api_instance.get_detailed_glossary(glossaryGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getDetailedGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getDetailedGlossary(glossaryGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique glossary identifier
Required

Responses


getEntitiesAssignedWithTerm

Get all entity headers assigned with the specified term


/v2/glossary/terms/{termGuid}/assignedEntities

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | GUID of the term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getEntitiesAssignedWithTerm(termGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getEntitiesAssignedWithTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | GUID of the term
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getEntitiesAssignedWithTerm(termGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntitiesAssignedWithTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | GUID of the term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getEntitiesAssignedWithTerm(termGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getEntitiesAssignedWithTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // GUID of the term (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getEntitiesAssignedWithTermWith:termGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} GUID of the term
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | GUID of the term (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getEntitiesAssignedWithTerm(termGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getEntitiesAssignedWithTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | GUID of the term
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $api_instance->getEntitiesAssignedWithTerm($termGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getEntitiesAssignedWithTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | GUID of the term
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    $api_instance->getEntitiesAssignedWithTerm(termGuid => $termGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getEntitiesAssignedWithTerm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | GUID of the term (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_entities_assigned_with_term(termGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getEntitiesAssignedWithTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getEntitiesAssignedWithTerm(termGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
GUID of the term
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


getGlossaries

Retrieve all glossaries registered with Atlas


/v2/glossary

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | Sort order, ASC (default) or DESC

        try {
            apiInstance.getGlossaries(limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaries");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | Sort order, ASC (default) or DESC

try {
    final result = await api_instance.getGlossaries(limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaries: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | Sort order, ASC (default) or DESC

        try {
            apiInstance.getGlossaries(limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaries");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // Sort order, ASC (default) or DESC (optional) (default to ASC)

[apiInstance getGlossariesWith:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} Sort order, ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | Sort order, ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getGlossaries(limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaries: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | Sort order, ASC (default) or DESC

try {
    $api_instance->getGlossaries($limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaries: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | Sort order, ASC (default) or DESC

eval {
    $api_instance->getGlossaries(limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getGlossaries: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | Sort order, ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_glossaries(limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaries: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaries(limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
Sort order, ASC (default) or DESC

Responses


getGlossary

Get a specific Glossary


/v2/glossary/{glossaryGuid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

        try {
            apiInstance.getGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique glossary identifier

try {
    final result = await api_instance.getGlossary(glossaryGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

        try {
            apiInstance.getGlossary(glossaryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique glossary identifier (default to null)

[apiInstance getGlossaryWith:glossaryGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique glossary identifier

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique glossary identifier (default to null)

            try {
                apiInstance.getGlossary(glossaryGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique glossary identifier

try {
    $api_instance->getGlossary($glossaryGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique glossary identifier

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique glossary identifier (default to null)

try:
    api_instance.get_glossary(glossaryGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossary(glossaryGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique glossary identifier
Required

Responses


getGlossaryCategories

Get the categories belonging to a specific glossary


/v2/glossary/{glossaryGuid}/categories

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/categories?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getGlossaryCategories(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategories");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary term
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getGlossaryCategories(glossaryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryCategories: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getGlossaryCategories(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategories");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary term (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getGlossaryCategoriesWith:glossaryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary term
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary term (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getGlossaryCategories(glossaryGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $api_instance->getGlossaryCategories($glossaryGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary term
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    $api_instance->getGlossaryCategories(glossaryGuid => $glossaryGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getGlossaryCategories: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary term (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_glossary_categories(glossaryGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryCategories: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryCategories(glossaryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary term
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


getGlossaryCategoriesHeaders

Get the categories belonging to a specific glossary


/v2/glossary/{glossaryGuid}/categories/headers

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/categories/headers?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getGlossaryCategoriesHeaders(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategoriesHeaders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary term
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getGlossaryCategoriesHeaders(glossaryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryCategoriesHeaders: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getGlossaryCategoriesHeaders(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategoriesHeaders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary term (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getGlossaryCategoriesHeadersWith:glossaryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary term
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary term (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getGlossaryCategoriesHeaders(glossaryGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryCategoriesHeaders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $api_instance->getGlossaryCategoriesHeaders($glossaryGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryCategoriesHeaders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary term
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    $api_instance->getGlossaryCategoriesHeaders(glossaryGuid => $glossaryGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getGlossaryCategoriesHeaders: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary term (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_glossary_categories_headers(glossaryGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryCategoriesHeaders: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryCategoriesHeaders(glossaryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary term
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


getGlossaryCategory

Get specific glossary category


/v2/glossary/category/{categoryGuid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

        try {
            apiInstance.getGlossaryCategory(categoryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary category

try {
    final result = await api_instance.getGlossaryCategory(categoryGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryCategory: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

        try {
            apiInstance.getGlossaryCategory(categoryGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryCategory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary category (default to null)

[apiInstance getGlossaryCategoryWith:categoryGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary category

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary category (default to null)

            try {
                apiInstance.getGlossaryCategory(categoryGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary category

try {
    $api_instance->getGlossaryCategory($categoryGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary category

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary category (default to null)

try:
    api_instance.get_glossary_category(categoryGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryCategory: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryCategory(categoryGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary category
Required

Responses


getGlossaryTerm

Get specific glossary term


/v2/glossary/term/{termGuid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/term/{termGuid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term

        try {
            apiInstance.getGlossaryTerm(termGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | unique identifier for glossary term

try {
    final result = await api_instance.getGlossaryTerm(termGuid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term

        try {
            apiInstance.getGlossaryTerm(termGuid);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // unique identifier for glossary term (default to null)

[apiInstance getGlossaryTermWith:termGuid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} unique identifier for glossary term

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | unique identifier for glossary term (default to null)

            try {
                apiInstance.getGlossaryTerm(termGuid);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | unique identifier for glossary term

try {
    $api_instance->getGlossaryTerm($termGuid);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | unique identifier for glossary term

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | unique identifier for glossary term (default to null)

try:
    api_instance.get_glossary_term(termGuid)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryTerm(termGuid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
unique identifier for glossary term
Required

Responses


getGlossaryTermHeaders

Get term headers belonging to a specific glossary


/v2/glossary/{glossaryGuid}/terms/headers

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/terms/headers?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | starting offset for loading terms
        String sort = sort_example; // String | ASC(default) or DESC

        try {
            apiInstance.getGlossaryTermHeaders(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTermHeaders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | starting offset for loading terms
final String sort = new String(); // String | ASC(default) or DESC

try {
    final result = await api_instance.getGlossaryTermHeaders(glossaryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryTermHeaders: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | starting offset for loading terms
        String sort = sort_example; // String | ASC(default) or DESC

        try {
            apiInstance.getGlossaryTermHeaders(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTermHeaders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // starting offset for loading terms (optional) (default to 0)
String *sort = sort_example; // ASC(default) or DESC (optional) (default to ASC)

[apiInstance getGlossaryTermHeadersWith:glossaryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} starting offset for loading terms
  'sort': sort_example // {String} ASC(default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | starting offset for loading terms (optional)  (default to 0)
            var sort = sort_example;  // String | ASC(default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getGlossaryTermHeaders(glossaryGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryTermHeaders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | starting offset for loading terms
$sort = sort_example; // String | ASC(default) or DESC

try {
    $api_instance->getGlossaryTermHeaders($glossaryGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryTermHeaders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | starting offset for loading terms
my $sort = sort_example; # String | ASC(default) or DESC

eval {
    $api_instance->getGlossaryTermHeaders(glossaryGuid => $glossaryGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getGlossaryTermHeaders: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | starting offset for loading terms (optional) (default to 0)
sort = sort_example # String | ASC(default) or DESC (optional) (default to ASC)

try:
    api_instance.get_glossary_term_headers(glossaryGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryTermHeaders: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryTermHeaders(glossaryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
starting offset for loading terms
sort
String
ASC(default) or DESC

Responses


getGlossaryTerms

Get terms belonging to a specific glossary


/v2/glossary/{glossaryGuid}/terms

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/terms?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | starting offset for loading terms
        String sort = sort_example; // String | ASC(default) or DESC

        try {
            apiInstance.getGlossaryTerms(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | starting offset for loading terms
final String sort = new String(); // String | ASC(default) or DESC

try {
    final result = await api_instance.getGlossaryTerms(glossaryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getGlossaryTerms: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | starting offset for loading terms
        String sort = sort_example; // String | ASC(default) or DESC

        try {
            apiInstance.getGlossaryTerms(glossaryGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getGlossaryTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // starting offset for loading terms (optional) (default to 0)
String *sort = sort_example; // ASC(default) or DESC (optional) (default to ASC)

[apiInstance getGlossaryTermsWith:glossaryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} starting offset for loading terms
  'sort': sort_example // {String} ASC(default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | starting offset for loading terms (optional)  (default to 0)
            var sort = sort_example;  // String | ASC(default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getGlossaryTerms(glossaryGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getGlossaryTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | starting offset for loading terms
$sort = sort_example; // String | ASC(default) or DESC

try {
    $api_instance->getGlossaryTerms($glossaryGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getGlossaryTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | starting offset for loading terms
my $sort = sort_example; # String | ASC(default) or DESC

eval {
    $api_instance->getGlossaryTerms(glossaryGuid => $glossaryGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getGlossaryTerms: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | starting offset for loading terms (optional) (default to 0)
sort = sort_example # String | ASC(default) or DESC (optional) (default to ASC)

try:
    api_instance.get_glossary_terms(glossaryGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getGlossaryTerms: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getGlossaryTerms(glossaryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
starting offset for loading terms
sort
String
ASC(default) or DESC

Responses


getRelatedCategories

Get all related categories (parent and children)


/v2/glossary/category/{categoryGuid}/related

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}/related?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            map['String', array[AtlasRelatedCategoryHeader]] result = apiInstance.getRelatedCategories(categoryGuid, limit, offset, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getRelatedCategories");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary category
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getRelatedCategories(categoryGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRelatedCategories: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            map['String', array[AtlasRelatedCategoryHeader]] result = apiInstance.getRelatedCategories(categoryGuid, limit, offset, sort);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getRelatedCategories");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary category (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getRelatedCategoriesWith:categoryGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(map['String', array[AtlasRelatedCategoryHeader]] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary category
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary category (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                map['String', array[AtlasRelatedCategoryHeader]] result = apiInstance.getRelatedCategories(categoryGuid, limit, offset, sort);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getRelatedCategories: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $result = $api_instance->getRelatedCategories($categoryGuid, $limit, $offset, $sort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getRelatedCategories: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary category
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    my $result = $api_instance->getRelatedCategories(categoryGuid => $categoryGuid, limit => $limit, offset => $offset, sort => $sort);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getRelatedCategories: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary category (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_response = api_instance.get_related_categories(categoryGuid, limit=limit, offset=offset, sort=sort)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getRelatedCategories: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getRelatedCategories(categoryGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary category
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


getRelatedTerms

Get all related terms for a specific term


/v2/glossary/terms/{termGuid}/related

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/glossary/terms/{termGuid}/related?limit=limit_example&offset=offset_example&sort=sort_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getRelatedTerms(termGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getRelatedTerms");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | unique identifier for glossary term
final String limit = new String(); // String | page size - by default there is no paging
final String offset = new String(); // String | offset for pagination purpose
final String sort = new String(); // String | ASC (default) or DESC

try {
    final result = await api_instance.getRelatedTerms(termGuid, limit, offset, sort);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRelatedTerms: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        String limit = limit_example; // String | page size - by default there is no paging
        String offset = offset_example; // String | offset for pagination purpose
        String sort = sort_example; // String | ASC (default) or DESC

        try {
            apiInstance.getRelatedTerms(termGuid, limit, offset, sort);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#getRelatedTerms");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // unique identifier for glossary term (default to null)
String *limit = limit_example; // page size - by default there is no paging (optional) (default to -1)
String *offset = offset_example; // offset for pagination purpose (optional) (default to 0)
String *sort = sort_example; // ASC (default) or DESC (optional) (default to ASC)

[apiInstance getRelatedTermsWith:termGuid
    limit:limit
    offset:offset
    sort:sort
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} unique identifier for glossary term
var opts = {
  'limit': limit_example, // {String} page size - by default there is no paging
  'offset': offset_example, // {String} offset for pagination purpose
  'sort': sort_example // {String} ASC (default) or DESC
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | unique identifier for glossary term (default to null)
            var limit = limit_example;  // String | page size - by default there is no paging (optional)  (default to -1)
            var offset = offset_example;  // String | offset for pagination purpose (optional)  (default to 0)
            var sort = sort_example;  // String | ASC (default) or DESC (optional)  (default to ASC)

            try {
                apiInstance.getRelatedTerms(termGuid, limit, offset, sort);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.getRelatedTerms: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | unique identifier for glossary term
$limit = limit_example; // String | page size - by default there is no paging
$offset = offset_example; // String | offset for pagination purpose
$sort = sort_example; // String | ASC (default) or DESC

try {
    $api_instance->getRelatedTerms($termGuid, $limit, $offset, $sort);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->getRelatedTerms: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | unique identifier for glossary term
my $limit = limit_example; # String | page size - by default there is no paging
my $offset = offset_example; # String | offset for pagination purpose
my $sort = sort_example; # String | ASC (default) or DESC

eval {
    $api_instance->getRelatedTerms(termGuid => $termGuid, limit => $limit, offset => $offset, sort => $sort);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->getRelatedTerms: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | unique identifier for glossary term (default to null)
limit = limit_example # String | page size - by default there is no paging (optional) (default to -1)
offset = offset_example # String | offset for pagination purpose (optional) (default to 0)
sort = sort_example # String | ASC (default) or DESC (optional) (default to ASC)

try:
    api_instance.get_related_terms(termGuid, limit=limit, offset=offset, sort=sort)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->getRelatedTerms: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let limit = limit_example; // String
    let offset = offset_example; // String
    let sort = sort_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.getRelatedTerms(termGuid, limit, offset, sort, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
unique identifier for glossary term
Required
Query parameters
Name Description
limit
String
page size - by default there is no paging
offset
String
offset for pagination purpose
sort
String
ASC (default) or DESC

Responses


importGlossaryData

Upload glossary file for creating AtlasGlossaryTerms in bulk


/v2/glossary/import

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: multipart/form-data" \
 "http://localhost/api/atlas/v2/glossary/import"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
        String inputStream = inputStream_example; // String | InputStream of file

        try {
            apiInstance.importGlossaryData(fileDetail, inputStream);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#importGlossaryData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String fileDetail = new String(); // String | FormDataContentDisposition metadata of file
final String inputStream = new String(); // String | InputStream of file

try {
    final result = await api_instance.importGlossaryData(fileDetail, inputStream);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->importGlossaryData: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
        String inputStream = inputStream_example; // String | InputStream of file

        try {
            apiInstance.importGlossaryData(fileDetail, inputStream);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#importGlossaryData");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *fileDetail = fileDetail_example; // FormDataContentDisposition metadata of file (optional) (default to null)
String *inputStream = inputStream_example; // InputStream of file (optional) (default to null)

[apiInstance importGlossaryDataWith:fileDetail
    inputStream:inputStream
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var opts = {
  'fileDetail': fileDetail_example, // {String} FormDataContentDisposition metadata of file
  'inputStream': inputStream_example // {String} InputStream of file
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var fileDetail = fileDetail_example;  // String | FormDataContentDisposition metadata of file (optional)  (default to null)
            var inputStream = inputStream_example;  // String | InputStream of file (optional)  (default to null)

            try {
                apiInstance.importGlossaryData(fileDetail, inputStream);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.importGlossaryData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$fileDetail = fileDetail_example; // String | FormDataContentDisposition metadata of file
$inputStream = inputStream_example; // String | InputStream of file

try {
    $api_instance->importGlossaryData($fileDetail, $inputStream);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->importGlossaryData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $fileDetail = fileDetail_example; # String | FormDataContentDisposition metadata of file
my $inputStream = inputStream_example; # String | InputStream of file

eval {
    $api_instance->importGlossaryData(fileDetail => $fileDetail, inputStream => $inputStream);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->importGlossaryData: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
fileDetail = fileDetail_example # String | FormDataContentDisposition metadata of file (optional) (default to null)
inputStream = inputStream_example # String | InputStream of file (optional) (default to null)

try:
    api_instance.import_glossary_data(fileDetail=fileDetail, inputStream=inputStream)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->importGlossaryData: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let fileDetail = fileDetail_example; // String
    let inputStream = inputStream_example; // String

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.importGlossaryData(fileDetail, inputStream, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Form parameters
Name Description
fileDetail
String
FormDataContentDisposition metadata of file
inputStream
String
InputStream of file

Responses


partialUpdateGlossary

Partially update the glossary


/v2/glossary/{glossaryGuid}/partial

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}/partial" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossary(glossaryGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary term
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.partialUpdateGlossary(glossaryGuid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->partialUpdateGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossary(glossaryGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary term (default to null)
map[String, String] *requestBody = ; //  (optional)

[apiInstance partialUpdateGlossaryWith:glossaryGuid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary term
var opts = {
  'requestBody':  // {map[String, String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary term (default to null)
            var requestBody = new map[String, String](); // map[String, String] |  (optional) 

            try {
                apiInstance.partialUpdateGlossary(glossaryGuid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.partialUpdateGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary term
$requestBody = ; // map[String, String] | 

try {
    $api_instance->partialUpdateGlossary($glossaryGuid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->partialUpdateGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary term
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    $api_instance->partialUpdateGlossary(glossaryGuid => $glossaryGuid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->partialUpdateGlossary: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary term (default to null)
requestBody =  # map[String, String] |  (optional)

try:
    api_instance.partial_update_glossary(glossaryGuid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->partialUpdateGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let requestBody = ; // map[String, String]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.partialUpdateGlossary(glossaryGuid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary term
Required
Body parameters
Name Description
requestBody

Map containing keys as attribute names and values as corresponding attribute values

Responses


partialUpdateGlossaryCategory

Partially update the glossary category


/v2/glossary/category/{categoryGuid}/partial

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}/partial" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossaryCategory(categoryGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossaryCategory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary term
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.partialUpdateGlossaryCategory(categoryGuid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->partialUpdateGlossaryCategory: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossaryCategory(categoryGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossaryCategory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary term (default to null)
map[String, String] *requestBody = ; //  (optional)

[apiInstance partialUpdateGlossaryCategoryWith:categoryGuid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary term
var opts = {
  'requestBody':  // {map[String, String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary term (default to null)
            var requestBody = new map[String, String](); // map[String, String] |  (optional) 

            try {
                apiInstance.partialUpdateGlossaryCategory(categoryGuid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.partialUpdateGlossaryCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary term
$requestBody = ; // map[String, String] | 

try {
    $api_instance->partialUpdateGlossaryCategory($categoryGuid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->partialUpdateGlossaryCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary term
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    $api_instance->partialUpdateGlossaryCategory(categoryGuid => $categoryGuid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->partialUpdateGlossaryCategory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary term (default to null)
requestBody =  # map[String, String] |  (optional)

try:
    api_instance.partial_update_glossary_category(categoryGuid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->partialUpdateGlossaryCategory: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String
    let requestBody = ; // map[String, String]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.partialUpdateGlossaryCategory(categoryGuid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary term
Required
Body parameters
Name Description
requestBody

Map containing keys as attribute names and values as corresponding attribute values

Responses


partialUpdateGlossaryTerm

Partially update the glossary term


/v2/glossary/term/{termGuid}/partial

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/term/{termGuid}/partial" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossaryTerm(termGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossaryTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | unique identifier for glossary term
final map[String, String] requestBody = new map[String, String](); // map[String, String] | 

try {
    final result = await api_instance.partialUpdateGlossaryTerm(termGuid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->partialUpdateGlossaryTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        map[String, String] requestBody = ; // map[String, String] | 

        try {
            apiInstance.partialUpdateGlossaryTerm(termGuid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#partialUpdateGlossaryTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // unique identifier for glossary term (default to null)
map[String, String] *requestBody = ; //  (optional)

[apiInstance partialUpdateGlossaryTermWith:termGuid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} unique identifier for glossary term
var opts = {
  'requestBody':  // {map[String, String]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | unique identifier for glossary term (default to null)
            var requestBody = new map[String, String](); // map[String, String] |  (optional) 

            try {
                apiInstance.partialUpdateGlossaryTerm(termGuid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.partialUpdateGlossaryTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | unique identifier for glossary term
$requestBody = ; // map[String, String] | 

try {
    $api_instance->partialUpdateGlossaryTerm($termGuid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->partialUpdateGlossaryTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | unique identifier for glossary term
my $requestBody = WWW::OPenAPIClient::Object::map[String, String]->new(); # map[String, String] | 

eval {
    $api_instance->partialUpdateGlossaryTerm(termGuid => $termGuid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->partialUpdateGlossaryTerm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | unique identifier for glossary term (default to null)
requestBody =  # map[String, String] |  (optional)

try:
    api_instance.partial_update_glossary_term(termGuid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->partialUpdateGlossaryTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let requestBody = ; // map[String, String]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.partialUpdateGlossaryTerm(termGuid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
unique identifier for glossary term
Required
Body parameters
Name Description
requestBody

Map containing keys as attribute names and values as corresponding attribute values

Responses


produceTemplate2

Get sample template for uploading/creating bulk AtlasGlossaryTerm


/v2/glossary/import/template

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/octet-stream" \
 "http://localhost/api/atlas/v2/glossary/import/template"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();

        try {
            'String' result = apiInstance.produceTemplate2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#produceTemplate2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.produceTemplate2();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->produceTemplate2: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();

        try {
            'String' result = apiInstance.produceTemplate2();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#produceTemplate2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];

[apiInstance produceTemplate2WithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.produceTemplate2(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();

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

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()

try:
    api_response = api_instance.produce_template2()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->produceTemplate2: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.produceTemplate2(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


removeTermAssignmentFromEntities

Remove the term assignment for the given list of entity headers


/v2/glossary/terms/{termGuid}/assignedEntities

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/terms/{termGuid}/assignedEntities" \
 -d '{
  "displayText" : "...",
  "entityStatus" : "DELETED",
  "qualifiedName" : "...",
  "relationshipAttributes" : {
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  },
  "relationshipGuid" : "...",
  "relationshipStatus" : "DELETED",
  "relationshipType" : "...",
  "guid" : "...",
  "typeName" : "...",
  "uniqueAttributes" : {
    "property1" : { },
    "property2" : { }
  }
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.removeTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#removeTermAssignmentFromEntities");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | Glossary term GUID
final array[AtlasRelatedObjectId] atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] | 

try {
    final result = await api_instance.removeTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->removeTermAssignmentFromEntities: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | Glossary term GUID
        array[AtlasRelatedObjectId] atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

        try {
            apiInstance.removeTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#removeTermAssignmentFromEntities");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // Glossary term GUID (default to null)
array[AtlasRelatedObjectId] *atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; //  (optional)

[apiInstance removeTermAssignmentFromEntitiesWith:termGuid
    atlasRelatedObjectId:atlasRelatedObjectId
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} Glossary term GUID
var opts = {
  'atlasRelatedObjectId': [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] // {array[AtlasRelatedObjectId]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | Glossary term GUID (default to null)
            var atlasRelatedObjectId = new array[AtlasRelatedObjectId](); // array[AtlasRelatedObjectId] |  (optional) 

            try {
                apiInstance.removeTermAssignmentFromEntities(termGuid, atlasRelatedObjectId);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.removeTermAssignmentFromEntities: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | Glossary term GUID
$atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId] | 

try {
    $api_instance->removeTermAssignmentFromEntities($termGuid, $atlasRelatedObjectId);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->removeTermAssignmentFromEntities: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | Glossary term GUID
my $atlasRelatedObjectId = [WWW::OPenAPIClient::Object::array[AtlasRelatedObjectId]->new()]; # array[AtlasRelatedObjectId] | 

eval {
    $api_instance->removeTermAssignmentFromEntities(termGuid => $termGuid, atlasRelatedObjectId => $atlasRelatedObjectId);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->removeTermAssignmentFromEntities: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | Glossary term GUID (default to null)
atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}] # array[AtlasRelatedObjectId] |  (optional)

try:
    api_instance.remove_term_assignment_from_entities(termGuid, atlasRelatedObjectId=atlasRelatedObjectId)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->removeTermAssignmentFromEntities: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let atlasRelatedObjectId = [{"displayText":"...","entityStatus":"ACTIVE","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"ACTIVE","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}]; // array[AtlasRelatedObjectId]

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.removeTermAssignmentFromEntities(termGuid, atlasRelatedObjectId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
Glossary term GUID
Required
Body parameters
Name Description
atlasRelatedObjectId

List of related entity IDs from which the term has to be dissociated

Responses


updateGlossary

Update the given glossary


/v2/glossary/{glossaryGuid}

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/{glossaryGuid}" \
 -d '{
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "language" : "...",
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        AtlasGlossary atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

        try {
            apiInstance.updateGlossary(glossaryGuid, atlasGlossary);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossary");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String glossaryGuid = new String(); // String | unique identifier for glossary
final AtlasGlossary atlasGlossary = new AtlasGlossary(); // AtlasGlossary | 

try {
    final result = await api_instance.updateGlossary(glossaryGuid, atlasGlossary);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGlossary: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
        AtlasGlossary atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

        try {
            apiInstance.updateGlossary(glossaryGuid, atlasGlossary);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossary");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *glossaryGuid = glossaryGuid_example; // unique identifier for glossary (default to null)
AtlasGlossary *atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance updateGlossaryWith:glossaryGuid
    atlasGlossary:atlasGlossary
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var glossaryGuid = glossaryGuid_example; // {String} unique identifier for glossary
var opts = {
  'atlasGlossary': {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossary} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var glossaryGuid = glossaryGuid_example;  // String | unique identifier for glossary (default to null)
            var atlasGlossary = new AtlasGlossary(); // AtlasGlossary |  (optional) 

            try {
                apiInstance.updateGlossary(glossaryGuid, atlasGlossary);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.updateGlossary: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$glossaryGuid = glossaryGuid_example; // String | unique identifier for glossary
$atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary | 

try {
    $api_instance->updateGlossary($glossaryGuid, $atlasGlossary);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->updateGlossary: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $glossaryGuid = glossaryGuid_example; # String | unique identifier for glossary
my $atlasGlossary = WWW::OPenAPIClient::Object::AtlasGlossary->new(); # AtlasGlossary | 

eval {
    $api_instance->updateGlossary(glossaryGuid => $glossaryGuid, atlasGlossary => $atlasGlossary);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->updateGlossary: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
glossaryGuid = glossaryGuid_example # String | unique identifier for glossary (default to null)
atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossary |  (optional)

try:
    api_instance.update_glossary(glossaryGuid, atlasGlossary=atlasGlossary)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->updateGlossary: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let glossaryGuid = glossaryGuid_example; // String
    let atlasGlossary = {"categories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"language":"...","terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"usage":"...","additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossary

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.updateGlossary(glossaryGuid, atlasGlossary, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
glossaryGuid*
String
unique identifier for glossary
Required
Body parameters
Name Description
atlasGlossary

Updated glossary definition

Responses


updateGlossaryCategory

Update the given glossary category


/v2/glossary/category/{categoryGuid}

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/category/{categoryGuid}" \
 -d '{
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "childrenCategories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  } ],
  "parentCategory" : {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "parentCategoryGuid" : "...",
    "relationGuid" : "..."
  },
  "terms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        AtlasGlossaryCategory atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

        try {
            apiInstance.updateGlossaryCategory(categoryGuid, atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossaryCategory");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String categoryGuid = new String(); // String | unique identifier for glossary category
final AtlasGlossaryCategory atlasGlossaryCategory = new AtlasGlossaryCategory(); // AtlasGlossaryCategory | 

try {
    final result = await api_instance.updateGlossaryCategory(categoryGuid, atlasGlossaryCategory);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGlossaryCategory: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
        AtlasGlossaryCategory atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

        try {
            apiInstance.updateGlossaryCategory(categoryGuid, atlasGlossaryCategory);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossaryCategory");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *categoryGuid = categoryGuid_example; // unique identifier for glossary category (default to null)
AtlasGlossaryCategory *atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance updateGlossaryCategoryWith:categoryGuid
    atlasGlossaryCategory:atlasGlossaryCategory
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var categoryGuid = categoryGuid_example; // {String} unique identifier for glossary category
var opts = {
  'atlasGlossaryCategory': {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossaryCategory} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var categoryGuid = categoryGuid_example;  // String | unique identifier for glossary category (default to null)
            var atlasGlossaryCategory = new AtlasGlossaryCategory(); // AtlasGlossaryCategory |  (optional) 

            try {
                apiInstance.updateGlossaryCategory(categoryGuid, atlasGlossaryCategory);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.updateGlossaryCategory: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$categoryGuid = categoryGuid_example; // String | unique identifier for glossary category
$atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory | 

try {
    $api_instance->updateGlossaryCategory($categoryGuid, $atlasGlossaryCategory);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->updateGlossaryCategory: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $categoryGuid = categoryGuid_example; # String | unique identifier for glossary category
my $atlasGlossaryCategory = WWW::OPenAPIClient::Object::AtlasGlossaryCategory->new(); # AtlasGlossaryCategory | 

eval {
    $api_instance->updateGlossaryCategory(categoryGuid => $categoryGuid, atlasGlossaryCategory => $atlasGlossaryCategory);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->updateGlossaryCategory: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
categoryGuid = categoryGuid_example # String | unique identifier for glossary category (default to null)
atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossaryCategory |  (optional)

try:
    api_instance.update_glossary_category(categoryGuid, atlasGlossaryCategory=atlasGlossaryCategory)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->updateGlossaryCategory: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let categoryGuid = categoryGuid_example; // String
    let atlasGlossaryCategory = {"anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"childrenCategories":[{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."}],"parentCategory":{"categoryGuid":"...","description":"...","displayText":"...","parentCategoryGuid":"...","relationGuid":"..."},"terms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryCategory

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.updateGlossaryCategory(categoryGuid, atlasGlossaryCategory, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
categoryGuid*
String
unique identifier for glossary category
Required
Body parameters
Name Description
atlasGlossaryCategory

updated glossary category

Responses


updateGlossaryTerm

Update the given glossary term


/v2/glossary/term/{termGuid}

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/glossary/term/{termGuid}" \
 -d '{
  "abbreviation" : "...",
  "anchor" : {
    "displayText" : "...",
    "glossaryGuid" : "...",
    "relationGuid" : "..."
  },
  "antonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "assignedEntities" : [ {
    "displayText" : "...",
    "entityStatus" : "DELETED",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "ACTIVE",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  }, {
    "displayText" : "...",
    "entityStatus" : "ACTIVE",
    "qualifiedName" : "...",
    "relationshipAttributes" : {
      "attributes" : {
        "property1" : { },
        "property2" : { }
      },
      "typeName" : "..."
    },
    "relationshipGuid" : "...",
    "relationshipStatus" : "DELETED",
    "relationshipType" : "...",
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  } ],
  "categories" : [ {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  }, {
    "categoryGuid" : "...",
    "description" : "...",
    "displayText" : "...",
    "relationGuid" : "...",
    "status" : "OBSOLETE"
  } ],
  "classifies" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "examples" : [ "...", "..." ],
  "glossaryTermHeader" : {
    "qualifiedName" : "...",
    "termGuid" : "..."
  },
  "isA" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "preferredToTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacedBy" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "replacementTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "seeAlso" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "synonyms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DRAFT",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translatedTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "translationTerms" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "usage" : "...",
  "validValues" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "DEPRECATED",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OBSOLETE",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "validValuesFor" : [ {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "ACTIVE",
    "steward" : "...",
    "termGuid" : "..."
  }, {
    "description" : "...",
    "displayText" : "...",
    "expression" : "...",
    "qualifiedName" : "...",
    "relationGuid" : "...",
    "source" : "...",
    "status" : "OTHER",
    "steward" : "...",
    "termGuid" : "..."
  } ],
  "additionalAttributes" : {
    "property1" : { },
    "property2" : { }
  },
  "classifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "longDescription" : "...",
  "name" : "...",
  "qualifiedName" : "...",
  "shortDescription" : "...",
  "guid" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GlossaryRESTApi;

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

public class GlossaryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        AtlasGlossaryTerm atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

        try {
            apiInstance.updateGlossaryTerm(termGuid, atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossaryTerm");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String termGuid = new String(); // String | unique identifier for glossary term
final AtlasGlossaryTerm atlasGlossaryTerm = new AtlasGlossaryTerm(); // AtlasGlossaryTerm | 

try {
    final result = await api_instance.updateGlossaryTerm(termGuid, atlasGlossaryTerm);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateGlossaryTerm: $e\n');
}

import org.openapitools.client.api.GlossaryRESTApi;

public class GlossaryRESTApiExample {
    public static void main(String[] args) {
        GlossaryRESTApi apiInstance = new GlossaryRESTApi();
        String termGuid = termGuid_example; // String | unique identifier for glossary term
        AtlasGlossaryTerm atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

        try {
            apiInstance.updateGlossaryTerm(termGuid, atlasGlossaryTerm);
        } catch (ApiException e) {
            System.err.println("Exception when calling GlossaryRESTApi#updateGlossaryTerm");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
GlossaryRESTApi *apiInstance = [[GlossaryRESTApi alloc] init];
String *termGuid = termGuid_example; // unique identifier for glossary term (default to null)
AtlasGlossaryTerm *atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; //  (optional)

[apiInstance updateGlossaryTermWith:termGuid
    atlasGlossaryTerm:atlasGlossaryTerm
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.GlossaryRESTApi()
var termGuid = termGuid_example; // {String} unique identifier for glossary term
var opts = {
  'atlasGlossaryTerm': {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} // {AtlasGlossaryTerm} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new GlossaryRESTApi();
            var termGuid = termGuid_example;  // String | unique identifier for glossary term (default to null)
            var atlasGlossaryTerm = new AtlasGlossaryTerm(); // AtlasGlossaryTerm |  (optional) 

            try {
                apiInstance.updateGlossaryTerm(termGuid, atlasGlossaryTerm);
            } catch (Exception e) {
                Debug.Print("Exception when calling GlossaryRESTApi.updateGlossaryTerm: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\GlossaryRESTApi();
$termGuid = termGuid_example; // String | unique identifier for glossary term
$atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm | 

try {
    $api_instance->updateGlossaryTerm($termGuid, $atlasGlossaryTerm);
} catch (Exception $e) {
    echo 'Exception when calling GlossaryRESTApi->updateGlossaryTerm: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::GlossaryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::GlossaryRESTApi->new();
my $termGuid = termGuid_example; # String | unique identifier for glossary term
my $atlasGlossaryTerm = WWW::OPenAPIClient::Object::AtlasGlossaryTerm->new(); # AtlasGlossaryTerm | 

eval {
    $api_instance->updateGlossaryTerm(termGuid => $termGuid, atlasGlossaryTerm => $atlasGlossaryTerm);
};
if ($@) {
    warn "Exception when calling GlossaryRESTApi->updateGlossaryTerm: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.GlossaryRESTApi()
termGuid = termGuid_example # String | unique identifier for glossary term (default to null)
atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."} # AtlasGlossaryTerm |  (optional)

try:
    api_instance.update_glossary_term(termGuid, atlasGlossaryTerm=atlasGlossaryTerm)
except ApiException as e:
    print("Exception when calling GlossaryRESTApi->updateGlossaryTerm: %s\n" % e)
extern crate GlossaryRESTApi;

pub fn main() {
    let termGuid = termGuid_example; // String
    let atlasGlossaryTerm = {"abbreviation":"...","anchor":{"displayText":"...","glossaryGuid":"...","relationGuid":"..."},"antonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"assignedEntities":[{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},{"displayText":"...","entityStatus":"DELETED","qualifiedName":"...","relationshipAttributes":{"attributes":{"property1":{},"property2":{}},"typeName":"..."},"relationshipGuid":"...","relationshipStatus":"DELETED","relationshipType":"...","guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}}],"categories":[{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"ACTIVE"},{"categoryGuid":"...","description":"...","displayText":"...","relationGuid":"...","status":"OTHER"}],"classifies":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"examples":["...","..."],"glossaryTermHeader":{"qualifiedName":"...","termGuid":"..."},"isA":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"preferredToTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OBSOLETE","steward":"...","termGuid":"..."}],"replacedBy":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"replacementTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"seeAlso":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"synonyms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"OTHER","steward":"...","termGuid":"..."}],"translatedTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."}],"translationTerms":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DRAFT","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"usage":"...","validValues":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"ACTIVE","steward":"...","termGuid":"..."}],"validValuesFor":[{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."},{"description":"...","displayText":"...","expression":"...","qualifiedName":"...","relationGuid":"...","source":"...","status":"DEPRECATED","steward":"...","termGuid":"..."}],"additionalAttributes":{"property1":{},"property2":{}},"classifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"longDescription":"...","name":"...","qualifiedName":"...","shortDescription":"...","guid":"..."}; // AtlasGlossaryTerm

    let mut context = GlossaryRESTApi::Context::default();
    let result = client.updateGlossaryTerm(termGuid, atlasGlossaryTerm, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
termGuid*
String
unique identifier for glossary term
Required
Body parameters
Name Description
atlasGlossaryTerm

updated glossary term

Responses


IndexRecoveryREST

getIndexRecoveryData


/v2/indexrecovery

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/indexrecovery"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexRecoveryRESTApi;

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

public class IndexRecoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexRecoveryRESTApi apiInstance = new IndexRecoveryRESTApi();

        try {
            apiInstance.getIndexRecoveryData();
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexRecoveryRESTApi#getIndexRecoveryData");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getIndexRecoveryData();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getIndexRecoveryData: $e\n');
}

import org.openapitools.client.api.IndexRecoveryRESTApi;

public class IndexRecoveryRESTApiExample {
    public static void main(String[] args) {
        IndexRecoveryRESTApi apiInstance = new IndexRecoveryRESTApi();

        try {
            apiInstance.getIndexRecoveryData();
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexRecoveryRESTApi#getIndexRecoveryData");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IndexRecoveryRESTApi *apiInstance = [[IndexRecoveryRESTApi alloc] init];

[apiInstance getIndexRecoveryDataWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.IndexRecoveryRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getIndexRecoveryData(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new IndexRecoveryRESTApi();

            try {
                apiInstance.getIndexRecoveryData();
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexRecoveryRESTApi.getIndexRecoveryData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexRecoveryRESTApi();

try {
    $api_instance->getIndexRecoveryData();
} catch (Exception $e) {
    echo 'Exception when calling IndexRecoveryRESTApi->getIndexRecoveryData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IndexRecoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndexRecoveryRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.IndexRecoveryRESTApi()

try:
    api_instance.get_index_recovery_data()
except ApiException as e:
    print("Exception when calling IndexRecoveryRESTApi->getIndexRecoveryData: %s\n" % e)
extern crate IndexRecoveryRESTApi;

pub fn main() {

    let mut context = IndexRecoveryRESTApi::Context::default();
    let result = client.getIndexRecoveryData(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


startCustomIndexRecovery


/v2/indexrecovery/start

Usage and SDK Samples

curl -X POST \
 "http://localhost/api/atlas/v2/indexrecovery/start?startTime=startTime_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.IndexRecoveryRESTApi;

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

public class IndexRecoveryRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        IndexRecoveryRESTApi apiInstance = new IndexRecoveryRESTApi();
        String startTime = startTime_example; // String | 

        try {
            apiInstance.startCustomIndexRecovery(startTime);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexRecoveryRESTApi#startCustomIndexRecovery");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String startTime = new String(); // String | 

try {
    final result = await api_instance.startCustomIndexRecovery(startTime);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->startCustomIndexRecovery: $e\n');
}

import org.openapitools.client.api.IndexRecoveryRESTApi;

public class IndexRecoveryRESTApiExample {
    public static void main(String[] args) {
        IndexRecoveryRESTApi apiInstance = new IndexRecoveryRESTApi();
        String startTime = startTime_example; // String | 

        try {
            apiInstance.startCustomIndexRecovery(startTime);
        } catch (ApiException e) {
            System.err.println("Exception when calling IndexRecoveryRESTApi#startCustomIndexRecovery");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
IndexRecoveryRESTApi *apiInstance = [[IndexRecoveryRESTApi alloc] init];
String *startTime = startTime_example; //  (optional) (default to null)

[apiInstance startCustomIndexRecoveryWith:startTime
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.IndexRecoveryRESTApi()
var opts = {
  'startTime': startTime_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new IndexRecoveryRESTApi();
            var startTime = startTime_example;  // String |  (optional)  (default to null)

            try {
                apiInstance.startCustomIndexRecovery(startTime);
            } catch (Exception e) {
                Debug.Print("Exception when calling IndexRecoveryRESTApi.startCustomIndexRecovery: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\IndexRecoveryRESTApi();
$startTime = startTime_example; // String | 

try {
    $api_instance->startCustomIndexRecovery($startTime);
} catch (Exception $e) {
    echo 'Exception when calling IndexRecoveryRESTApi->startCustomIndexRecovery: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::IndexRecoveryRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::IndexRecoveryRESTApi->new();
my $startTime = startTime_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.IndexRecoveryRESTApi()
startTime = startTime_example # String |  (optional) (default to null)

try:
    api_instance.start_custom_index_recovery(startTime=startTime)
except ApiException as e:
    print("Exception when calling IndexRecoveryRESTApi->startCustomIndexRecovery: %s\n" % e)
extern crate IndexRecoveryRESTApi;

pub fn main() {
    let startTime = startTime_example; // String

    let mut context = IndexRecoveryRESTApi::Context::default();
    let result = client.startCustomIndexRecovery(startTime, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
startTime
String

Responses


LineageREST

getLineageByUniqueAttribute

Returns lineage info about entity. <p> In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format <p> attr:<attrName>=<attrValue> <p> NOTE: The attrName and attrValue should be unique across entities, eg. qualifiedName


/v2/lineage/uniqueAttribute/type/{typeName}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/lineage/uniqueAttribute/type/{typeName}?depth=56&direction=direction_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LineageRESTApi;

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

public class LineageRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LineageRESTApi apiInstance = new LineageRESTApi();
        String typeName = typeName_example; // String | - typeName of entity
        Integer depth = 56; // Integer | - number of hops for lineage
        String direction = direction_example; // String | - input, output or both

        try {
            apiInstance.getLineageByUniqueAttribute(typeName, depth, direction);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageByUniqueAttribute");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | - typeName of entity
final Integer depth = new Integer(); // Integer | - number of hops for lineage
final String direction = new String(); // String | - input, output or both

try {
    final result = await api_instance.getLineageByUniqueAttribute(typeName, depth, direction);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getLineageByUniqueAttribute: $e\n');
}

import org.openapitools.client.api.LineageRESTApi;

public class LineageRESTApiExample {
    public static void main(String[] args) {
        LineageRESTApi apiInstance = new LineageRESTApi();
        String typeName = typeName_example; // String | - typeName of entity
        Integer depth = 56; // Integer | - number of hops for lineage
        String direction = direction_example; // String | - input, output or both

        try {
            apiInstance.getLineageByUniqueAttribute(typeName, depth, direction);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageByUniqueAttribute");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LineageRESTApi *apiInstance = [[LineageRESTApi alloc] init];
String *typeName = typeName_example; // - typeName of entity (default to null)
Integer *depth = 56; // - number of hops for lineage (optional) (default to null)
String *direction = direction_example; // - input, output or both (optional) (default to BOTH)

[apiInstance getLineageByUniqueAttributeWith:typeName
    depth:depth
    direction:direction
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.LineageRESTApi()
var typeName = typeName_example; // {String} - typeName of entity
var opts = {
  'depth': 56, // {Integer} - number of hops for lineage
  'direction': direction_example // {String} - input, output or both
};

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

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

            // Create an instance of the API class
            var apiInstance = new LineageRESTApi();
            var typeName = typeName_example;  // String | - typeName of entity (default to null)
            var depth = 56;  // Integer | - number of hops for lineage (optional)  (default to null)
            var direction = direction_example;  // String | - input, output or both (optional)  (default to BOTH)

            try {
                apiInstance.getLineageByUniqueAttribute(typeName, depth, direction);
            } catch (Exception e) {
                Debug.Print("Exception when calling LineageRESTApi.getLineageByUniqueAttribute: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LineageRESTApi();
$typeName = typeName_example; // String | - typeName of entity
$depth = 56; // Integer | - number of hops for lineage
$direction = direction_example; // String | - input, output or both

try {
    $api_instance->getLineageByUniqueAttribute($typeName, $depth, $direction);
} catch (Exception $e) {
    echo 'Exception when calling LineageRESTApi->getLineageByUniqueAttribute: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LineageRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LineageRESTApi->new();
my $typeName = typeName_example; # String | - typeName of entity
my $depth = 56; # Integer | - number of hops for lineage
my $direction = direction_example; # String | - input, output or both

eval {
    $api_instance->getLineageByUniqueAttribute(typeName => $typeName, depth => $depth, direction => $direction);
};
if ($@) {
    warn "Exception when calling LineageRESTApi->getLineageByUniqueAttribute: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LineageRESTApi()
typeName = typeName_example # String | - typeName of entity (default to null)
depth = 56 # Integer | - number of hops for lineage (optional) (default to null)
direction = direction_example # String | - input, output or both (optional) (default to BOTH)

try:
    api_instance.get_lineage_by_unique_attribute(typeName, depth=depth, direction=direction)
except ApiException as e:
    print("Exception when calling LineageRESTApi->getLineageByUniqueAttribute: %s\n" % e)
extern crate LineageRESTApi;

pub fn main() {
    let typeName = typeName_example; // String
    let depth = 56; // Integer
    let direction = direction_example; // String

    let mut context = LineageRESTApi::Context::default();
    let result = client.getLineageByUniqueAttribute(typeName, depth, direction, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
- typeName of entity
Required
Query parameters
Name Description
depth
Integer (int32)
- number of hops for lineage
direction
String
- input, output or both

Responses


getLineageGraph

Returns lineage info about entity.


/v2/lineage/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/lineage/{guid}?depth=56&direction=direction_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LineageRESTApi;

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

public class LineageRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LineageRESTApi apiInstance = new LineageRESTApi();
        String guid = guid_example; // String | - unique entity id
        Integer depth = 56; // Integer | - number of hops for lineage
        String direction = direction_example; // String | - input, output or both

        try {
            apiInstance.getLineageGraph(guid, depth, direction);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageGraph");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | - unique entity id
final Integer depth = new Integer(); // Integer | - number of hops for lineage
final String direction = new String(); // String | - input, output or both

try {
    final result = await api_instance.getLineageGraph(guid, depth, direction);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getLineageGraph: $e\n');
}

import org.openapitools.client.api.LineageRESTApi;

public class LineageRESTApiExample {
    public static void main(String[] args) {
        LineageRESTApi apiInstance = new LineageRESTApi();
        String guid = guid_example; // String | - unique entity id
        Integer depth = 56; // Integer | - number of hops for lineage
        String direction = direction_example; // String | - input, output or both

        try {
            apiInstance.getLineageGraph(guid, depth, direction);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageGraph");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LineageRESTApi *apiInstance = [[LineageRESTApi alloc] init];
String *guid = guid_example; // - unique entity id (default to null)
Integer *depth = 56; // - number of hops for lineage (optional) (default to null)
String *direction = direction_example; // - input, output or both (optional) (default to BOTH)

[apiInstance getLineageGraphWith:guid
    depth:depth
    direction:direction
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.LineageRESTApi()
var guid = guid_example; // {String} - unique entity id
var opts = {
  'depth': 56, // {Integer} - number of hops for lineage
  'direction': direction_example // {String} - input, output or both
};

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

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

            // Create an instance of the API class
            var apiInstance = new LineageRESTApi();
            var guid = guid_example;  // String | - unique entity id (default to null)
            var depth = 56;  // Integer | - number of hops for lineage (optional)  (default to null)
            var direction = direction_example;  // String | - input, output or both (optional)  (default to BOTH)

            try {
                apiInstance.getLineageGraph(guid, depth, direction);
            } catch (Exception e) {
                Debug.Print("Exception when calling LineageRESTApi.getLineageGraph: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LineageRESTApi();
$guid = guid_example; // String | - unique entity id
$depth = 56; // Integer | - number of hops for lineage
$direction = direction_example; // String | - input, output or both

try {
    $api_instance->getLineageGraph($guid, $depth, $direction);
} catch (Exception $e) {
    echo 'Exception when calling LineageRESTApi->getLineageGraph: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LineageRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LineageRESTApi->new();
my $guid = guid_example; # String | - unique entity id
my $depth = 56; # Integer | - number of hops for lineage
my $direction = direction_example; # String | - input, output or both

eval {
    $api_instance->getLineageGraph(guid => $guid, depth => $depth, direction => $direction);
};
if ($@) {
    warn "Exception when calling LineageRESTApi->getLineageGraph: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LineageRESTApi()
guid = guid_example # String | - unique entity id (default to null)
depth = 56 # Integer | - number of hops for lineage (optional) (default to null)
direction = direction_example # String | - input, output or both (optional) (default to BOTH)

try:
    api_instance.get_lineage_graph(guid, depth=depth, direction=direction)
except ApiException as e:
    print("Exception when calling LineageRESTApi->getLineageGraph: %s\n" % e)
extern crate LineageRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let depth = 56; // Integer
    let direction = direction_example; // String

    let mut context = LineageRESTApi::Context::default();
    let result = client.getLineageGraph(guid, depth, direction, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
- unique entity id
Required
Query parameters
Name Description
depth
Integer (int32)
- number of hops for lineage
direction
String
- input, output or both

Responses


getLineageGraph2

Returns lineage info about entity.


/v2/lineage/{guid}

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/lineage/{guid}" \
 -d '{
  "depth" : 12345,
  "direction" : "BOTH",
  "inputRelationsLimit" : 12345,
  "outputRelationsLimit" : 12345
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LineageRESTApi;

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

public class LineageRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        LineageRESTApi apiInstance = new LineageRESTApi();
        String guid = guid_example; // String | 
        map[String, LineageOnDemandConstraints] requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}}; // map[String, LineageOnDemandConstraints] | 

        try {
            apiInstance.getLineageGraph2(guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageGraph2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final map[String, LineageOnDemandConstraints] requestBody = new map[String, LineageOnDemandConstraints](); // map[String, LineageOnDemandConstraints] | 

try {
    final result = await api_instance.getLineageGraph2(guid, requestBody);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getLineageGraph2: $e\n');
}

import org.openapitools.client.api.LineageRESTApi;

public class LineageRESTApiExample {
    public static void main(String[] args) {
        LineageRESTApi apiInstance = new LineageRESTApi();
        String guid = guid_example; // String | 
        map[String, LineageOnDemandConstraints] requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}}; // map[String, LineageOnDemandConstraints] | 

        try {
            apiInstance.getLineageGraph2(guid, requestBody);
        } catch (ApiException e) {
            System.err.println("Exception when calling LineageRESTApi#getLineageGraph2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
LineageRESTApi *apiInstance = [[LineageRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
map[String, LineageOnDemandConstraints] *requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}}; //  (optional)

[apiInstance getLineageGraph2With:guid
    requestBody:requestBody
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.LineageRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'requestBody': {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}} // {map[String, LineageOnDemandConstraints]} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new LineageRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var requestBody = new map[String, LineageOnDemandConstraints](); // map[String, LineageOnDemandConstraints] |  (optional) 

            try {
                apiInstance.getLineageGraph2(guid, requestBody);
            } catch (Exception e) {
                Debug.Print("Exception when calling LineageRESTApi.getLineageGraph2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LineageRESTApi();
$guid = guid_example; // String | 
$requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}}; // map[String, LineageOnDemandConstraints] | 

try {
    $api_instance->getLineageGraph2($guid, $requestBody);
} catch (Exception $e) {
    echo 'Exception when calling LineageRESTApi->getLineageGraph2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LineageRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LineageRESTApi->new();
my $guid = guid_example; # String | 
my $requestBody = WWW::OPenAPIClient::Object::map[String, LineageOnDemandConstraints]->new(); # map[String, LineageOnDemandConstraints] | 

eval {
    $api_instance->getLineageGraph2(guid => $guid, requestBody => $requestBody);
};
if ($@) {
    warn "Exception when calling LineageRESTApi->getLineageGraph2: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.LineageRESTApi()
guid = guid_example # String |  (default to null)
requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}} # map[String, LineageOnDemandConstraints] |  (optional)

try:
    api_instance.get_lineage_graph2(guid, requestBody=requestBody)
except ApiException as e:
    print("Exception when calling LineageRESTApi->getLineageGraph2: %s\n" % e)
extern crate LineageRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let requestBody = {"...":{"depth":12345,"direction":"OUTPUT","inputRelationsLimit":12345,"outputRelationsLimit":12345}}; // map[String, LineageOnDemandConstraints]

    let mut context = LineageRESTApi::Context::default();
    let result = client.getLineageGraph2(guid, requestBody, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Body parameters
Name Description
requestBody

Responses


NotificationREST

handleNotifications

Publish notifications on Kafka topic


/v2/notification/topic/{topicName}

Usage and SDK Samples

curl -X POST \
 "http://localhost/api/atlas/v2/notification/topic/{topicName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NotificationRESTApi;

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

public class NotificationRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NotificationRESTApi apiInstance = new NotificationRESTApi();
        String topicName = topicName_example; // String | - nameOfTheQueue

        try {
            apiInstance.handleNotifications(topicName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationRESTApi#handleNotifications");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String topicName = new String(); // String | - nameOfTheQueue

try {
    final result = await api_instance.handleNotifications(topicName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->handleNotifications: $e\n');
}

import org.openapitools.client.api.NotificationRESTApi;

public class NotificationRESTApiExample {
    public static void main(String[] args) {
        NotificationRESTApi apiInstance = new NotificationRESTApi();
        String topicName = topicName_example; // String | - nameOfTheQueue

        try {
            apiInstance.handleNotifications(topicName);
        } catch (ApiException e) {
            System.err.println("Exception when calling NotificationRESTApi#handleNotifications");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NotificationRESTApi *apiInstance = [[NotificationRESTApi alloc] init];
String *topicName = topicName_example; // - nameOfTheQueue (default to null)

[apiInstance handleNotificationsWith:topicName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.NotificationRESTApi()
var topicName = topicName_example; // {String} - nameOfTheQueue

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

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

            // Create an instance of the API class
            var apiInstance = new NotificationRESTApi();
            var topicName = topicName_example;  // String | - nameOfTheQueue (default to null)

            try {
                apiInstance.handleNotifications(topicName);
            } catch (Exception e) {
                Debug.Print("Exception when calling NotificationRESTApi.handleNotifications: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NotificationRESTApi();
$topicName = topicName_example; // String | - nameOfTheQueue

try {
    $api_instance->handleNotifications($topicName);
} catch (Exception $e) {
    echo 'Exception when calling NotificationRESTApi->handleNotifications: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NotificationRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NotificationRESTApi->new();
my $topicName = topicName_example; # String | - nameOfTheQueue

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

# Create an instance of the API class
api_instance = openapi_client.NotificationRESTApi()
topicName = topicName_example # String | - nameOfTheQueue (default to null)

try:
    api_instance.handle_notifications(topicName)
except ApiException as e:
    print("Exception when calling NotificationRESTApi->handleNotifications: %s\n" % e)
extern crate NotificationRESTApi;

pub fn main() {
    let topicName = topicName_example; // String

    let mut context = NotificationRESTApi::Context::default();
    let result = client.handleNotifications(topicName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
topicName*
String
- nameOfTheQueue
Required

Responses


RelationshipREST

create

Create a new relationship between entities.


/v2/relationship

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/relationship" \
 -d '{
  "blockedPropagatedClassifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "createTime" : 12345,
  "createdBy" : "...",
  "end1" : {
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "end2" : {
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "guid" : "...",
  "homeId" : "...",
  "label" : "...",
  "propagateTags" : "ONE_TO_TWO",
  "propagatedClassifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "provenanceType" : 12345,
  "status" : "DELETED",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RelationshipRESTApi;

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

public class RelationshipRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        AtlasRelationship atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

        try {
            AtlasRelationship result = apiInstance.create(atlasRelationship);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#create");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasRelationship atlasRelationship = new AtlasRelationship(); // AtlasRelationship | 

try {
    final result = await api_instance.create(atlasRelationship);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->create: $e\n');
}

import org.openapitools.client.api.RelationshipRESTApi;

public class RelationshipRESTApiExample {
    public static void main(String[] args) {
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        AtlasRelationship atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

        try {
            AtlasRelationship result = apiInstance.create(atlasRelationship);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#create");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RelationshipRESTApi *apiInstance = [[RelationshipRESTApi alloc] init];
AtlasRelationship *atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; //  (optional)

[apiInstance createWith:atlasRelationship
              completionHandler: ^(AtlasRelationship output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.RelationshipRESTApi()
var opts = {
  'atlasRelationship': {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."} // {AtlasRelationship} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RelationshipRESTApi();
            var atlasRelationship = new AtlasRelationship(); // AtlasRelationship |  (optional) 

            try {
                AtlasRelationship result = apiInstance.create(atlasRelationship);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RelationshipRESTApi.create: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RelationshipRESTApi();
$atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RelationshipRESTApi->new();
my $atlasRelationship = WWW::OPenAPIClient::Object::AtlasRelationship->new(); # AtlasRelationship | 

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

# Create an instance of the API class
api_instance = openapi_client.RelationshipRESTApi()
atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."} # AtlasRelationship |  (optional)

try:
    api_response = api_instance.create(atlasRelationship=atlasRelationship)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RelationshipRESTApi->create: %s\n" % e)
extern crate RelationshipRESTApi;

pub fn main() {
    let atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"NONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"DELETED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship

    let mut context = RelationshipRESTApi::Context::default();
    let result = client.create(atlasRelationship, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasRelationship

Responses


deleteById

Delete a relationship between entities using guid.


/v2/relationship/guid/{guid}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/relationship/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RelationshipRESTApi;

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

public class RelationshipRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        String guid = guid_example; // String | 

        try {
            apiInstance.deleteById(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#deleteById");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 

try {
    final result = await api_instance.deleteById(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteById: $e\n');
}

import org.openapitools.client.api.RelationshipRESTApi;

public class RelationshipRESTApiExample {
    public static void main(String[] args) {
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        String guid = guid_example; // String | 

        try {
            apiInstance.deleteById(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#deleteById");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RelationshipRESTApi *apiInstance = [[RelationshipRESTApi alloc] init];
String *guid = guid_example; //  (default to null)

[apiInstance deleteByIdWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.RelationshipRESTApi()
var guid = guid_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new RelationshipRESTApi();
            var guid = guid_example;  // String |  (default to null)

            try {
                apiInstance.deleteById(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling RelationshipRESTApi.deleteById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RelationshipRESTApi();
$guid = guid_example; // String | 

try {
    $api_instance->deleteById($guid);
} catch (Exception $e) {
    echo 'Exception when calling RelationshipRESTApi->deleteById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RelationshipRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RelationshipRESTApi->new();
my $guid = guid_example; # String | 

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

# Create an instance of the API class
api_instance = openapi_client.RelationshipRESTApi()
guid = guid_example # String |  (default to null)

try:
    api_instance.delete_by_id(guid)
except ApiException as e:
    print("Exception when calling RelationshipRESTApi->deleteById: %s\n" % e)
extern crate RelationshipRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = RelationshipRESTApi::Context::default();
    let result = client.deleteById(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required

Responses


getById2

Get relationship information between entities using guid.


/v2/relationship/guid/{guid}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/api/atlas/v2/relationship/guid/{guid}?extendedInfo=true"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RelationshipRESTApi;

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

public class RelationshipRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        String guid = guid_example; // String | 
        Boolean extendedInfo = true; // Boolean | 

        try {
            AtlasRelationshipWithExtInfo result = apiInstance.getById2(guid, extendedInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#getById2");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | 
final Boolean extendedInfo = new Boolean(); // Boolean | 

try {
    final result = await api_instance.getById2(guid, extendedInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getById2: $e\n');
}

import org.openapitools.client.api.RelationshipRESTApi;

public class RelationshipRESTApiExample {
    public static void main(String[] args) {
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        String guid = guid_example; // String | 
        Boolean extendedInfo = true; // Boolean | 

        try {
            AtlasRelationshipWithExtInfo result = apiInstance.getById2(guid, extendedInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#getById2");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RelationshipRESTApi *apiInstance = [[RelationshipRESTApi alloc] init];
String *guid = guid_example; //  (default to null)
Boolean *extendedInfo = true; //  (optional) (default to false)

[apiInstance getById2With:guid
    extendedInfo:extendedInfo
              completionHandler: ^(AtlasRelationshipWithExtInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.RelationshipRESTApi()
var guid = guid_example; // {String} 
var opts = {
  'extendedInfo': true // {Boolean} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RelationshipRESTApi();
            var guid = guid_example;  // String |  (default to null)
            var extendedInfo = true;  // Boolean |  (optional)  (default to false)

            try {
                AtlasRelationshipWithExtInfo result = apiInstance.getById2(guid, extendedInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RelationshipRESTApi.getById2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RelationshipRESTApi();
$guid = guid_example; // String | 
$extendedInfo = true; // Boolean | 

try {
    $result = $api_instance->getById2($guid, $extendedInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RelationshipRESTApi->getById2: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RelationshipRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RelationshipRESTApi->new();
my $guid = guid_example; # String | 
my $extendedInfo = true; # Boolean | 

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

# Create an instance of the API class
api_instance = openapi_client.RelationshipRESTApi()
guid = guid_example # String |  (default to null)
extendedInfo = true # Boolean |  (optional) (default to false)

try:
    api_response = api_instance.get_by_id2(guid, extendedInfo=extendedInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RelationshipRESTApi->getById2: %s\n" % e)
extern crate RelationshipRESTApi;

pub fn main() {
    let guid = guid_example; // String
    let extendedInfo = true; // Boolean

    let mut context = RelationshipRESTApi::Context::default();
    let result = client.getById2(guid, extendedInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
Required
Query parameters
Name Description
extendedInfo
Boolean

Responses


update

Update an existing relationship between entities.


/v2/relationship

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/relationship" \
 -d '{
  "blockedPropagatedClassifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "ACTIVE",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "createTime" : 12345,
  "createdBy" : "...",
  "end1" : {
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "end2" : {
    "guid" : "...",
    "typeName" : "...",
    "uniqueAttributes" : {
      "property1" : { },
      "property2" : { }
    }
  },
  "guid" : "...",
  "homeId" : "...",
  "label" : "...",
  "propagateTags" : "ONE_TO_TWO",
  "propagatedClassifications" : [ {
    "entityGuid" : "...",
    "entityStatus" : "DELETED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  }, {
    "entityGuid" : "...",
    "entityStatus" : "PURGED",
    "propagate" : true,
    "removePropagationsOnEntityDelete" : true,
    "validityPeriods" : [ {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    }, {
      "endTime" : "...",
      "startTime" : "...",
      "timeZone" : "..."
    } ],
    "attributes" : {
      "property1" : { },
      "property2" : { }
    },
    "typeName" : "..."
  } ],
  "provenanceType" : 12345,
  "status" : "DELETED",
  "updateTime" : 12345,
  "updatedBy" : "...",
  "version" : 12345,
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "typeName" : "..."
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RelationshipRESTApi;

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

public class RelationshipRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        AtlasRelationship atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

        try {
            AtlasRelationship result = apiInstance.update(atlasRelationship);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#update");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasRelationship atlasRelationship = new AtlasRelationship(); // AtlasRelationship | 

try {
    final result = await api_instance.update(atlasRelationship);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->update: $e\n');
}

import org.openapitools.client.api.RelationshipRESTApi;

public class RelationshipRESTApiExample {
    public static void main(String[] args) {
        RelationshipRESTApi apiInstance = new RelationshipRESTApi();
        AtlasRelationship atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

        try {
            AtlasRelationship result = apiInstance.update(atlasRelationship);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RelationshipRESTApi#update");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
RelationshipRESTApi *apiInstance = [[RelationshipRESTApi alloc] init];
AtlasRelationship *atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; //  (optional)

[apiInstance updateWith:atlasRelationship
              completionHandler: ^(AtlasRelationship output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.RelationshipRESTApi()
var opts = {
  'atlasRelationship': {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."} // {AtlasRelationship} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new RelationshipRESTApi();
            var atlasRelationship = new AtlasRelationship(); // AtlasRelationship |  (optional) 

            try {
                AtlasRelationship result = apiInstance.update(atlasRelationship);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RelationshipRESTApi.update: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RelationshipRESTApi();
$atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RelationshipRESTApi->new();
my $atlasRelationship = WWW::OPenAPIClient::Object::AtlasRelationship->new(); # AtlasRelationship | 

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

# Create an instance of the API class
api_instance = openapi_client.RelationshipRESTApi()
atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."} # AtlasRelationship |  (optional)

try:
    api_response = api_instance.update(atlasRelationship=atlasRelationship)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RelationshipRESTApi->update: %s\n" % e)
extern crate RelationshipRESTApi;

pub fn main() {
    let atlasRelationship = {"blockedPropagatedClassifications":[{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"PURGED","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"createTime":12345,"createdBy":"...","end1":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"end2":{"guid":"...","typeName":"...","uniqueAttributes":{"property1":{},"property2":{}}},"guid":"...","homeId":"...","label":"...","propagateTags":"TWO_TO_ONE","propagatedClassifications":[{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."},{"entityGuid":"...","entityStatus":"ACTIVE","propagate":true,"removePropagationsOnEntityDelete":true,"validityPeriods":[{"endTime":"...","startTime":"...","timeZone":"..."},{"endTime":"...","startTime":"...","timeZone":"..."}],"attributes":{"property1":{},"property2":{}},"typeName":"..."}],"provenanceType":12345,"status":"ACTIVE","updateTime":12345,"updatedBy":"...","version":12345,"attributes":{"property1":{},"property2":{}},"typeName":"..."}; // AtlasRelationship

    let mut context = RelationshipRESTApi::Context::default();
    let result = client.update(atlasRelationship, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasRelationship

Responses


TypesREST

createAtlasTypeDefs

Bulk create APIs for all atlas type definitions, only new definitions will be created. Any changes to the existing definitions will be discarded


/v2/types/typedefs

Usage and SDK Samples

curl -X POST \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/types/typedefs" \
 -d '{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.createAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#createAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasTypesDef atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef | 

try {
    final result = await api_instance.createAtlasTypeDefs(atlasTypesDef);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createAtlasTypeDefs: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.createAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#createAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
AtlasTypesDef *atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; //  (optional)

[apiInstance createAtlasTypeDefsWith:atlasTypesDef
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var opts = {
  'atlasTypesDef': {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} // {AtlasTypesDef} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef |  (optional) 

            try {
                apiInstance.createAtlasTypeDefs(atlasTypesDef);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.createAtlasTypeDefs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

try {
    $api_instance->createAtlasTypeDefs($atlasTypesDef);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->createAtlasTypeDefs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $atlasTypesDef = WWW::OPenAPIClient::Object::AtlasTypesDef->new(); # AtlasTypesDef | 

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} # AtlasTypesDef |  (optional)

try:
    api_instance.create_atlas_type_defs(atlasTypesDef=atlasTypesDef)
except ApiException as e:
    print("Exception when calling TypesRESTApi->createAtlasTypeDefs: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef

    let mut context = TypesRESTApi::Context::default();
    let result = client.createAtlasTypeDefs(atlasTypesDef, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasTypesDef

A composite wrapper object with corresponding lists of the type definition

Responses


deleteAtlasTypeByName

Delete API for type identified by its name.


/v2/types/typedef/name/{typeName}

Usage and SDK Samples

curl -X DELETE \
 "http://localhost/api/atlas/v2/types/typedef/name/{typeName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String typeName = typeName_example; // String | Name of the type to be deleted.

        try {
            apiInstance.deleteAtlasTypeByName(typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#deleteAtlasTypeByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String typeName = new String(); // String | Name of the type to be deleted.

try {
    final result = await api_instance.deleteAtlasTypeByName(typeName);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAtlasTypeByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String typeName = typeName_example; // String | Name of the type to be deleted.

        try {
            apiInstance.deleteAtlasTypeByName(typeName);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#deleteAtlasTypeByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *typeName = typeName_example; // Name of the type to be deleted. (default to null)

[apiInstance deleteAtlasTypeByNameWith:typeName
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var typeName = typeName_example; // {String} Name of the type to be deleted.

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var typeName = typeName_example;  // String | Name of the type to be deleted. (default to null)

            try {
                apiInstance.deleteAtlasTypeByName(typeName);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.deleteAtlasTypeByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$typeName = typeName_example; // String | Name of the type to be deleted.

try {
    $api_instance->deleteAtlasTypeByName($typeName);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->deleteAtlasTypeByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $typeName = typeName_example; # String | Name of the type to be deleted.

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
typeName = typeName_example # String | Name of the type to be deleted. (default to null)

try:
    api_instance.delete_atlas_type_by_name(typeName)
except ApiException as e:
    print("Exception when calling TypesRESTApi->deleteAtlasTypeByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let typeName = typeName_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.deleteAtlasTypeByName(typeName, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
typeName*
String
Name of the type to be deleted.
Required

Responses


deleteAtlasTypeDefs

Bulk delete API for all types


/v2/types/typedefs

Usage and SDK Samples

curl -X DELETE \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/types/typedefs" \
 -d '{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.deleteAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#deleteAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasTypesDef atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef | 

try {
    final result = await api_instance.deleteAtlasTypeDefs(atlasTypesDef);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteAtlasTypeDefs: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.deleteAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#deleteAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
AtlasTypesDef *atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; //  (optional)

[apiInstance deleteAtlasTypeDefsWith:atlasTypesDef
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var opts = {
  'atlasTypesDef': {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} // {AtlasTypesDef} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef |  (optional) 

            try {
                apiInstance.deleteAtlasTypeDefs(atlasTypesDef);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.deleteAtlasTypeDefs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

try {
    $api_instance->deleteAtlasTypeDefs($atlasTypesDef);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->deleteAtlasTypeDefs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $atlasTypesDef = WWW::OPenAPIClient::Object::AtlasTypesDef->new(); # AtlasTypesDef | 

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} # AtlasTypesDef |  (optional)

try:
    api_instance.delete_atlas_type_defs(atlasTypesDef=atlasTypesDef)
except ApiException as e:
    print("Exception when calling TypesRESTApi->deleteAtlasTypeDefs: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"MAP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ARRAY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"NONE","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"COMPOSITION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"STRUCT","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"RELATIONSHIP","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef

    let mut context = TypesRESTApi::Context::default();
    let result = client.deleteAtlasTypeDefs(atlasTypesDef, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasTypesDef

A composite object that captures all types to be deleted

Responses


getAllTypeDefs

Bulk retrieval API for retrieving all type definitions in Atlas


/v2/types/typedefs

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/typedefs"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();

        try {
            apiInstance.getAllTypeDefs();
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getAllTypeDefs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getAllTypeDefs();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllTypeDefs: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();

        try {
            apiInstance.getAllTypeDefs();
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getAllTypeDefs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];

[apiInstance getAllTypeDefsWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getAllTypeDefs(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();

            try {
                apiInstance.getAllTypeDefs();
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getAllTypeDefs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();

try {
    $api_instance->getAllTypeDefs();
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getAllTypeDefs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()

try:
    api_instance.get_all_type_defs()
except ApiException as e:
    print("Exception when calling TypesRESTApi->getAllTypeDefs: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {

    let mut context = TypesRESTApi::Context::default();
    let result = client.getAllTypeDefs(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


getBusinessMetadataDefByGuid

Get the businessMetadata definition for the given guid


/v2/types/businessmetadatadef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/businessmetadatadef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | businessMetadata guid

        try {
            apiInstance.getBusinessMetadataDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getBusinessMetadataDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | businessMetadata guid

try {
    final result = await api_instance.getBusinessMetadataDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessMetadataDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | businessMetadata guid

        try {
            apiInstance.getBusinessMetadataDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getBusinessMetadataDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // businessMetadata guid (default to null)

[apiInstance getBusinessMetadataDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} businessMetadata guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | businessMetadata guid (default to null)

            try {
                apiInstance.getBusinessMetadataDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getBusinessMetadataDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | businessMetadata guid

try {
    $api_instance->getBusinessMetadataDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getBusinessMetadataDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | businessMetadata guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | businessMetadata guid (default to null)

try:
    api_instance.get_business_metadata_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getBusinessMetadataDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getBusinessMetadataDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
businessMetadata guid
Required

Responses


getBusinessMetadataDefByName

Get the businessMetadata definition by it's name (unique)


/v2/types/businessmetadatadef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/businessmetadatadef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | businessMetadata name

        try {
            apiInstance.getBusinessMetadataDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getBusinessMetadataDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | businessMetadata name

try {
    final result = await api_instance.getBusinessMetadataDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getBusinessMetadataDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | businessMetadata name

        try {
            apiInstance.getBusinessMetadataDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getBusinessMetadataDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // businessMetadata name (default to null)

[apiInstance getBusinessMetadataDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} businessMetadata name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | businessMetadata name (default to null)

            try {
                apiInstance.getBusinessMetadataDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getBusinessMetadataDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | businessMetadata name

try {
    $api_instance->getBusinessMetadataDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getBusinessMetadataDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | businessMetadata name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | businessMetadata name (default to null)

try:
    api_instance.get_business_metadata_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getBusinessMetadataDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getBusinessMetadataDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
businessMetadata name
Required

Responses


getClassificationDefByGuid

Get the classification definition for the given guid


/v2/types/classificationdef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/classificationdef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | classification guid

        try {
            apiInstance.getClassificationDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getClassificationDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | classification guid

try {
    final result = await api_instance.getClassificationDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getClassificationDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | classification guid

        try {
            apiInstance.getClassificationDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getClassificationDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // classification guid (default to null)

[apiInstance getClassificationDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} classification guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | classification guid (default to null)

            try {
                apiInstance.getClassificationDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getClassificationDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | classification guid

try {
    $api_instance->getClassificationDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getClassificationDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | classification guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | classification guid (default to null)

try:
    api_instance.get_classification_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getClassificationDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getClassificationDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
classification guid
Required

Responses


getClassificationDefByName

Get the classification definition by it's name (unique)


/v2/types/classificationdef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/classificationdef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | classification name

        try {
            apiInstance.getClassificationDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getClassificationDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | classification name

try {
    final result = await api_instance.getClassificationDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getClassificationDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | classification name

        try {
            apiInstance.getClassificationDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getClassificationDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // classification name (default to null)

[apiInstance getClassificationDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} classification name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | classification name (default to null)

            try {
                apiInstance.getClassificationDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getClassificationDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | classification name

try {
    $api_instance->getClassificationDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getClassificationDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | classification name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | classification name (default to null)

try:
    api_instance.get_classification_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getClassificationDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getClassificationDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
classification name
Required

Responses


getEntityDefByGuid

Get the Entity definition for the given guid


/v2/types/entitydef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/entitydef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | entity guid

        try {
            apiInstance.getEntityDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEntityDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | entity guid

try {
    final result = await api_instance.getEntityDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntityDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | entity guid

        try {
            apiInstance.getEntityDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEntityDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // entity guid (default to null)

[apiInstance getEntityDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} entity guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | entity guid (default to null)

            try {
                apiInstance.getEntityDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getEntityDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | entity guid

try {
    $api_instance->getEntityDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getEntityDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | entity guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | entity guid (default to null)

try:
    api_instance.get_entity_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getEntityDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getEntityDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
entity guid
Required

Responses


getEntityDefByName

Get the entity definition by it's name (unique)


/v2/types/entitydef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/entitydef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | entity name

        try {
            apiInstance.getEntityDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEntityDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | entity name

try {
    final result = await api_instance.getEntityDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEntityDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | entity name

        try {
            apiInstance.getEntityDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEntityDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // entity name (default to null)

[apiInstance getEntityDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} entity name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | entity name (default to null)

            try {
                apiInstance.getEntityDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getEntityDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | entity name

try {
    $api_instance->getEntityDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getEntityDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | entity name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | entity name (default to null)

try:
    api_instance.get_entity_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getEntityDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getEntityDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
entity name
Required

Responses


getEnumDefByGuid

Get the enum definition for the given guid


/v2/types/enumdef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/enumdef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | enum guid

        try {
            apiInstance.getEnumDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEnumDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | enum guid

try {
    final result = await api_instance.getEnumDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEnumDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | enum guid

        try {
            apiInstance.getEnumDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEnumDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // enum guid (default to null)

[apiInstance getEnumDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} enum guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | enum guid (default to null)

            try {
                apiInstance.getEnumDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getEnumDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | enum guid

try {
    $api_instance->getEnumDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getEnumDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | enum guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | enum guid (default to null)

try:
    api_instance.get_enum_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getEnumDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getEnumDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
enum guid
Required

Responses


getEnumDefByName

Get the enum definition by it's name (unique)


/v2/types/enumdef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/enumdef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | enum name

        try {
            apiInstance.getEnumDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEnumDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | enum name

try {
    final result = await api_instance.getEnumDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getEnumDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | enum name

        try {
            apiInstance.getEnumDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getEnumDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // enum name (default to null)

[apiInstance getEnumDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} enum name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | enum name (default to null)

            try {
                apiInstance.getEnumDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getEnumDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | enum name

try {
    $api_instance->getEnumDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getEnumDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | enum name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | enum name (default to null)

try:
    api_instance.get_enum_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getEnumDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getEnumDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
enum name
Required

Responses


getRelationshipDefByGuid

Get the relationship definition for the given guid


/v2/types/relationshipdef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/relationshipdef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | relationship guid

        try {
            apiInstance.getRelationshipDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getRelationshipDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | relationship guid

try {
    final result = await api_instance.getRelationshipDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRelationshipDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | relationship guid

        try {
            apiInstance.getRelationshipDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getRelationshipDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // relationship guid (default to null)

[apiInstance getRelationshipDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} relationship guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | relationship guid (default to null)

            try {
                apiInstance.getRelationshipDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getRelationshipDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | relationship guid

try {
    $api_instance->getRelationshipDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getRelationshipDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | relationship guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | relationship guid (default to null)

try:
    api_instance.get_relationship_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getRelationshipDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getRelationshipDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
relationship guid
Required

Responses


getRelationshipDefByName

Get the relationship definition by it's name (unique)


/v2/types/relationshipdef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/relationshipdef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | relationship name

        try {
            apiInstance.getRelationshipDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getRelationshipDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | relationship name

try {
    final result = await api_instance.getRelationshipDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRelationshipDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | relationship name

        try {
            apiInstance.getRelationshipDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getRelationshipDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // relationship name (default to null)

[apiInstance getRelationshipDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} relationship name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | relationship name (default to null)

            try {
                apiInstance.getRelationshipDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getRelationshipDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | relationship name

try {
    $api_instance->getRelationshipDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getRelationshipDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | relationship name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | relationship name (default to null)

try:
    api_instance.get_relationship_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getRelationshipDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getRelationshipDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
relationship name
Required

Responses


getStructDefByGuid

Get the struct definition for the given guid


/v2/types/structdef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/structdef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | struct guid

        try {
            apiInstance.getStructDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getStructDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | struct guid

try {
    final result = await api_instance.getStructDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStructDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | struct guid

        try {
            apiInstance.getStructDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getStructDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // struct guid (default to null)

[apiInstance getStructDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} struct guid

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | struct guid (default to null)

            try {
                apiInstance.getStructDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getStructDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | struct guid

try {
    $api_instance->getStructDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getStructDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | struct guid

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | struct guid (default to null)

try:
    api_instance.get_struct_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getStructDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getStructDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
struct guid
Required

Responses


getStructDefByName

Get the struct definition by it's name (unique)


/v2/types/structdef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/structdef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | struct name

        try {
            apiInstance.getStructDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getStructDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | struct name

try {
    final result = await api_instance.getStructDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStructDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | struct name

        try {
            apiInstance.getStructDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getStructDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // struct name (default to null)

[apiInstance getStructDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} struct name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | struct name (default to null)

            try {
                apiInstance.getStructDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getStructDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | struct name

try {
    $api_instance->getStructDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getStructDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | struct name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | struct name (default to null)

try:
    api_instance.get_struct_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getStructDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getStructDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
struct name
Required

Responses


getTypeDefByGuid


/v2/types/typedef/guid/{guid}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/typedef/guid/{guid}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | GUID of the type

        try {
            apiInstance.getTypeDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefByGuid");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String guid = new String(); // String | GUID of the type

try {
    final result = await api_instance.getTypeDefByGuid(guid);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTypeDefByGuid: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String guid = guid_example; // String | GUID of the type

        try {
            apiInstance.getTypeDefByGuid(guid);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefByGuid");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *guid = guid_example; // GUID of the type (default to null)

[apiInstance getTypeDefByGuidWith:guid
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var guid = guid_example; // {String} GUID of the type

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var guid = guid_example;  // String | GUID of the type (default to null)

            try {
                apiInstance.getTypeDefByGuid(guid);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getTypeDefByGuid: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$guid = guid_example; // String | GUID of the type

try {
    $api_instance->getTypeDefByGuid($guid);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getTypeDefByGuid: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $guid = guid_example; # String | GUID of the type

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
guid = guid_example # String | GUID of the type (default to null)

try:
    api_instance.get_type_def_by_guid(guid)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getTypeDefByGuid: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let guid = guid_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getTypeDefByGuid(guid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
guid*
String
GUID of the type
Required

Responses


getTypeDefByName

Get type definition by it's name


/v2/types/typedef/name/{name}

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/typedef/name/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | Type name

        try {
            apiInstance.getTypeDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefByName");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String name = new String(); // String | Type name

try {
    final result = await api_instance.getTypeDefByName(name);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTypeDefByName: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        String name = name_example; // String | Type name

        try {
            apiInstance.getTypeDefByName(name);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefByName");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
String *name = name_example; // Type name (default to null)

[apiInstance getTypeDefByNameWith:name
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var name = name_example; // {String} Type name

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var name = name_example;  // String | Type name (default to null)

            try {
                apiInstance.getTypeDefByName(name);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getTypeDefByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$name = name_example; // String | Type name

try {
    $api_instance->getTypeDefByName($name);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getTypeDefByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $name = name_example; # String | Type name

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
name = name_example # String | Type name (default to null)

try:
    api_instance.get_type_def_by_name(name)
except ApiException as e:
    print("Exception when calling TypesRESTApi->getTypeDefByName: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let name = name_example; // String

    let mut context = TypesRESTApi::Context::default();
    let result = client.getTypeDefByName(name, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
name*
String
Type name
Required

Responses


getTypeDefHeaders

Bulk retrieval API for all type definitions returned as a list of minimal information header


/v2/types/typedefs/headers

Usage and SDK Samples

curl -X GET \
 "http://localhost/api/atlas/v2/types/typedefs/headers"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();

        try {
            apiInstance.getTypeDefHeaders();
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefHeaders");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getTypeDefHeaders();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getTypeDefHeaders: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();

        try {
            apiInstance.getTypeDefHeaders();
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#getTypeDefHeaders");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];

[apiInstance getTypeDefHeadersWithCompletionHandler: 
              ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.getTypeDefHeaders(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();

            try {
                apiInstance.getTypeDefHeaders();
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.getTypeDefHeaders: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();

try {
    $api_instance->getTypeDefHeaders();
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->getTypeDefHeaders: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()

try:
    api_instance.get_type_def_headers()
except ApiException as e:
    print("Exception when calling TypesRESTApi->getTypeDefHeaders: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {

    let mut context = TypesRESTApi::Context::default();
    let result = client.getTypeDefHeaders(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


updateAtlasTypeDefs

Bulk update API for all types, changes detected in the type definitions would be persisted


/v2/types/typedefs

Usage and SDK Samples

curl -X PUT \
 -H "Content-Type: application/json" \
 "http://localhost/api/atlas/v2/types/typedefs" \
 -d '{
  "businessMetadataDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "classificationDefs" : [ {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "entityTypes" : [ "...", "..." ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "entityDefs" : [ {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "businessAttributeDefs" : {
      "property1" : [ {
        "cardinality" : "LIST",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "DEFAULT",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ],
      "property2" : [ {
        "cardinality" : "SINGLE",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      }, {
        "cardinality" : "SET",
        "constraints" : [ { }, { } ],
        "defaultValue" : "...",
        "description" : "...",
        "displayName" : "...",
        "includeInNotification" : true,
        "indexType" : "STRING",
        "isIndexable" : true,
        "isOptional" : true,
        "isUnique" : true,
        "name" : "...",
        "options" : {
          "property1" : "...",
          "property2" : "..."
        },
        "searchWeight" : 12345,
        "typeName" : "...",
        "valuesMaxCount" : 12345,
        "valuesMinCount" : 12345
      } ]
    },
    "relationshipAttributeDefs" : [ {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "isLegacyAttribute" : true,
      "relationshipTypeName" : "...",
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "subTypes" : [ "...", "..." ],
    "superTypes" : [ "...", "..." ],
    "attributeDefs" : [ {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "MAP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "enumDefs" : [ {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "defaultValue" : "...",
    "elementDefs" : [ {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    }, {
      "description" : "...",
      "ordinal" : 12345,
      "value" : "..."
    } ],
    "category" : "STRUCT",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "relationshipDefs" : [ {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "LIST",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "ASSOCIATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "ENTITY",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "endDef1" : {
      "cardinality" : "SINGLE",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "endDef2" : {
      "cardinality" : "SET",
      "description" : "...",
      "isContainer" : true,
      "isLegacyAttribute" : true,
      "name" : "...",
      "type" : "..."
    },
    "propagateTags" : "TWO_TO_ONE",
    "relationshipCategory" : "AGGREGATION",
    "relationshipLabel" : "...",
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "RELATIONSHIP",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ],
  "structDefs" : [ {
    "attributeDefs" : [ {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "STRING",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "SET",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "BUSINESS_METADATA",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  }, {
    "attributeDefs" : [ {
      "cardinality" : "SINGLE",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    }, {
      "cardinality" : "LIST",
      "constraints" : [ { }, { } ],
      "defaultValue" : "...",
      "description" : "...",
      "displayName" : "...",
      "includeInNotification" : true,
      "indexType" : "DEFAULT",
      "isIndexable" : true,
      "isOptional" : true,
      "isUnique" : true,
      "name" : "...",
      "options" : {
        "property1" : "...",
        "property2" : "..."
      },
      "searchWeight" : 12345,
      "typeName" : "...",
      "valuesMaxCount" : 12345,
      "valuesMinCount" : 12345
    } ],
    "category" : "PRIMITIVE",
    "createTime" : 12345,
    "createdBy" : "...",
    "dateFormatter" : {
      "availableLocales" : [ "...", "..." ],
      "calendar" : 12345,
      "dateInstance" : { },
      "dateTimeInstance" : { },
      "instance" : { },
      "lenient" : true,
      "numberFormat" : { },
      "timeInstance" : { },
      "timeZone" : { }
    },
    "description" : "...",
    "guid" : "...",
    "name" : "...",
    "options" : {
      "property1" : "...",
      "property2" : "..."
    },
    "serviceType" : "...",
    "typeVersion" : "...",
    "updateTime" : 12345,
    "updatedBy" : "...",
    "version" : 12345
  } ]
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.TypesRESTApi;

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

public class TypesRESTApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.updateAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#updateAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final AtlasTypesDef atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef | 

try {
    final result = await api_instance.updateAtlasTypeDefs(atlasTypesDef);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updateAtlasTypeDefs: $e\n');
}

import org.openapitools.client.api.TypesRESTApi;

public class TypesRESTApiExample {
    public static void main(String[] args) {
        TypesRESTApi apiInstance = new TypesRESTApi();
        AtlasTypesDef atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

        try {
            apiInstance.updateAtlasTypeDefs(atlasTypesDef);
        } catch (ApiException e) {
            System.err.println("Exception when calling TypesRESTApi#updateAtlasTypeDefs");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
TypesRESTApi *apiInstance = [[TypesRESTApi alloc] init];
AtlasTypesDef *atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; //  (optional)

[apiInstance updateAtlasTypeDefsWith:atlasTypesDef
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var AtlasRestApi = require('atlas_rest_api');

// Create an instance of the API class
var api = new AtlasRestApi.TypesRESTApi()
var opts = {
  'atlasTypesDef': {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} // {AtlasTypesDef} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new TypesRESTApi();
            var atlasTypesDef = new AtlasTypesDef(); // AtlasTypesDef |  (optional) 

            try {
                apiInstance.updateAtlasTypeDefs(atlasTypesDef);
            } catch (Exception e) {
                Debug.Print("Exception when calling TypesRESTApi.updateAtlasTypeDefs: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\TypesRESTApi();
$atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef | 

try {
    $api_instance->updateAtlasTypeDefs($atlasTypesDef);
} catch (Exception $e) {
    echo 'Exception when calling TypesRESTApi->updateAtlasTypeDefs: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::TypesRESTApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::TypesRESTApi->new();
my $atlasTypesDef = WWW::OPenAPIClient::Object::AtlasTypesDef->new(); # AtlasTypesDef | 

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

# Create an instance of the API class
api_instance = openapi_client.TypesRESTApi()
atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]} # AtlasTypesDef |  (optional)

try:
    api_instance.update_atlas_type_defs(atlasTypesDef=atlasTypesDef)
except ApiException as e:
    print("Exception when calling TypesRESTApi->updateAtlasTypeDefs: %s\n" % e)
extern crate TypesRESTApi;

pub fn main() {
    let atlasTypesDef = {"businessMetadataDefs":[{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"classificationDefs":[{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"entityTypes":["...","..."],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"entityDefs":[{"businessAttributeDefs":{"property1":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENTITY","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"businessAttributeDefs":{"property1":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"property2":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}]},"relationshipAttributeDefs":[{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"isLegacyAttribute":true,"relationshipTypeName":"...","cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"subTypes":["...","..."],"superTypes":["...","..."],"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"enumDefs":[{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"defaultValue":"...","elementDefs":[{"description":"...","ordinal":12345,"value":"..."},{"description":"...","ordinal":12345,"value":"..."}],"category":"BUSINESS_METADATA","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"relationshipDefs":[{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"LIST","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"TWO_TO_ONE","relationshipCategory":"ASSOCIATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"SINGLE","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"ENUM","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"endDef1":{"cardinality":"SET","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"endDef2":{"cardinality":"SINGLE","description":"...","isContainer":true,"isLegacyAttribute":true,"name":"...","type":"..."},"propagateTags":"BOTH","relationshipCategory":"AGGREGATION","relationshipLabel":"...","attributeDefs":[{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"CLASSIFICATION","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}],"structDefs":[{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"LIST","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"OBJECT_ID_TYPE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345},{"attributeDefs":[{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"STRING","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345},{"cardinality":"SET","constraints":[{},{}],"defaultValue":"...","description":"...","displayName":"...","includeInNotification":true,"indexType":"DEFAULT","isIndexable":true,"isOptional":true,"isUnique":true,"name":"...","options":{"property1":"...","property2":"..."},"searchWeight":12345,"typeName":"...","valuesMaxCount":12345,"valuesMinCount":12345}],"category":"PRIMITIVE","createTime":12345,"createdBy":"...","dateFormatter":{"availableLocales":["...","..."],"calendar":12345,"dateInstance":{},"dateTimeInstance":{},"instance":{},"lenient":true,"numberFormat":{},"timeInstance":{},"timeZone":{}},"description":"...","guid":"...","name":"...","options":{"property1":"...","property2":"..."},"serviceType":"...","typeVersion":"...","updateTime":12345,"updatedBy":"...","version":12345}]}; // AtlasTypesDef

    let mut context = TypesRESTApi::Context::default();
    let result = client.updateAtlasTypeDefs(atlasTypesDef, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
atlasTypesDef

A composite object that captures all type definition changes

Responses