MDM REST Services

Login

getUserProfile

Get Login Info

Use to get the details whether the user is currently logged in or not to the enterprise.


/login/userinfo/{enterprise}

Usage and SDK Samples


curl -X get "http://hostname:8080/eml/rest/login/userinfo/{enterprise}"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        String enterprise = enterprise_example; // String | Enterprise Name
        String apiVersion = apiVersion_example; // String | 
        try {
            LoginResponse result = apiInstance.getUserProfile(enterprise, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#getUserProfile");
            e.printStackTrace();
        }
    }
}

                                                  

import .LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        String enterprise = enterprise_example; // String | Enterprise Name
        String apiVersion = apiVersion_example; // String | 
        try {
            LoginResponse result = apiInstance.getUserProfile(enterprise, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#getUserProfile");
            e.printStackTrace();
        }
    }
}

                                                  


String *enterprise = enterprise_example; // Enterprise Name
String *apiVersion = apiVersion_example; //  (optional)

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

// Get Login Info
[apiInstance getUserProfileWith:enterprise
    apiVersion:apiVersion
              completionHandler: ^(LoginResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LoginApi()

var enterprise = enterprise_example; // {String} Enterprise Name

var opts = { 
  'apiVersion': apiVersion_example // {String} 
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getUserProfileExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();
            var enterprise = enterprise_example;  // String | Enterprise Name
            var apiVersion = apiVersion_example;  // String |  (optional) 

            try
            {
                // Get Login Info
                LoginResponse result = apiInstance.getUserProfile(enterprise, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginApi.getUserProfile: " + e.Message );
            }
        }
    }
}

                                                    

getUserProfile($enterprise, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoginApi->getUserProfile: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
enterprise*
Header parameters
Name Description
apiVersion

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - User not found

Status: 500 - Internal error occurred


login

Login

Use to Login MDM


/login/userinfo

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/login/userinfo"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        UserInfo body = ; // UserInfo | User Details JSON
        try {
            LoginResponse result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}

                                                  

import .LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        UserInfo body = ; // UserInfo | User Details JSON
        try {
            LoginResponse result = apiInstance.login(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#login");
            e.printStackTrace();
        }
    }
}

                                                  


UserInfo *body = ; // User Details JSON

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

// Login
[apiInstance loginWith:body
              completionHandler: ^(LoginResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LoginApi()

var body = ; // {UserInfo} User Details JSON


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class loginExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();
            var body = new UserInfo(); // UserInfo | User Details JSON

            try
            {
                // Login
                LoginResponse result = apiInstance.login(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginApi.login: " + e.Message );
            }
        }
    }
}

                                                    

login($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoginApi->login: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - User not found

Status: 500 - Internal error occurred


logout

Logout

Use to logout from MDM


/login/userinfo/logout

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/login/userinfo/logout"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        String cookie = cookie_example; // String | Session cookie
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            LogoutResponse result = apiInstance.logoutUser(cookie, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#logoutUser");
            e.printStackTrace();
        }
    }
}

                                                  

import .LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        String cookie = cookie_example; // String | Session cookie
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            LogoutResponse result = apiInstance.logoutUser(cookie, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#logoutUser");
            e.printStackTrace();
        }
    }
}

                                                  


String *cookie = cookie_example; // Session cookie (optional)
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest) (optional)

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

// Logout
[apiInstance logoutUserWith:cookie
    apiVersion:apiVersion
              completionHandler: ^(LogoutResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LoginApi()

var opts = { 
  'cookie': cookie_example, // {String} Session cookie
  'apiVersion': apiVersion_example // {String} 1.0(Default) OR 2.0(Latest)
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class logoutUserExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();
            var cookie = cookie_example;  // String | Session cookie (optional) 
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest) (optional) 

            try
            {
                // Logout
                LogoutResponse result = apiInstance.logoutUser(cookie, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginApi.logoutUser: " + e.Message );
            }
        }
    }
}

                                                    

logoutUser($cookie, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoginApi->logoutUser: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
cookie
apiVersion

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - User not found

Status: 500 - Internal error occurred


refreshSession

Refresh Session

Use to refresh the session


/login/userinfo/sessionrefresh

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/login/userinfo/sessionrefresh"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .LoginApi;

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

public class LoginApiExample {

    public static void main(String[] args) {
        
        LoginApi apiInstance = new LoginApi();
        String cookie = cookie_example; // String | Session cookie
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            LoginResponse result = apiInstance.refreshSession(cookie, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#refreshSession");
            e.printStackTrace();
        }
    }
}

                                                  

import .LoginApi;

public class LoginApiExample {

    public static void main(String[] args) {
        LoginApi apiInstance = new LoginApi();
        String cookie = cookie_example; // String | Session cookie
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            LoginResponse result = apiInstance.refreshSession(cookie, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoginApi#refreshSession");
            e.printStackTrace();
        }
    }
}

                                                  


String *cookie = cookie_example; // Session cookie (optional)
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest) (optional)

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

