Social Graph API

Default

addAttribute

updates (or creates) an attribute

Works with all entities, including nodes and edges. Given its key, updates an attribute value, or creates it, if it doesn't yet exist. 


/{uuid}/attribute/{key}

Usage and SDK Samples


curl -X post "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/attribute/{key}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String value = value_example; // String | The value to update the key with.
        try {
            inline_response_200_4 result = apiInstance.addAttribute(value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#addAttribute");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String value = value_example; // String | The value to update the key with.
        try {
            inline_response_200_4 result = apiInstance.addAttribute(value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#addAttribute");
            e.printStackTrace();
        }
    }
}

                                                  


String *value = value_example; // The value to update the key with. (optional)

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

// updates (or creates) an attribute
[apiInstance addAttributeWith:value
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var opts = { 
  'value': value_example // {String} The value to update the key with.
};

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

                                                    

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

namespace Example
{
    public class addAttributeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var value = value_example;  // String | The value to update the key with. (optional) 

            try
            {
                // updates (or creates) an attribute
                inline_response_200_4 result = apiInstance.addAttribute(value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.addAttribute: " + e.Message );
            }
        }
    }
}

                                                    

addAttribute($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->addAttribute: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
value

Responses

Status: 200 - Attribute updated

delAttribute

deletes an attribute

Works with all entities, including nodes and edges. Given its key, deletes an attribute. 


/{uuid}/attribute/{key}

Usage and SDK Samples


curl -X delete "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/attribute/{key}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.delAttribute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#delAttribute");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_4 result = apiInstance.delAttribute();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#delAttribute");
            e.printStackTrace();
        }
    }
}

                                                  



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

// deletes an attribute
[apiInstance delAttributeWithCompletionHandler: 
              ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

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

                                                    

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

namespace Example
{
    public class delAttributeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // deletes an attribute
                inline_response_200_4 result = apiInstance.delAttribute();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.delAttribute: " + e.Message );
            }
        }
    }
}

                                                    

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

Parameters

Responses

Status: 200 - Attribute deleted.

Status: 500 - Failure. If the attribute does not exist.

delEntity

deletes an entity

Works with all entities, including nodes and edges. 


/{uuid}

Usage and SDK Samples


curl -X delete "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.delEntity();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#delEntity");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            apiInstance.delEntity();
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#delEntity");
            e.printStackTrace();
        }
    }
}

                                                  



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

// deletes an entity
[apiInstance delEntityWithCompletionHandler: 
              ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.delEntity(callback);

                                                    

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

namespace Example
{
    public class delEntityExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // deletes an entity
                apiInstance.delEntity();
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.delEntity: " + e.Message );
            }
        }
    }
}

                                                    

delEntity();
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->delEntity: ', $e->getMessage(), PHP_EOL;
}

Parameters

Responses

Status: 200 - Success.

Status: 500 - Failure. The entity (node/edge) does not exist or there was a problem deleting.

getAllEdges

retrieves the edges of a node

By passing in a node ID, you can fetch all the edges of the node in question; including incoming and outgoing. 


/{uuid}/edges/all

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/edges/all"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            inline_response_200_3 result = apiInstance.getAllEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllEdges");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            inline_response_200_3 result = apiInstance.getAllEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAllEdges");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID

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