// Refresh Session
[apiInstance refreshSessionWith:cookie
    apiVersion:apiVersion
              completionHandler: ^(LoginResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .LoginApi()

var opts = { 
  'cookie': cookie_example, // {String} Session cookie
  'apiVersion': apiVersion_example // {String} 1.0(Default) OR 2.0(Latest)
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class refreshSessionExample
    {
        public void main()
        {
            
            var apiInstance = new LoginApi();
            var cookie = cookie_example;  // String | Session cookie (optional) 
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest) (optional) 

            try
            {
                // Refresh Session
                LoginResponse result = apiInstance.refreshSession(cookie, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling LoginApi.refreshSession: " + e.Message );
            }
        }
    }
}

                                                    

refreshSession($cookie, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoginApi->refreshSession: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
cookie
apiVersion

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - User not found

Status: 500 - Internal error occurred


Records

addRecord

Add a new record

Add a new record


/records/{repositoryName}/addRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/addRecord?perspectiveName="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Record to be added
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        try {
            Response result = apiInstance.addRecord(repositoryName, body, authorization, apiVersion, perspectiveName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Record to be added
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        try {
            Response result = apiInstance.addRecord(repositoryName, body, authorization, apiVersion, perspectiveName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordSaveConfig *body = ; // Record to be added
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)

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

// Add a new record
[apiInstance addRecordWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    perspectiveName:perspectiveName
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordSaveConfig} Record to be added

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'perspectiveName': perspectiveName_example // {String} Perspective name
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordSaveConfig(); // RecordSaveConfig | Record to be added
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 

            try
            {
                // Add a new record
                Response result = apiInstance.addRecord(repositoryName, body, authorization, apiVersion, perspectiveName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.addRecord: " + e.Message );
            }
        }
    }
}

                                                    

addRecord($repositoryName, $body, $authorization, $apiVersion, $perspectiveName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->addRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
perspectiveName

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


addRecordWithUpload

Add a new record with file upload


/records/addRecordWithUpload/{repositoryName}

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/addRecordWithUpload/{repositoryName}?perspectiveName="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String body = body_example; // String | Record
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        try {
            Response result = apiInstance.addRecordWithUpload(repositoryName, body, authorization, apiVersion, perspectiveName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRecordWithUpload");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String body = body_example; // String | Record
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        try {
            Response result = apiInstance.addRecordWithUpload(repositoryName, body, authorization, apiVersion, perspectiveName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRecordWithUpload");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *body = body_example; // Record
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)

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

// 
[apiInstance addRecordWithUploadWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    perspectiveName:perspectiveName
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = body_example; // {String} Record

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'perspectiveName': perspectiveName_example // {String} Perspective name
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addRecordWithUploadExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = body_example;  // String | Record
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 

            try
            {
                // 
                Response result = apiInstance.addRecordWithUpload(repositoryName, body, authorization, apiVersion, perspectiveName);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.addRecordWithUpload: " + e.Message );
            }
        }
    }
}

                                                    

addRecordWithUpload($repositoryName, $body, $authorization, $apiVersion, $perspectiveName);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->addRecordWithUpload: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
perspectiveName

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


addRelatedRecord

Add a Related Record

Use to add a related record


/records/{repositoryName}/addRelatedRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/addRelatedRecord?workItemId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Relationship to be added.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.addRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Relationship to be added.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.addRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#addRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordSaveConfig *body = ; // Relationship to be added.
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *workItemId = workItemId_example; // Work Item ID (optional)

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

// Add a Related Record
[apiInstance addRelatedRecordWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    workItemId:workItemId
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordSaveConfig} Relationship to be added.

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'workItemId': workItemId_example // {String} Work Item ID
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addRelatedRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordSaveConfig(); // RecordSaveConfig | Relationship to be added.
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var workItemId = workItemId_example;  // String | Work Item ID (optional) 

            try
            {
                // Add a Related Record
                Response result = apiInstance.addRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.addRelatedRecord: " + e.Message );
            }
        }
    }
}

                                                    

addRelatedRecord($repositoryName, $body, $authorization, $apiVersion, $workItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->addRelatedRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
workItemId

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


compareRecord

Compare Record

Compare a Record version either with compareVersion or compareVersionMode


/records/{repositoryName}/compareRecord/{id}

Usage and SDK Samples


curl -X get "http://hostname:8080/eml/rest/records/{repositoryName}/compareRecord/{id}?idExt=&compareVersionMode=&modVersion=&compareVersion=&bulkCompareMode=&fullCompare="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository name
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String compareVersionMode = compareVersionMode_example; // String | Compare with following record version mode-PREVIOUS_CONFIRMED_VERSION (default- It is a latest confirmed version of record)/PREVIOUS_VERSION (It is a previous version of record)
        String modVersion = modVersion_example; // String | Record Version
        String compareVersion = compareVersion_example; // String | Compare with Record version
        Boolean bulkCompareMode = true; // Boolean | Include Realtionships
        Boolean fullCompare = true; // Boolean | Return full Catalog Attriibutes
        try {
            Record result = apiInstance.compareRecord(repositoryName, id, idExt, authorization, apiVersion, compareVersionMode, modVersion, compareVersion, bulkCompareMode, fullCompare);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#compareRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository name
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String compareVersionMode = compareVersionMode_example; // String | Compare with following record version mode-PREVIOUS_CONFIRMED_VERSION (default- It is a latest confirmed version of record)/PREVIOUS_VERSION (It is a previous version of record)
        String modVersion = modVersion_example; // String | Record Version
        String compareVersion = compareVersion_example; // String | Compare with Record version
        Boolean bulkCompareMode = true; // Boolean | Include Realtionships
        Boolean fullCompare = true; // Boolean | Return full Catalog Attriibutes
        try {
            Record result = apiInstance.compareRecord(repositoryName, id, idExt, authorization, apiVersion, compareVersionMode, modVersion, compareVersion, bulkCompareMode, fullCompare);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#compareRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository name
String *id = id_example; // Record Id
String *idExt = idExt_example; // Record Id Extension
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *compareVersionMode = compareVersionMode_example; // Compare with following record version mode-PREVIOUS_CONFIRMED_VERSION (default- It is a latest confirmed version of record)/PREVIOUS_VERSION (It is a previous version of record) (optional)
String *modVersion = modVersion_example; // Record Version (optional)
String *compareVersion = compareVersion_example; // Compare with Record version (optional)
Boolean *bulkCompareMode = true; // Include Realtionships (optional)
Boolean *fullCompare = true; // Return full Catalog Attriibutes (optional)

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

// Compare Record
[apiInstance compareRecordWith:repositoryName
    id:id
    idExt:idExt
    authorization:authorization
    apiVersion:apiVersion
    compareVersionMode:compareVersionMode
    modVersion:modVersion
    compareVersion:compareVersion
    bulkCompareMode:bulkCompareMode
    fullCompare:fullCompare
              completionHandler: ^(Record output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository name

var id = id_example; // {String} Record Id

var idExt = idExt_example; // {String} Record Id Extension

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'compareVersionMode': compareVersionMode_example, // {String} Compare with following record version mode-PREVIOUS_CONFIRMED_VERSION (default- It is a latest confirmed version of record)/PREVIOUS_VERSION (It is a previous version of record)
  'modVersion': modVersion_example, // {String} Record Version
  'compareVersion': compareVersion_example, // {String} Compare with Record version
  'bulkCompareMode': true, // {Boolean} Include Realtionships
  'fullCompare': true // {Boolean} Return full Catalog Attriibutes
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.compareRecord(repositoryName, id, idExt, authorization, apiVersion, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class compareRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository name
            var id = id_example;  // String | Record Id
            var idExt = idExt_example;  // String | Record Id Extension
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var compareVersionMode = compareVersionMode_example;  // String | Compare with following record version mode-PREVIOUS_CONFIRMED_VERSION (default- It is a latest confirmed version of record)/PREVIOUS_VERSION (It is a previous version of record) (optional) 
            var modVersion = modVersion_example;  // String | Record Version (optional) 
            var compareVersion = compareVersion_example;  // String | Compare with Record version (optional) 
            var bulkCompareMode = true;  // Boolean | Include Realtionships (optional) 
            var fullCompare = true;  // Boolean | Return full Catalog Attriibutes (optional) 

            try
            {
                // Compare Record
                Record result = apiInstance.compareRecord(repositoryName, id, idExt, authorization, apiVersion, compareVersionMode, modVersion, compareVersion, bulkCompareMode, fullCompare);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.compareRecord: " + e.Message );
            }
        }
    }
}

                                                    

compareRecord($repositoryName, $id, $idExt, $authorization, $apiVersion, $compareVersionMode, $modVersion, $compareVersion, $bulkCompareMode, $fullCompare);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->compareRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
id*
Header parameters
Name Description
authorization*
apiVersion*
Query parameters
Name Description
idExt*
compareVersionMode
modVersion
compareVersion
bulkCompareMode
fullCompare

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 404 - Record not found

Status: 500 - Invalid Request


deleteRecord

Delete a record

Delete a record


/records/{repositoryName}/deleteRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/deleteRecord?id=&idExt=&deleteRelRecords="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordDeleteCriteria body = ; // RecordDeleteCriteria | Record Delete JSON
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        Boolean deleteRelRecords = true; // Boolean | Delete All Related Records
        try {
            Response result = apiInstance.deleteRecord(repositoryName, body, authorization, apiVersion, id, idExt, deleteRelRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#deleteRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordDeleteCriteria body = ; // RecordDeleteCriteria | Record Delete JSON
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        Boolean deleteRelRecords = true; // Boolean | Delete All Related Records
        try {
            Response result = apiInstance.deleteRecord(repositoryName, body, authorization, apiVersion, id, idExt, deleteRelRecords);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#deleteRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordDeleteCriteria *body = ; // Record Delete JSON
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *id = id_example; // Record Id (optional)
String *idExt = idExt_example; // Record Id Extension (optional)
Boolean *deleteRelRecords = true; // Delete All Related Records (optional)

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

// Delete a record
[apiInstance deleteRecordWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    id:id
    idExt:idExt
    deleteRelRecords:deleteRelRecords
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordDeleteCriteria} Record Delete JSON

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'id': id_example, // {String} Record Id
  'idExt': idExt_example, // {String} Record Id Extension
  'deleteRelRecords': true // {Boolean} Delete All Related Records
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordDeleteCriteria(); // RecordDeleteCriteria | Record Delete JSON
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var id = id_example;  // String | Record Id (optional) 
            var idExt = idExt_example;  // String | Record Id Extension (optional) 
            var deleteRelRecords = true;  // Boolean | Delete All Related Records (optional) 

            try
            {
                // Delete a record
                Response result = apiInstance.deleteRecord(repositoryName, body, authorization, apiVersion, id, idExt, deleteRelRecords);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.deleteRecord: " + e.Message );
            }
        }
    }
}

                                                    

deleteRecord($repositoryName, $body, $authorization, $apiVersion, $id, $idExt, $deleteRelRecords);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->deleteRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
id
idExt
deleteRelRecords

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 404 - Record not found

Status: 500 - Invalid Request


deleteRelatedRecord

Delete a Related Record

Delete a Related Record


/records/{repositoryName}/deleteRelatedRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/deleteRelatedRecord?id=&idExt=&relationshipName=&targetRepositoryName=&childId=&childIdExt="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String id = id_example; // String | Record Id
        String relationshipName = relationshipName_example; // String | Relationship name
        String targetRepositoryName = targetRepositoryName_example; // String | Target repository name
        String childId = childId_example; // String | Child Record Id
        RelatedRecordDeleteCriteria body = ; // RelatedRecordDeleteCriteria | Record Delete JSON
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String idExt = idExt_example; // String | Record Id Extension
        String childIdExt = childIdExt_example; // String | Child  Record Id Extension
        try {
            Response result = apiInstance.deleteRelatedRecord(repositoryName, id, relationshipName, targetRepositoryName, childId, body, authorization, apiVersion, idExt, childIdExt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#deleteRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String id = id_example; // String | Record Id
        String relationshipName = relationshipName_example; // String | Relationship name
        String targetRepositoryName = targetRepositoryName_example; // String | Target repository name
        String childId = childId_example; // String | Child Record Id
        RelatedRecordDeleteCriteria body = ; // RelatedRecordDeleteCriteria | Record Delete JSON
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String idExt = idExt_example; // String | Record Id Extension
        String childIdExt = childIdExt_example; // String | Child  Record Id Extension
        try {
            Response result = apiInstance.deleteRelatedRecord(repositoryName, id, relationshipName, targetRepositoryName, childId, body, authorization, apiVersion, idExt, childIdExt);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#deleteRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *id = id_example; // Record Id
String *relationshipName = relationshipName_example; // Relationship name
String *targetRepositoryName = targetRepositoryName_example; // Target repository name
String *childId = childId_example; // Child Record Id
RelatedRecordDeleteCriteria *body = ; // Record Delete JSON
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *idExt = idExt_example; // Record Id Extension (optional)
String *childIdExt = childIdExt_example; // Child  Record Id Extension (optional)

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

// Delete a Related Record
[apiInstance deleteRelatedRecordWith:repositoryName
    id:id
    relationshipName:relationshipName
    targetRepositoryName:targetRepositoryName
    childId:childId
    body:body
    authorization:authorization
    apiVersion:apiVersion
    idExt:idExt
    childIdExt:childIdExt
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var id = id_example; // {String} Record Id

var relationshipName = relationshipName_example; // {String} Relationship name

var targetRepositoryName = targetRepositoryName_example; // {String} Target repository name

var childId = childId_example; // {String} Child Record Id

var body = ; // {RelatedRecordDeleteCriteria} Record Delete JSON

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'idExt': idExt_example, // {String} Record Id Extension
  'childIdExt': childIdExt_example // {String} Child  Record Id Extension
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRelatedRecord(repositoryName, id, relationshipName, targetRepositoryName, childId, body, authorization, apiVersion, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class deleteRelatedRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var id = id_example;  // String | Record Id
            var relationshipName = relationshipName_example;  // String | Relationship name
            var targetRepositoryName = targetRepositoryName_example;  // String | Target repository name
            var childId = childId_example;  // String | Child Record Id
            var body = new RelatedRecordDeleteCriteria(); // RelatedRecordDeleteCriteria | Record Delete JSON
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var idExt = idExt_example;  // String | Record Id Extension (optional) 
            var childIdExt = childIdExt_example;  // String | Child  Record Id Extension (optional) 

            try
            {
                // Delete a Related Record
                Response result = apiInstance.deleteRelatedRecord(repositoryName, id, relationshipName, targetRepositoryName, childId, body, authorization, apiVersion, idExt, childIdExt);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.deleteRelatedRecord: " + e.Message );
            }
        }
    }
}

                                                    

deleteRelatedRecord($repositoryName, $id, $relationshipName, $targetRepositoryName, $childId, $body, $authorization, $apiVersion, $idExt, $childIdExt);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->deleteRelatedRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
id*
idExt
relationshipName*
targetRepositoryName*
childId*
childIdExt

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 404 - Record not found

Status: 500 - Invalid Request


getRecordById

Retrieves record by ID and IDEXT

Use to retrieve a record by their product ID and ID extension.


/records/{repositoryName}/{id}

Usage and SDK Samples


curl -X get "http://hostname:8080/eml/rest/records/{repositoryName}/{id}?idExt=&workItemId=&includeSystemAttributes=&findRootRecord=&recordState=&active=&perspectiveName=&relationshipType=&relationshipDepth="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        Boolean findRootRecord = true; // Boolean | Finds root record only- Default false
        String recordState = recordState_example; // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
        String active = active_example; // String | Active-Y(default)/N/ANY
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String relationshipType = relationshipType_example; // String | Relationship Type - ALL,FORWARD(Default),REVERSE)
        Integer relationshipDepth = 56; // Integer | Relationship Depth- Default 2nd Level
        try {
            Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRecordById");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        Boolean findRootRecord = true; // Boolean | Finds root record only- Default false
        String recordState = recordState_example; // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
        String active = active_example; // String | Active-Y(default)/N/ANY
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String relationshipType = relationshipType_example; // String | Relationship Type - ALL,FORWARD(Default),REVERSE)
        Integer relationshipDepth = 56; // Integer | Relationship Depth- Default 2nd Level
        try {
            Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRecordById");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *id = id_example; // Record Id
String *idExt = idExt_example; // Record Id Extension
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *workItemId = workItemId_example; // Work Item ID (optional)
Boolean *includeSystemAttributes = true; // Include System Attribute- Default false (optional)
Boolean *findRootRecord = true; // Finds root record only- Default false (optional)
String *recordState = recordState_example; // Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional)
String *active = active_example; // Active-Y(default)/N/ANY (optional)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)
String *relationshipType = relationshipType_example; // Relationship Type - ALL,FORWARD(Default),REVERSE) (optional)
Integer *relationshipDepth = 56; // Relationship Depth- Default 2nd Level (optional)

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

// Retrieves record by ID and IDEXT
[apiInstance getRecordByIdWith:repositoryName
    id:id
    idExt:idExt
    authorization:authorization
    apiVersion:apiVersion
    workItemId:workItemId
    includeSystemAttributes:includeSystemAttributes
    findRootRecord:findRootRecord
    recordState:recordState
    active:active
    perspectiveName:perspectiveName
    relationshipType:relationshipType
    relationshipDepth:relationshipDepth
              completionHandler: ^(Record output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var id = id_example; // {String} Record Id

var idExt = idExt_example; // {String} Record Id Extension

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'workItemId': workItemId_example, // {String} Work Item ID
  'includeSystemAttributes': true, // {Boolean} Include System Attribute- Default false
  'findRootRecord': true, // {Boolean} Finds root record only- Default false
  'recordState': recordState_example, // {String} Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
  'active': active_example, // {String} Active-Y(default)/N/ANY
  'perspectiveName': perspectiveName_example, // {String} Perspective name
  'relationshipType': relationshipType_example, // {String} Relationship Type - ALL,FORWARD(Default),REVERSE)
  'relationshipDepth': 56 // {Integer} Relationship Depth- Default 2nd Level
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecordById(repositoryName, id, idExt, authorization, apiVersion, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getRecordByIdExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var id = id_example;  // String | Record Id
            var idExt = idExt_example;  // String | Record Id Extension
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var workItemId = workItemId_example;  // String | Work Item ID (optional) 
            var includeSystemAttributes = true;  // Boolean | Include System Attribute- Default false (optional) 
            var findRootRecord = true;  // Boolean | Finds root record only- Default false (optional) 
            var recordState = recordState_example;  // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional) 
            var active = active_example;  // String | Active-Y(default)/N/ANY (optional) 
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 
            var relationshipType = relationshipType_example;  // String | Relationship Type - ALL,FORWARD(Default),REVERSE) (optional) 
            var relationshipDepth = 56;  // Integer | Relationship Depth- Default 2nd Level (optional) 

            try
            {
                // Retrieves record by ID and IDEXT
                Record result = apiInstance.getRecordById(repositoryName, id, idExt, authorization, apiVersion, workItemId, includeSystemAttributes, findRootRecord, recordState, active, perspectiveName, relationshipType, relationshipDepth);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.getRecordById: " + e.Message );
            }
        }
    }
}

                                                    

getRecordById($repositoryName, $id, $idExt, $authorization, $apiVersion, $workItemId, $includeSystemAttributes, $findRootRecord, $recordState, $active, $perspectiveName, $relationshipType, $relationshipDepth);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->getRecordById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
id*
Header parameters
Name Description
authorization*
apiVersion*
Query parameters
Name Description
idExt*
workItemId
includeSystemAttributes
findRootRecord
recordState
active
perspectiveName
relationshipType
relationshipDepth

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Record not found

Status: 500 - Invalid Request


getRecordsByRepositoryName

Retrieves records from a repository

Use to retrieve records from a repoitory.


/records/{repositoryName}

Usage and SDK Samples


curl -X get "http://hostname:8080/eml/rest/records/{repositoryName}?startIndex=&recordCount=&includeSystemAttributes=&sortBy=&ascending=&recordState=&active=&workItemId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        Integer startIndex = 56; // Integer | 1-based starting index of start record (pagination)
        Integer recordCount = 56; // Integer | Number of records to retrieve (pagination)
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        String sortBy = sortBy_example; // String | Sort by column name works with Sort Order
        Boolean ascending = true; // Boolean | Sort order works with sortBy- ASC/DESC
        String recordState = recordState_example; // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
        String active = active_example; // String | Active-Y(default)/N/ANY
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            RecordList result = apiInstance.getRecordsByRepositoryName(repositoryName, authorization, apiVersion, startIndex, recordCount, includeSystemAttributes, sortBy, ascending, recordState, active, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRecordsByRepositoryName");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        Integer startIndex = 56; // Integer | 1-based starting index of start record (pagination)
        Integer recordCount = 56; // Integer | Number of records to retrieve (pagination)
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        String sortBy = sortBy_example; // String | Sort by column name works with Sort Order
        Boolean ascending = true; // Boolean | Sort order works with sortBy- ASC/DESC
        String recordState = recordState_example; // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
        String active = active_example; // String | Active-Y(default)/N/ANY
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            RecordList result = apiInstance.getRecordsByRepositoryName(repositoryName, authorization, apiVersion, startIndex, recordCount, includeSystemAttributes, sortBy, ascending, recordState, active, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRecordsByRepositoryName");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
Integer *startIndex = 56; // 1-based starting index of start record (pagination) (optional)
Integer *recordCount = 56; // Number of records to retrieve (pagination) (optional)
Boolean *includeSystemAttributes = true; // Include System Attribute- Default false (optional)
String *sortBy = sortBy_example; // Sort by column name works with Sort Order (optional)
Boolean *ascending = true; // Sort order works with sortBy- ASC/DESC (optional)
String *recordState = recordState_example; // Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional)
String *active = active_example; // Active-Y(default)/N/ANY (optional)
String *workItemId = workItemId_example; // Work Item ID (optional)

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

// Retrieves records from a repository
[apiInstance getRecordsByRepositoryNameWith:repositoryName
    authorization:authorization
    apiVersion:apiVersion
    startIndex:startIndex
    recordCount:recordCount
    includeSystemAttributes:includeSystemAttributes
    sortBy:sortBy
    ascending:ascending
    recordState:recordState
    active:active
    workItemId:workItemId
              completionHandler: ^(RecordList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'startIndex': 56, // {Integer} 1-based starting index of start record (pagination)
  'recordCount': 56, // {Integer} Number of records to retrieve (pagination)
  'includeSystemAttributes': true, // {Boolean} Include System Attribute- Default false
  'sortBy': sortBy_example, // {String} Sort by column name works with Sort Order
  'ascending': true, // {Boolean} Sort order works with sortBy- ASC/DESC
  'recordState': recordState_example, // {String} Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL
  'active': active_example, // {String} Active-Y(default)/N/ANY
  'workItemId': workItemId_example // {String} Work Item ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecordsByRepositoryName(repositoryName, authorization, apiVersion, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getRecordsByRepositoryNameExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var startIndex = 56;  // Integer | 1-based starting index of start record (pagination) (optional) 
            var recordCount = 56;  // Integer | Number of records to retrieve (pagination) (optional) 
            var includeSystemAttributes = true;  // Boolean | Include System Attribute- Default false (optional) 
            var sortBy = sortBy_example;  // String | Sort by column name works with Sort Order (optional) 
            var ascending = true;  // Boolean | Sort order works with sortBy- ASC/DESC (optional) 
            var recordState = recordState_example;  // String | Record State-  CONFIRMED(Default),UNCONFIRMED,LATEST,DELETED,ALL (optional) 
            var active = active_example;  // String | Active-Y(default)/N/ANY (optional) 
            var workItemId = workItemId_example;  // String | Work Item ID (optional) 

            try
            {
                // Retrieves records from a repository
                RecordList result = apiInstance.getRecordsByRepositoryName(repositoryName, authorization, apiVersion, startIndex, recordCount, includeSystemAttributes, sortBy, ascending, recordState, active, workItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.getRecordsByRepositoryName: " + e.Message );
            }
        }
    }
}

                                                    

getRecordsByRepositoryName($repositoryName, $authorization, $apiVersion, $startIndex, $recordCount, $includeSystemAttributes, $sortBy, $ascending, $recordState, $active, $workItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->getRecordsByRepositoryName: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Query parameters
Name Description
startIndex
recordCount
includeSystemAttributes
sortBy
ascending
recordState
active
workItemId

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Repository not found

Status: 500 - Invalid Request


getRelatedRecordsById

Retrieves related records by parent record Id and Id Extension

Use to retrieve related records by their product ID and ID extension


/records/{repositoryName}/{id}/relatedrecords/{relationshipName}

Usage and SDK Samples


curl -X get "http://hostname:8080/eml/rest/records/{repositoryName}/{id}/relatedrecords/{relationshipName}?idExt=&sortBy=&ascending=&perspectiveName=&recordState=&includeSystemAttributes="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String relationshipName = relationshipName_example; // String | Relationship Name (case-sensitive)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String sortBy = sortBy_example; // String | Sort by column name works with Sort Order
        Boolean ascending = true; // Boolean | Sort order works with sortBy- ASC/DESC
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String recordState = recordState_example; // String | Record State - CONFIRMED(Default),UNCONFIRMED,LATEST
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        try {
            RelationshipRecordList result = apiInstance.getRelatedRecordsById(repositoryName, relationshipName, id, idExt, authorization, apiVersion, sortBy, ascending, perspectiveName, recordState, includeSystemAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRelatedRecordsById");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String relationshipName = relationshipName_example; // String | Relationship Name (case-sensitive)
        String id = id_example; // String | Record Id
        String idExt = idExt_example; // String | Record Id Extension
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String sortBy = sortBy_example; // String | Sort by column name works with Sort Order
        Boolean ascending = true; // Boolean | Sort order works with sortBy- ASC/DESC
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String recordState = recordState_example; // String | Record State - CONFIRMED(Default),UNCONFIRMED,LATEST
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        try {
            RelationshipRecordList result = apiInstance.getRelatedRecordsById(repositoryName, relationshipName, id, idExt, authorization, apiVersion, sortBy, ascending, perspectiveName, recordState, includeSystemAttributes);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#getRelatedRecordsById");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *relationshipName = relationshipName_example; // Relationship Name (case-sensitive)
String *id = id_example; // Record Id
String *idExt = idExt_example; // Record Id Extension
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *sortBy = sortBy_example; // Sort by column name works with Sort Order (optional)
Boolean *ascending = true; // Sort order works with sortBy- ASC/DESC (optional)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)
String *recordState = recordState_example; // Record State - CONFIRMED(Default),UNCONFIRMED,LATEST (optional)
Boolean *includeSystemAttributes = true; // Include System Attribute- Default false (optional)

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

// Retrieves related records by parent record Id and Id Extension
[apiInstance getRelatedRecordsByIdWith:repositoryName
    relationshipName:relationshipName
    id:id
    idExt:idExt
    authorization:authorization
    apiVersion:apiVersion
    sortBy:sortBy
    ascending:ascending
    perspectiveName:perspectiveName
    recordState:recordState
    includeSystemAttributes:includeSystemAttributes
              completionHandler: ^(RelationshipRecordList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var relationshipName = relationshipName_example; // {String} Relationship Name (case-sensitive)

var id = id_example; // {String} Record Id

var idExt = idExt_example; // {String} Record Id Extension

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'sortBy': sortBy_example, // {String} Sort by column name works with Sort Order
  'ascending': true, // {Boolean} Sort order works with sortBy- ASC/DESC
  'perspectiveName': perspectiveName_example, // {String} Perspective name
  'recordState': recordState_example, // {String} Record State - CONFIRMED(Default),UNCONFIRMED,LATEST
  'includeSystemAttributes': true // {Boolean} Include System Attribute- Default false
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedRecordsById(repositoryName, relationshipName, id, idExt, authorization, apiVersion, opts, callback);

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class getRelatedRecordsByIdExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var relationshipName = relationshipName_example;  // String | Relationship Name (case-sensitive)
            var id = id_example;  // String | Record Id
            var idExt = idExt_example;  // String | Record Id Extension
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var sortBy = sortBy_example;  // String | Sort by column name works with Sort Order (optional) 
            var ascending = true;  // Boolean | Sort order works with sortBy- ASC/DESC (optional) 
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 
            var recordState = recordState_example;  // String | Record State - CONFIRMED(Default),UNCONFIRMED,LATEST (optional) 
            var includeSystemAttributes = true;  // Boolean | Include System Attribute- Default false (optional) 

            try
            {
                // Retrieves related records by parent record Id and Id Extension
                RelationshipRecordList result = apiInstance.getRelatedRecordsById(repositoryName, relationshipName, id, idExt, authorization, apiVersion, sortBy, ascending, perspectiveName, recordState, includeSystemAttributes);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.getRelatedRecordsById: " + e.Message );
            }
        }
    }
}

                                                    

getRelatedRecordsById($repositoryName, $relationshipName, $id, $idExt, $authorization, $apiVersion, $sortBy, $ascending, $perspectiveName, $recordState, $includeSystemAttributes);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->getRelatedRecordsById: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
relationshipName*
id*
Header parameters
Name Description
authorization*
apiVersion*
Query parameters
Name Description
idExt*
sortBy
ascending
perspectiveName
recordState
includeSystemAttributes

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Record not found

Status: 500 - Invalid Request


modifyRecord

Modify a record

Use to modify a record


/records/{repositoryName}/modifyRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/modifyRecord?perspectiveName=&workItemId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Record to be modified./nrecordID (productId) and recordIDExt (productIdExt) are used to identify the original-record. The attributes PRODUCTID and PRODUCTIDEXT values will be used to update them.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.modifyRecord(repositoryName, body, authorization, apiVersion, perspectiveName, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Record to be modified./nrecordID (productId) and recordIDExt (productIdExt) are used to identify the original-record. The attributes PRODUCTID and PRODUCTIDEXT values will be used to update them.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.modifyRecord(repositoryName, body, authorization, apiVersion, perspectiveName, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordSaveConfig *body = ; // Record to be modified./nrecordID (productId) and recordIDExt (productIdExt) are used to identify the original-record. The attributes PRODUCTID and PRODUCTIDEXT values will be used to update them.
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *perspectiveName = perspectiveName_example; // Perspective name (optional)
String *workItemId = workItemId_example; // Work Item ID (optional)

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

// Modify a record
[apiInstance modifyRecordWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    perspectiveName:perspectiveName
    workItemId:workItemId
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordSaveConfig} Record to be modified./nrecordID (productId) and recordIDExt (productIdExt) are used to identify the original-record. The attributes PRODUCTID and PRODUCTIDEXT values will be used to update them.

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'perspectiveName': perspectiveName_example, // {String} Perspective name
  'workItemId': workItemId_example // {String} Work Item ID
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class modifyRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordSaveConfig(); // RecordSaveConfig | Record to be modified./nrecordID (productId) and recordIDExt (productIdExt) are used to identify the original-record. The attributes PRODUCTID and PRODUCTIDEXT values will be used to update them.
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 
            var workItemId = workItemId_example;  // String | Work Item ID (optional) 

            try
            {
                // Modify a record
                Response result = apiInstance.modifyRecord(repositoryName, body, authorization, apiVersion, perspectiveName, workItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.modifyRecord: " + e.Message );
            }
        }
    }
}

                                                    

modifyRecord($repositoryName, $body, $authorization, $apiVersion, $perspectiveName, $workItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->modifyRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
perspectiveName
workItemId

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


modifyRecordWithUpload

Modify a new record with file upload


/records/updateRecordWithUpload/{repositoryName}

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/updateRecordWithUpload/{repositoryName}?perspectiveName=&workItemId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String body = body_example; // String | Record
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String workItemId = workItemId_example; // String | work Item Id
        try {
            Response result = apiInstance.modifyRecordWithUpload(repositoryName, authorization, apiVersion, body, perspectiveName, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRecordWithUpload");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String body = body_example; // String | Record
        String perspectiveName = perspectiveName_example; // String | Perspective name
        String workItemId = workItemId_example; // String | work Item Id
        try {
            Response result = apiInstance.modifyRecordWithUpload(repositoryName, authorization, apiVersion, body, perspectiveName, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRecordWithUpload");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *body = body_example; // Record
String *perspectiveName = perspectiveName_example; // Perspective name (optional)
String *workItemId = workItemId_example; // work Item Id (optional)

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

// 
[apiInstance modifyRecordWithUploadWith:repositoryName
    authorization:authorization
    apiVersion:apiVersion
    body:body
    perspectiveName:perspectiveName
    workItemId:workItemId
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var body = body_example; // {String} Record

var opts = { 
  'perspectiveName': perspectiveName_example, // {String} Perspective name
  'workItemId': workItemId_example // {String} work Item Id
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class modifyRecordWithUploadExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var body = body_example;  // String | Record
            var perspectiveName = perspectiveName_example;  // String | Perspective name (optional) 
            var workItemId = workItemId_example;  // String | work Item Id (optional) 

            try
            {
                // 
                Response result = apiInstance.modifyRecordWithUpload(repositoryName, authorization, apiVersion, body, perspectiveName, workItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.modifyRecordWithUpload: " + e.Message );
            }
        }
    }
}

                                                    

modifyRecordWithUpload($repositoryName, $authorization, $apiVersion, $body, $perspectiveName, $workItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->modifyRecordWithUpload: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
perspectiveName
workItemId

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


modifyRelatedRecord

Modify a Related Record

Use to modify a related record


/records/{repositoryName}/modifyRelatedRecord

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/modifyRelatedRecord?workItemId="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Relationship to be added.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.modifyRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSaveConfig body = ; // RecordSaveConfig | Relationship to be added.
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        String workItemId = workItemId_example; // String | Work Item ID
        try {
            Response result = apiInstance.modifyRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#modifyRelatedRecord");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordSaveConfig *body = ; // Relationship to be added.
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
String *workItemId = workItemId_example; // Work Item ID (optional)

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

// Modify a Related Record
[apiInstance modifyRelatedRecordWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    workItemId:workItemId
              completionHandler: ^(Response output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordSaveConfig} Relationship to be added.

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'workItemId': workItemId_example // {String} Work Item ID
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class modifyRelatedRecordExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordSaveConfig(); // RecordSaveConfig | Relationship to be added.
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var workItemId = workItemId_example;  // String | Work Item ID (optional) 

            try
            {
                // Modify a Related Record
                Response result = apiInstance.modifyRelatedRecord(repositoryName, body, authorization, apiVersion, workItemId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.modifyRelatedRecord: " + e.Message );
            }
        }
    }
}

                                                    

modifyRelatedRecord($repositoryName, $body, $authorization, $apiVersion, $workItemId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->modifyRelatedRecord: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
workItemId

Responses

Status: 200 - successful operation

Status: 400 - Bad request

Status: 500 - Invalid Request


searchRecords

Search for records

Use to search a record.


/records/{repositoryName}/search

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/{repositoryName}/search?includeSystemAttributes=&findRootRecord="



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSearchCriteria body = ; // RecordSearchCriteria | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        Boolean findRootRecord = true; // Boolean | Find root record only- Default false
        try {
            RecordList result = apiInstance.searchRecords(repositoryName, body, authorization, apiVersion, includeSystemAttributes, findRootRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#searchRecords");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        String repositoryName = repositoryName_example; // String | Repository Name (case-insensitive)
        RecordSearchCriteria body = ; // RecordSearchCriteria | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        Boolean includeSystemAttributes = true; // Boolean | Include System Attribute- Default false
        Boolean findRootRecord = true; // Boolean | Find root record only- Default false
        try {
            RecordList result = apiInstance.searchRecords(repositoryName, body, authorization, apiVersion, includeSystemAttributes, findRootRecord);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#searchRecords");
            e.printStackTrace();
        }
    }
}

                                                  


String *repositoryName = repositoryName_example; // Repository Name (case-insensitive)
RecordSearchCriteria *body = ; // Record Search Criteria JSON Object
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
Boolean *includeSystemAttributes = true; // Include System Attribute- Default false (optional)
Boolean *findRootRecord = true; // Find root record only- Default false (optional)

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

// Search for records
[apiInstance searchRecordsWith:repositoryName
    body:body
    authorization:authorization
    apiVersion:apiVersion
    includeSystemAttributes:includeSystemAttributes
    findRootRecord:findRootRecord
              completionHandler: ^(RecordList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var repositoryName = repositoryName_example; // {String} Repository Name (case-insensitive)

var body = ; // {RecordSearchCriteria} Record Search Criteria JSON Object

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'includeSystemAttributes': true, // {Boolean} Include System Attribute- Default false
  'findRootRecord': true // {Boolean} Find root record only- Default false
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class searchRecordsExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var repositoryName = repositoryName_example;  // String | Repository Name (case-insensitive)
            var body = new RecordSearchCriteria(); // RecordSearchCriteria | Record Search Criteria JSON Object
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var includeSystemAttributes = true;  // Boolean | Include System Attribute- Default false (optional) 
            var findRootRecord = true;  // Boolean | Find root record only- Default false (optional) 

            try
            {
                // Search for records
                RecordList result = apiInstance.searchRecords(repositoryName, body, authorization, apiVersion, includeSystemAttributes, findRootRecord);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.searchRecords: " + e.Message );
            }
        }
    }
}

                                                    

searchRecords($repositoryName, $body, $authorization, $apiVersion, $includeSystemAttributes, $findRootRecord);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->searchRecords: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Path parameters
Name Description
repositoryName*
Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *
Query parameters
Name Description
includeSystemAttributes
findRootRecord

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Record not found

Status: 500 - Invalid Request


textSearch

Text Search

text Search for records


/records/textSearch

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/records/textSearch"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .RecordsApi;

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

public class RecordsApiExample {

    public static void main(String[] args) {
        
        RecordsApi apiInstance = new RecordsApi();
        TextSearchRequest body = ; // TextSearchRequest | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            RecordList result = apiInstance.textSearch(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#textSearch");
            e.printStackTrace();
        }
    }
}

                                                  

import .RecordsApi;

public class RecordsApiExample {

    public static void main(String[] args) {
        RecordsApi apiInstance = new RecordsApi();
        TextSearchRequest body = ; // TextSearchRequest | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            RecordList result = apiInstance.textSearch(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecordsApi#textSearch");
            e.printStackTrace();
        }
    }
}

                                                  


TextSearchRequest *body = ; // Record Search Criteria JSON Object
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)

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

// Text Search
[apiInstance textSearchWith:body
    authorization:authorization
    apiVersion:apiVersion
              completionHandler: ^(RecordList output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .RecordsApi()

var body = ; // {TextSearchRequest} Record Search Criteria JSON Object

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class textSearchExample
    {
        public void main()
        {
            
            var apiInstance = new RecordsApi();
            var body = new TextSearchRequest(); // TextSearchRequest | Record Search Criteria JSON Object
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)

            try
            {
                // Text Search
                RecordList result = apiInstance.textSearch(body, authorization, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecordsApi.textSearch: " + e.Message );
            }
        }
    }
}

                                                    

textSearch($body, $authorization, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RecordsApi->textSearch: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Record not found

Status: 500 - Invalid Request


Golden Record Cache

addFields

Add External Attribute

Create user-defined external attributes at run time when golden record cache is defined and running.


/fastcache/metadata/addFields

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/fastcache/metadata/addFields"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .FastcacheApi;

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

public class FastcacheApiExample {

    public static void main(String[] args) {
        
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.addFields(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#addFields");
            e.printStackTrace();
        }
    }
}

                                                  

import .FastcacheApi;

public class FastcacheApiExample {

    public static void main(String[] args) {
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.addFields(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#addFields");
            e.printStackTrace();
        }
    }
}

                                                  


CacheMetadataOperation *body = ; // Cache Metadeta Operation
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)

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

// Add External Attribute
[apiInstance addFieldsWith:body
    authorization:authorization
    apiVersion:apiVersion
              completionHandler: ^(ResponseFS output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .FastcacheApi()

var body = ; // {CacheMetadataOperation} Cache Metadeta Operation

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class addFieldsExample
    {
        public void main()
        {
            
            var apiInstance = new FastcacheApi();
            var body = new CacheMetadataOperation(); // CacheMetadataOperation | Cache Metadeta Operation
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)

            try
            {
                // Add External Attribute
                ResponseFS result = apiInstance.addFields(body, authorization, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FastcacheApi.addFields: " + e.Message );
            }
        }
    }
}

                                                    

addFields($body, $authorization, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FastcacheApi->addFields: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 500 - Invalid Request


createIndex

Create Index

Create cache index at run time when golden record cache has been defined and started.


/fastcache/metadata/createIndex

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/fastcache/metadata/createIndex"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .FastcacheApi;

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

public class FastcacheApiExample {

    public static void main(String[] args) {
        
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.createIndex(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#createIndex");
            e.printStackTrace();
        }
    }
}

                                                  

import .FastcacheApi;

public class FastcacheApiExample {

    public static void main(String[] args) {
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.createIndex(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#createIndex");
            e.printStackTrace();
        }
    }
}

                                                  


CacheMetadataOperation *body = ; // Cache Metadeta Operation
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)

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

// Create Index
[apiInstance createIndexWith:body
    authorization:authorization
    apiVersion:apiVersion
              completionHandler: ^(ResponseFS output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .FastcacheApi()

var body = ; // {CacheMetadataOperation} Cache Metadeta Operation

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class createIndexExample
    {
        public void main()
        {
            
            var apiInstance = new FastcacheApi();
            var body = new CacheMetadataOperation(); // CacheMetadataOperation | Cache Metadeta Operation
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)

            try
            {
                // Create Index
                ResponseFS result = apiInstance.createIndex(body, authorization, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FastcacheApi.createIndex: " + e.Message );
            }
        }
    }
}

                                                    

createIndex($body, $authorization, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FastcacheApi->createIndex: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 500 - Invalid Request


dropIndex

Drop Index

Delete a cache index at run time when golden record cache is defined and started.


/fastcache/metadata/dropIndex

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/fastcache/metadata/dropIndex"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .FastcacheApi;

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

public class FastcacheApiExample {

    public static void main(String[] args) {
        
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.dropIndex(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#dropIndex");
            e.printStackTrace();
        }
    }
}

                                                  

import .FastcacheApi;

public class FastcacheApiExample {

    public static void main(String[] args) {
        FastcacheApi apiInstance = new FastcacheApi();
        CacheMetadataOperation body = ; // CacheMetadataOperation | Cache Metadeta Operation
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            ResponseFS result = apiInstance.dropIndex(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#dropIndex");
            e.printStackTrace();
        }
    }
}

                                                  


CacheMetadataOperation *body = ; // Cache Metadeta Operation
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)

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

// Drop Index
[apiInstance dropIndexWith:body
    authorization:authorization
    apiVersion:apiVersion
              completionHandler: ^(ResponseFS output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .FastcacheApi()

var body = ; // {CacheMetadataOperation} Cache Metadeta Operation

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class dropIndexExample
    {
        public void main()
        {
            
            var apiInstance = new FastcacheApi();
            var body = new CacheMetadataOperation(); // CacheMetadataOperation | Cache Metadeta Operation
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)

            try
            {
                // Drop Index
                ResponseFS result = apiInstance.dropIndex(body, authorization, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FastcacheApi.dropIndex: " + e.Message );
            }
        }
    }
}

                                                    

dropIndex($body, $authorization, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FastcacheApi->dropIndex: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 500 - Invalid Request


searchRecords

Search records in golden record cache.


/fastcache/records/search

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/fastcache/records/search"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .FastcacheApi;

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

public class FastcacheApiExample {

    public static void main(String[] args) {
        
        FastcacheApi apiInstance = new FastcacheApi();
        RecordSearchCriteria body = ; // RecordSearchCriteria | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            RecordListFC result = apiInstance.searchRecordsInGoldenRecordCache(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#searchRecordsInGoldenRecordCache");
            e.printStackTrace();
        }
    }
}

                                                  

import .FastcacheApi;

public class FastcacheApiExample {

    public static void main(String[] args) {
        FastcacheApi apiInstance = new FastcacheApi();
        RecordSearchCriteria body = ; // RecordSearchCriteria | Record Search Criteria JSON Object
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        try {
            RecordListFC result = apiInstance.searchRecordsInGoldenRecordCache(body, authorization, apiVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#searchRecordsInGoldenRecordCache");
            e.printStackTrace();
        }
    }
}

                                                  


RecordSearchCriteria *body = ; // Record Search Criteria JSON Object
String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)

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

// Search records in golden record cache.
[apiInstance searchRecordsInGoldenRecordCacheWith:body
    authorization:authorization
    apiVersion:apiVersion
              completionHandler: ^(RecordListFC output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .FastcacheApi()

var body = ; // {RecordSearchCriteria} Record Search Criteria JSON Object

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)


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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class searchRecordsInGoldenRecordCacheExample
    {
        public void main()
        {
            
            var apiInstance = new FastcacheApi();
            var body = new RecordSearchCriteria(); // RecordSearchCriteria | Record Search Criteria JSON Object
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)

            try
            {
                // Search records in golden record cache.
                RecordListFC result = apiInstance.searchRecordsInGoldenRecordCache(body, authorization, apiVersion);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FastcacheApi.searchRecordsInGoldenRecordCache: " + e.Message );
            }
        }
    }
}

                                                    

searchRecordsInGoldenRecordCache($body, $authorization, $apiVersion);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FastcacheApi->searchRecordsInGoldenRecordCache: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 404 - Record not found

Status: 500 - Invalid Request


updateValue

Update Value of Custom Attribute

Update the value of user-defined attributes at run time when golden record cache is defined and running.


/fastcache/record/update

Usage and SDK Samples


curl -X post "http://hostname:8080/eml/rest/fastcache/record/update"



import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import .FastcacheApi;

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

public class FastcacheApiExample {

    public static void main(String[] args) {
        
        FastcacheApi apiInstance = new FastcacheApi();
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        CacheRecordOperation body = ; // CacheRecordOperation | Cache Metadeta Operation
        try {
            ResponseFS result = apiInstance.updateValue(authorization, apiVersion, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#updateValue");
            e.printStackTrace();
        }
    }
}

                                                  

import .FastcacheApi;

public class FastcacheApiExample {

    public static void main(String[] args) {
        FastcacheApi apiInstance = new FastcacheApi();
        String authorization = authorization_example; // String | Authorization String
        String apiVersion = apiVersion_example; // String | 1.0(Default) OR 2.0(Latest)
        CacheRecordOperation body = ; // CacheRecordOperation | Cache Metadeta Operation
        try {
            ResponseFS result = apiInstance.updateValue(authorization, apiVersion, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FastcacheApi#updateValue");
            e.printStackTrace();
        }
    }
}

                                                  


String *authorization = authorization_example; // Authorization String
String *apiVersion = apiVersion_example; // 1.0(Default) OR 2.0(Latest)
CacheRecordOperation *body = ; // Cache Metadeta Operation (optional)

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

// Update Value of Custom Attribute
[apiInstance updateValueWith:authorization
    apiVersion:apiVersion
    body:body
              completionHandler: ^(ResponseFS output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .FastcacheApi()

var authorization = authorization_example; // {String} Authorization String

var apiVersion = apiVersion_example; // {String} 1.0(Default) OR 2.0(Latest)

var opts = { 
  'body':  // {CacheRecordOperation} Cache Metadeta Operation
};

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

                                                    

using System;
using System.Diagnostics;
using .Api;
using .Client;
using ;

namespace Example
{
    public class updateValueExample
    {
        public void main()
        {
            
            var apiInstance = new FastcacheApi();
            var authorization = authorization_example;  // String | Authorization String
            var apiVersion = apiVersion_example;  // String | 1.0(Default) OR 2.0(Latest)
            var body = new CacheRecordOperation(); // CacheRecordOperation | Cache Metadeta Operation (optional) 

            try
            {
                // Update Value of Custom Attribute
                ResponseFS result = apiInstance.updateValue(authorization, apiVersion, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling FastcacheApi.updateValue: " + e.Message );
            }
        }
    }
}

                                                    

updateValue($authorization, $apiVersion, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FastcacheApi->updateValue: ', $e->getMessage(), PHP_EOL;
}

                                                  

Parameters

Header parameters
Name Description
authorization*
apiVersion*
Body parameters
Name Description
body

Responses

Status: 200 - successful operation

Status: 400 - Parameters required are missing

Status: 500 - Invalid Request


Generated 2017-07-28T08:35:32.754Z