// retrieves the edges of a node
[apiInstance getAllEdgesWith:uuid
              completionHandler: ^(inline_response_200_3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID


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

                                                    

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

namespace Example
{
    public class getAllEdgesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID

            try
            {
                // retrieves the edges of a node
                inline_response_200_3 result = apiInstance.getAllEdges(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAllEdges: " + e.Message );
            }
        }
    }
}

                                                    

getAllEdges($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAllEdges: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - search results matching criteria

Status: 500 - Failure.

getAttribute

retrieves the value of an entity attribute

Attribute key must be case-sensitive. 


/{uuid}/attribute/{key}

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/attribute/{key}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        String key = key_example; // String | The attribute key
        try {
            'String' result = apiInstance.getAttribute(uuid, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAttribute");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        String key = key_example; // String | The attribute key
        try {
            'String' result = apiInstance.getAttribute(uuid, key);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAttribute");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID
String *key = key_example; // The attribute key

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

// retrieves the value of an entity attribute
[apiInstance getAttributeWith:uuid
    key:key
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID

var key = key_example; // {String} The attribute key


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

                                                    

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

namespace Example
{
    public class getAttributeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID
            var key = key_example;  // String | The attribute key

            try
            {
                // retrieves the value of an entity attribute
                'String' result = apiInstance.getAttribute(uuid, key);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAttribute: " + e.Message );
            }
        }
    }
}

                                                    

getAttribute($uuid, $key);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAttribute: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*
key*

Responses

Status: 200 - The attribute's value or nil if the attribute does not exist.

getAttributes

retrieves the existing attribute keys of an entity (edge or node)

Attribute keys are case-sensitive, and they will be listed in an array. 


/{uuid}/attributes

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/attributes"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getAttributes(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAttributes");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getAttributes(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getAttributes");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID

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

// retrieves the existing attribute keys of an entity (edge or node)
[apiInstance getAttributesWith:uuid
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID


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

                                                    

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

namespace Example
{
    public class getAttributesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID

            try
            {
                // retrieves the existing attribute keys of an entity (edge or node)
                array['String'] result = apiInstance.getAttributes(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getAttributes: " + e.Message );
            }
        }
    }
}

                                                    

getAttributes($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAttributes: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - Attribute keys

Status: 400 - bad input parameter

getEdge

retrieves an edge

By passing in an ID, you can search for available edges in the system. 


/edge/{uuid}

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/edge/{uuid}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The edge ID
        try {
            Edge result = apiInstance.getEdge(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdge");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The edge ID
        try {
            Edge result = apiInstance.getEdge(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdge");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The edge ID

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

// retrieves an edge
[apiInstance getEdgeWith:uuid
              completionHandler: ^(Edge output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The edge ID


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

                                                    

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

namespace Example
{
    public class getEdgeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The edge ID

            try
            {
                // retrieves an edge
                Edge result = apiInstance.getEdge(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getEdge: " + e.Message );
            }
        }
    }
}

                                                    

getEdge($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEdge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - Edge with given ID

Status: 500 - Failure. Either the edge does not exist or it's not an edge.

getEdgeGetters

retrieves the edge getter methods of a node

By passing in a node UUID that exists in the database, you can fetch the edge getter methods of the node in question. 


/{uuid}/edges/getters

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/edges/getters"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getEdgeGetters(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdgeGetters");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getEdgeGetters(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdgeGetters");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID

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

// retrieves the edge getter methods of a node
[apiInstance getEdgeGettersWith:uuid
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID


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

                                                    

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

namespace Example
{
    public class getEdgeGettersExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID

            try
            {
                // retrieves the edge getter methods of a node
                array['String'] result = apiInstance.getEdgeGetters(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getEdgeGetters: " + e.Message );
            }
        }
    }
}

                                                    

getEdgeGetters($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEdgeGetters: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - search results matching criteria

Status: 500 - Failure. Either the node does not exist or the entity is not a node.

getEdgeSetters

retrieves the edge setter methods of a node

By passing in a node UUID that exists in the database, you can fetch the edge setter methods of the node in question. These setters may or may not be formative. If they are formative, a new node is created in result. 


/{uuid}/edges/setters

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/edges/setters"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getEdgeSetters(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdgeSetters");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            array['String'] result = apiInstance.getEdgeSetters(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getEdgeSetters");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID

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

// retrieves the edge setter methods of a node
[apiInstance getEdgeSettersWith:uuid
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID


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

                                                    

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

namespace Example
{
    public class getEdgeSettersExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID

            try
            {
                // retrieves the edge setter methods of a node
                array['String'] result = apiInstance.getEdgeSetters(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getEdgeSetters: " + e.Message );
            }
        }
    }
}

                                                    

getEdgeSetters($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getEdgeSetters: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - search results matching criteria

Status: 500 - Failure. Either the node does not exist or the entity is not a node.

getFounder

retrieves the Graph Founder

The Founder must be a \Pho\Framework\Actor object. This method returns the object type as well as object ID. 


/founder

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/founder"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200 result = apiInstance.getFounder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFounder");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200 result = apiInstance.getFounder();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getFounder");
            e.printStackTrace();
        }
    }
}

                                                  



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

// retrieves the Graph Founder
[apiInstance getFounderWithCompletionHandler: 
              ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

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

                                                    

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

namespace Example
{
    public class getFounderExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // retrieves the Graph Founder
                inline_response_200 result = apiInstance.getFounder();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getFounder: " + e.Message );
            }
        }
    }
}

                                                    

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

Parameters

Responses

Status: 200 - The Founder has been located.

getGraph

retrieves the main Graph

The Graph must be a \Pho\Lib\Graph\SubGraph and \Pho\Framework\Graph object. This method returns the object type as well as object ID. The Graph contains all nodes and edges in the system. Though it is contained by Space, its one and only container. 


/graph

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/graph"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_1 result = apiInstance.getGraph();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getGraph");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_1 result = apiInstance.getGraph();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getGraph");
            e.printStackTrace();
        }
    }
}

                                                  



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

// retrieves the main Graph
[apiInstance getGraphWithCompletionHandler: 
              ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

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

                                                    

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

namespace Example
{
    public class getGraphExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // retrieves the main Graph
                inline_response_200_1 result = apiInstance.getGraph();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getGraph: " + e.Message );
            }
        }
    }
}

                                                    

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

Parameters

Responses

Status: 200 - The Graph has been located.

getIncomingEdges

retrieves the incoming edges of a node

By passing in a node ID, you can fetch the incoming edges of the node in question. 


/{uuid}/edges/in

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/edges/in"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node ID
        try {
            array[NodeEdge] result = apiInstance.getIncomingEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getIncomingEdges");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node ID
        try {
            array[NodeEdge] result = apiInstance.getIncomingEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getIncomingEdges");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // the node ID

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

// retrieves the incoming edges of a node
[apiInstance getIncomingEdgesWith:uuid
              completionHandler: ^(array[NodeEdge] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} the node ID


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

                                                    

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

namespace Example
{
    public class getIncomingEdgesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | the node ID

            try
            {
                // retrieves the incoming edges of a node
                array[NodeEdge] result = apiInstance.getIncomingEdges(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getIncomingEdges: " + e.Message );
            }
        }
    }
}

                                                    

getIncomingEdges($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getIncomingEdges: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - The incoming edges.

Status: 500 - Failure.

getNode

retrieves a node

By passing in an ID, you can search for available nodes in the system. Please note, this function will not return edges. This method is reserved for nodes only. 


/{uuid}

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            Node result = apiInstance.getNode(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getNode");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        try {
            Node result = apiInstance.getNode(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getNode");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID

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

// retrieves a node
[apiInstance getNodeWith:uuid
              completionHandler: ^(Node output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID


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

                                                    

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

namespace Example
{
    public class getNodeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID

            try
            {
                // retrieves a node
                Node result = apiInstance.getNode(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getNode: " + e.Message );
            }
        }
    }
}

                                                    

getNode($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNode: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - Node with given ID

Status: 500 - Failure. Either the node does not exist or it's not a node.

getNodeEdge

edge getter

Fetches edge results, whether as edge IDs or node IDs, depending on edge's characteristics. 


/{uuid}/{edge}

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/{edge}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        String edge = edge_example; // String | The edge getter label
        try {
            array['String'] result = apiInstance.getNodeEdge(uuid, edge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getNodeEdge");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | The node ID
        String edge = edge_example; // String | The edge getter label
        try {
            array['String'] result = apiInstance.getNodeEdge(uuid, edge);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getNodeEdge");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // The node ID
String *edge = edge_example; // The edge getter label

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

// edge getter
[apiInstance getNodeEdgeWith:uuid
    edge:edge
              completionHandler: ^(array['String'] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} The node ID

var edge = edge_example; // {String} The edge getter label


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

                                                    

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

namespace Example
{
    public class getNodeEdgeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | The node ID
            var edge = edge_example;  // String | The edge getter label

            try
            {
                // edge getter
                array['String'] result = apiInstance.getNodeEdge(uuid, edge);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getNodeEdge: " + e.Message );
            }
        }
    }
}

                                                    

getNodeEdge($uuid, $edge);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getNodeEdge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*
edge*

Responses

Status: 200 - Result ID(s)

Status: 500 - Failure.

getOutgoingEdges

retrieves the outgoing edges of a node

By passing in a node ID, you can fetch the outgoing edges of the node in question. 


/{uuid}/edges/out

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/edges/out"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node ID
        try {
            array[NodeEdge] result = apiInstance.getOutgoingEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getOutgoingEdges");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node ID
        try {
            array[NodeEdge] result = apiInstance.getOutgoingEdges(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getOutgoingEdges");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // the node ID

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

// retrieves the outgoing edges of a node
[apiInstance getOutgoingEdgesWith:uuid
              completionHandler: ^(array[NodeEdge] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} the node ID


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

                                                    

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

namespace Example
{
    public class getOutgoingEdgesExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | the node ID

            try
            {
                // retrieves the outgoing edges of a node
                array[NodeEdge] result = apiInstance.getOutgoingEdges(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getOutgoingEdges: " + e.Message );
            }
        }
    }
}

                                                    

getOutgoingEdges($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getOutgoingEdges: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - The outgoing edges.

Status: 500 - Failure.

getSpace

retrieves the Space

The Space must be a \Pho\Lib\Graph\Graph object. This method returns the object type as well as object uuid. Space always comes with the nil ID; 00000000000000000000000000000000, and under normal circumstances its class is always Pho\Kernel\Standards\Space 


/space

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/space"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_2 result = apiInstance.getSpace();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getSpace");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        try {
            inline_response_200_2 result = apiInstance.getSpace();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getSpace");
            e.printStackTrace();
        }
    }
}

                                                  



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

// retrieves the Space
[apiInstance getSpaceWithCompletionHandler: 
              ^(inline_response_200_2 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

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

                                                    

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

namespace Example
{
    public class getSpaceExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();

            try
            {
                // retrieves the Space
                inline_response_200_2 result = apiInstance.getSpace();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getSpace: " + e.Message );
            }
        }
    }
}

                                                    

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

Parameters

Responses

Status: 200 - The space has been located.

getType

fetches entity type

Possible values are; "Space", "Node", "Graph Node", "Graph", "Actor Node" "Object Node", "Edge", "Read Edge", "Write Edge", "Subscribe Edge", "Mention Edge", "Unidentified". 


/{uuid}/type

Usage and SDK Samples


curl -X get "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/type"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node
        try {
            'String' result = apiInstance.getType(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getType");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String uuid = uuid_example; // String | the node
        try {
            'String' result = apiInstance.getType(uuid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#getType");
            e.printStackTrace();
        }
    }
}

                                                  


String *uuid = uuid_example; // the node

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

// fetches entity type
[apiInstance getTypeWith:uuid
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var uuid = uuid_example; // {String} the node


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

                                                    

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

namespace Example
{
    public class getTypeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var uuid = uuid_example;  // String | the node

            try
            {
                // fetches entity type
                'String' result = apiInstance.getType(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.getType: " + e.Message );
            }
        }
    }
}

                                                    

getType($uuid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getType: ', $e->getMessage(), PHP_EOL;
}

Parameters

Path parameters
Name Description
uuid*

Responses

Status: 200 - Entity Type

makeActor

creates an Actor object

Fetches whatever set as "default_object"=>"actor" while determining what Actor object to construct. If it doesn't exist, uses "default_object"=>"founder" class. Otherwise fails. 


/actor

Usage and SDK Samples


curl -X post "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/actor"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String param1 = param1_example; // String | Actor constructor argument. More parameters may be passed
via param2, param3 ... param50.

        try {
            UUID result = apiInstance.makeActor(param1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#makeActor");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String param1 = param1_example; // String | Actor constructor argument. More parameters may be passed
via param2, param3 ... param50.

        try {
            UUID result = apiInstance.makeActor(param1);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#makeActor");
            e.printStackTrace();
        }
    }
}

                                                  


String *param1 = param1_example; // Actor constructor argument. More parameters may be passed
via param2, param3 ... param50.
 (optional)

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

// creates an Actor object
[apiInstance makeActorWith:param1
              completionHandler: ^(UUID output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var opts = { 
  'param1': param1_example // {String} Actor constructor argument. More parameters may be passed
via param2, param3 ... param50.

};

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

                                                    

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

namespace Example
{
    public class makeActorExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var param1 = param1_example;  // String | Actor constructor argument. More parameters may be passed
via param2, param3 ... param50.
 (optional) 

            try
            {
                // creates an Actor object
                UUID result = apiInstance.makeActor(param1);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.makeActor: " + e.Message );
            }
        }
    }
}

                                                    

makeActor($param1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->makeActor: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
param1

Responses

Status: 200 - Returns the ID of the created Actor object.

Status: 500 - Failure.

makeEdge

creates an edge

Used to set new edges. If the edge is formative, then a node is also formed. 


/{uuid}/{edge}

Usage and SDK Samples


curl -X post "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/{edge}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String param1 = param1_example; // String | The value to update the key with. There can be
50 of those. For example;  param1="value1",
param2 ="another value" depending on the edge's
default constructor variable count.

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

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String param1 = param1_example; // String | The value to update the key with. There can be
50 of those. For example;  param1="value1",
param2 ="another value" depending on the edge's
default constructor variable count.

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

                                                  


String *param1 = param1_example; // The value to update the key with. There can be
50 of those. For example;  param1="value1",
param2 ="another value" depending on the edge's
default constructor variable count.
 (optional)

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

// creates an edge
[apiInstance makeEdgeWith:param1
              completionHandler: ^('String' output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var opts = { 
  'param1': param1_example // {String} The value to update the key with. There can be
50 of those. For example;  param1="value1",
param2 ="another value" depending on the edge's
default constructor variable count.

};

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

                                                    

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

namespace Example
{
    public class makeEdgeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var param1 = param1_example;  // String | The value to update the key with. There can be
50 of those. For example;  param1="value1",
param2 ="another value" depending on the edge's
default constructor variable count.
 (optional) 

            try
            {
                // creates an edge
                'String' result = apiInstance.makeEdge(param1);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.makeEdge: " + e.Message );
            }
        }
    }
}

                                                    

makeEdge($param1);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->makeEdge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
param1

Responses

Status: 200 - Result ID

Status: 500 - Failure.

setAttribute

updates (or creates) an attribute

Works with all entities, including nodes and edges. Given its key, updates an attribute value, or creates it, if it doesn't yet exist. 


/{uuid}/attribute/{key}

Usage and SDK Samples


curl -X put "https://virtserver.swaggerhub.com/phonetworks/server-rest/1.1.0/{uuid}/attribute/{key}"




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

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

public class DefaultApiExample {

    public static void main(String[] args) {
        
        DefaultApi apiInstance = new DefaultApi();
        String value = value_example; // String | The value to update the key with.
        try {
            inline_response_200_4 result = apiInstance.setAttribute(value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#setAttribute");
            e.printStackTrace();
        }
    }
}

                                                  

import .DefaultApi;

public class DefaultApiExample {

    public static void main(String[] args) {
        DefaultApi apiInstance = new DefaultApi();
        String value = value_example; // String | The value to update the key with.
        try {
            inline_response_200_4 result = apiInstance.setAttribute(value);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#setAttribute");
            e.printStackTrace();
        }
    }
}

                                                  


String *value = value_example; // The value to update the key with. (optional)

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

// updates (or creates) an attribute
[apiInstance setAttributeWith:value
              completionHandler: ^(inline_response_200_4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];

                                                    

var  = require('');

var api = new .DefaultApi()

var opts = { 
  'value': value_example // {String} The value to update the key with.
};

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

                                                    

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

namespace Example
{
    public class setAttributeExample
    {
        public void main()
        {
            
            var apiInstance = new DefaultApi();
            var value = value_example;  // String | The value to update the key with. (optional) 

            try
            {
                // updates (or creates) an attribute
                inline_response_200_4 result = apiInstance.setAttribute(value);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DefaultApi.setAttribute: " + e.Message );
            }
        }
    }
}

                                                    

setAttribute($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->setAttribute: ', $e->getMessage(), PHP_EOL;
}

Parameters

Body parameters
Name Description
value

Responses

Status: 200 - Attribute updated

Generated 2017-09-04T12:06:30.377Z