Skip to content

Latest commit

 

History

History
2043 lines (1484 loc) · 62 KB

File metadata and controls

2043 lines (1484 loc) · 62 KB

factern_client.FactsApi

All URIs are relative to https://api.factern.com/v2

Method HTTP request Description
add_member POST /createmember Create Member
bid POST /createbid Create Bid
create_alias POST /createalias Create Alias
create_application POST /createapplication Create Application
create_domain POST /createdomain Create Domain
create_entity POST /createentity Create Entity
create_field POST /createfield Create Field
create_filter POST /createfilter Create Filter
create_group POST /creategroup Create Group
create_information POST /createinformation Create Information
create_interface POST /createinterface Create Interface
create_label_list POST /createlabellist Create Label List
create_login POST /createlogin Create Login
create_mirror POST /createmirror Create Mirror
create_price POST /createprice Create Price
create_scope POST /createscope Create Scope
create_statement POST /createstatement Create Statement
create_template POST /createtemplate Create Template
delete POST /delete Deleting
delete_node POST /deletenode Delete Node
describe POST /describe Describe
history POST /history History
label POST /label Label a Node
obliterate POST /obliterate Obliterating Information Nodes
permission POST /permission Create Permission
read POST /read Reading
read_information POST /readinformation Read Information
replace_information POST /replaceinformation Replace
request_permission POST /requestpermission Request Permission
reset_login POST /resetlogin Changing Login Password
search_alias POST /searchalias Search For Alias
search_entity POST /searchentity Search For Entity
settle_account POST /settleaccount Settle Account
update_application POST /updateapplication Resetting Application Secret
update_status POST /updatestatus Enabling/Disabling Nodes
watch POST /watch Create Watch Trigger
write POST /write Writing by Template

add_member

CreateMemberResponse add_member(body, login=login, representing=representing)

Create Member

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateMemberRequest() # CreateMemberRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Member
    api_response = api_instance.add_member(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->add_member: %s\n" % e)

Parameters

Name Type Description Notes
body CreateMemberRequest
login str [optional]
representing str [optional]

Return type

CreateMemberResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bid

StandardNodeResponse bid(body, login=login, representing=representing)

Create Bid

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateBidRequest() # CreateBidRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Bid
    api_response = api_instance.bid(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->bid: %s\n" % e)

Parameters

Name Type Description Notes
body CreateBidRequest
login str [optional]
representing str [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_alias

CreateAliasResponse create_alias(body, login=login, representing=representing)

Create Alias

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateAliasRequest() # CreateAliasRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Alias
    api_response = api_instance.create_alias(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_alias: %s\n" % e)

Parameters

Name Type Description Notes
body CreateAliasRequest
login str [optional]
representing str [optional]

Return type

CreateAliasResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_application

CreateApplicationResponse create_application(body, login=login, representing=representing)

Create Application

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateApplicationRequest() # CreateApplicationRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Application
    api_response = api_instance.create_application(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_application: %s\n" % e)

Parameters

Name Type Description Notes
body CreateApplicationRequest
login str [optional]
representing str [optional]

Return type

CreateApplicationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_domain

CreateDomainResponse create_domain(body, login=login, representing=representing)

Create Domain

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateDomainRequest() # CreateDomainRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Domain
    api_response = api_instance.create_domain(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_domain: %s\n" % e)

Parameters

Name Type Description Notes
body CreateDomainRequest
login str [optional]
representing str [optional]

Return type

CreateDomainResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_entity

CreateEntityResponse create_entity(body, login=login, representing=representing)

Create Entity

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateEntityRequest() # CreateEntityRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Entity
    api_response = api_instance.create_entity(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_entity: %s\n" % e)

Parameters

Name Type Description Notes
body CreateEntityRequest
login str [optional]
representing str [optional]

Return type

CreateEntityResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_field

CreateFieldResponse create_field(body, login=login, representing=representing)

Create Field

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateFieldRequest() # CreateFieldRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Field
    api_response = api_instance.create_field(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_field: %s\n" % e)

Parameters

Name Type Description Notes
body CreateFieldRequest
login str [optional]
representing str [optional]

Return type

CreateFieldResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_filter

CreateFilterResponse create_filter(body, login=login, representing=representing)

Create Filter

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateFilterRequest() # CreateFilterRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Filter
    api_response = api_instance.create_filter(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_filter: %s\n" % e)

Parameters

Name Type Description Notes
body CreateFilterRequest
login str [optional]
representing str [optional]

Return type

CreateFilterResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_group

CreateGroupResponse create_group(body, login=login, representing=representing)

Create Group

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateGroupRequest() # CreateGroupRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Group
    api_response = api_instance.create_group(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_group: %s\n" % e)

Parameters

Name Type Description Notes
body CreateGroupRequest
login str [optional]
representing str [optional]

Return type

CreateGroupResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_information

CreateInformationResponse create_information(body, login=login, representing=representing)

Create Information

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateInformationRequest() # CreateInformationRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Information
    api_response = api_instance.create_information(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_information: %s\n" % e)

Parameters

Name Type Description Notes
body CreateInformationRequest
login str [optional]
representing str [optional]

Return type

CreateInformationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_interface

CreateInterfaceResponse create_interface(body, login=login, representing=representing)

Create Interface

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateInterfaceRequest() # CreateInterfaceRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Interface
    api_response = api_instance.create_interface(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_interface: %s\n" % e)

Parameters

Name Type Description Notes
body CreateInterfaceRequest
login str [optional]
representing str [optional]

Return type

CreateInterfaceResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_label_list

CreateLabelListResponse create_label_list(body, login=login, representing=representing)

Create Label List

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateLabelListRequest() # CreateLabelListRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Label List
    api_response = api_instance.create_label_list(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_label_list: %s\n" % e)

Parameters

Name Type Description Notes
body CreateLabelListRequest
login str [optional]
representing str [optional]

Return type

CreateLabelListResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_login

CreateLoginResponse create_login(body, login=login, representing=representing)

Create Login

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateLoginRequest() # CreateLoginRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Login
    api_response = api_instance.create_login(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_login: %s\n" % e)

Parameters

Name Type Description Notes
body CreateLoginRequest
login str [optional]
representing str [optional]

Return type

CreateLoginResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_mirror

CreateMirrorResponse create_mirror(body, login=login, representing=representing)

Create Mirror

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateMirrorRequest() # CreateMirrorRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Mirror
    api_response = api_instance.create_mirror(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_mirror: %s\n" % e)

Parameters

Name Type Description Notes
body CreateMirrorRequest
login str [optional]
representing str [optional]

Return type

CreateMirrorResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_price

CreatePriceResponse create_price(body, login=login, representing=representing)

Create Price

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreatePriceRequest() # CreatePriceRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Price
    api_response = api_instance.create_price(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_price: %s\n" % e)

Parameters

Name Type Description Notes
body CreatePriceRequest
login str [optional]
representing str [optional]

Return type

CreatePriceResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_scope

CreateScopeResponse create_scope(body, login=login, representing=representing)

Create Scope

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateScopeRequest() # CreateScopeRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Scope
    api_response = api_instance.create_scope(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_scope: %s\n" % e)

Parameters

Name Type Description Notes
body CreateScopeRequest
login str [optional]
representing str [optional]

Return type

CreateScopeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_statement

AddStatementResponse create_statement(body, login=login, representing=representing)

Create Statement

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.AddStatementRequest() # AddStatementRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Statement
    api_response = api_instance.create_statement(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_statement: %s\n" % e)

Parameters

Name Type Description Notes
body AddStatementRequest
login str [optional]
representing str [optional]

Return type

AddStatementResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_template

CreateTemplateResponse create_template(body, login=login, representing=representing)

Create Template

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateTemplateRequest() # CreateTemplateRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Template
    api_response = api_instance.create_template(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->create_template: %s\n" % e)

Parameters

Name Type Description Notes
body CreateTemplateRequest
login str [optional]
representing str [optional]

Return type

CreateTemplateResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

DeleteResponse delete(body, login=login, representing=representing)

Deleting

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.DeleteRequest() # DeleteRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Deleting
    api_response = api_instance.delete(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
body DeleteRequest
login str [optional]
representing str [optional]

Return type

DeleteResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_node

StandardNodeResponse delete_node(body, login=login, representing=representing)

Delete Node

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.NodeIdRequest() # NodeIdRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Delete Node
    api_response = api_instance.delete_node(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->delete_node: %s\n" % e)

Parameters

Name Type Description Notes
body NodeIdRequest
login str [optional]
representing str [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

describe

DescribeResponse describe(body, login=login, representing=representing)

Describe

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.DescribeRequest() # DescribeRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Describe
    api_response = api_instance.describe(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->describe: %s\n" % e)

Parameters

Name Type Description Notes
body DescribeRequest
login str [optional]
representing str [optional]

Return type

DescribeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

history

NodeListing history(body, login=login, representing=representing)

History

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.NodeIdRequest() # NodeIdRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # History
    api_response = api_instance.history(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->history: %s\n" % e)

Parameters

Name Type Description Notes
body NodeIdRequest
login str [optional]
representing str [optional]

Return type

NodeListing

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

label

AddLabelResponse label(body, login=login, representing=representing)

Label a Node

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.AddLabelRequest() # AddLabelRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Label a Node
    api_response = api_instance.label(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->label: %s\n" % e)

Parameters

Name Type Description Notes
body AddLabelRequest
login str [optional]
representing str [optional]

Return type

AddLabelResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

obliterate

StandardNodeResponse obliterate(body, login=login, representing=representing)

Obliterating Information Nodes

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.NodeIdRequest() # NodeIdRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Obliterating Information Nodes
    api_response = api_instance.obliterate(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->obliterate: %s\n" % e)

Parameters

Name Type Description Notes
body NodeIdRequest
login str [optional]
representing str [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

permission

CreatePermissionResponse permission(body, login=login, representing=representing)

Create Permission

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreatePermissionRequest() # CreatePermissionRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Permission
    api_response = api_instance.permission(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->permission: %s\n" % e)

Parameters

Name Type Description Notes
body CreatePermissionRequest
login str [optional]
representing str [optional]

Return type

CreatePermissionResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read

ReadResponse read(body, login=login, representing=representing)

Reading

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.ReadRequest() # ReadRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Reading
    api_response = api_instance.read(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->read: %s\n" % e)

Parameters

Name Type Description Notes
body ReadRequest
login str [optional]
representing str [optional]

Return type

ReadResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

read_information

ReadInformationResponse read_information(body, login=login, representing=representing)

Read Information

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.ReadInformationRequest() # ReadInformationRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Read Information
    api_response = api_instance.read_information(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->read_information: %s\n" % e)

Parameters

Name Type Description Notes
body ReadInformationRequest
login str [optional]
representing str [optional]

Return type

ReadInformationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_information

Information replace_information(body, login=login, representing=representing)

Replace

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.ReplaceFieldRequest() # ReplaceFieldRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Replace
    api_response = api_instance.replace_information(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->replace_information: %s\n" % e)

Parameters

Name Type Description Notes
body ReplaceFieldRequest
login str [optional]
representing str [optional]

Return type

Information

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

request_permission

StandardNodeResponse request_permission(body, login=login, representing=representing)

Request Permission

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.NodeIdRequest() # NodeIdRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Request Permission
    api_response = api_instance.request_permission(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->request_permission: %s\n" % e)

Parameters

Name Type Description Notes
body NodeIdRequest
login str [optional]
representing str [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_login

ResetLoginResponse reset_login(body, login=login, representing=representing)

Changing Login Password

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.ResetLoginCredentialsRequest() # ResetLoginCredentialsRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Changing Login Password
    api_response = api_instance.reset_login(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->reset_login: %s\n" % e)

Parameters

Name Type Description Notes
body ResetLoginCredentialsRequest
login str [optional]
representing str [optional]

Return type

ResetLoginResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_alias

SearchAliasResponse search_alias(body, login=login, representing=representing)

Search For Alias

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.SearchAliasRequest() # SearchAliasRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Search For Alias
    api_response = api_instance.search_alias(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->search_alias: %s\n" % e)

Parameters

Name Type Description Notes
body SearchAliasRequest
login str [optional]
representing str [optional]

Return type

SearchAliasResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

search_entity

EntityListResponse search_entity(body, login=login, representing=representing)

Search For Entity

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.SearchEntityRequest() # SearchEntityRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Search For Entity
    api_response = api_instance.search_entity(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->search_entity: %s\n" % e)

Parameters

Name Type Description Notes
body SearchEntityRequest
login str [optional]
representing str [optional]

Return type

EntityListResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

settle_account

SettleAccountResponse settle_account(body, login=login, representing=representing)

Settle Account

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.SettleAccountRequest() # SettleAccountRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Settle Account
    api_response = api_instance.settle_account(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->settle_account: %s\n" % e)

Parameters

Name Type Description Notes
body SettleAccountRequest
login str [optional]
representing str [optional]

Return type

SettleAccountResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_application

UpdateApplicationResponse update_application(body, login=login, representing=representing)

Resetting Application Secret

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.UpdateApplicationRequest() # UpdateApplicationRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Resetting Application Secret
    api_response = api_instance.update_application(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->update_application: %s\n" % e)

Parameters

Name Type Description Notes
body UpdateApplicationRequest
login str [optional]
representing str [optional]

Return type

UpdateApplicationResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_status

StandardNodeResponse update_status(body, login=login, representing=representing)

Enabling/Disabling Nodes

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.UpdateStatusRequest() # UpdateStatusRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Enabling/Disabling Nodes
    api_response = api_instance.update_status(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->update_status: %s\n" % e)

Parameters

Name Type Description Notes
body UpdateStatusRequest
login str [optional]
representing str [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

watch

CreateWatchResponse watch(body, login=login, representing=representing)

Create Watch Trigger

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.CreateWatchRequest() # CreateWatchRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Create Watch Trigger
    api_response = api_instance.watch(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->watch: %s\n" % e)

Parameters

Name Type Description Notes
body CreateWatchRequest
login str [optional]
representing str [optional]

Return type

CreateWatchResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

write

WriteResponse write(body, login=login, representing=representing)

Writing by Template

Example

from __future__ import print_function
import time
import factern_client
from factern_client.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: OAuth2
configuration = factern_client.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = factern_client.FactsApi(factern_client.ApiClient(configuration))
body = factern_client.WriteRequest() # WriteRequest | 
login = 'login_example' # str |  (optional)
representing = 'representing_example' # str |  (optional)

try:
    # Writing by Template
    api_response = api_instance.write(body, login=login, representing=representing)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FactsApi->write: %s\n" % e)

Parameters

Name Type Description Notes
body WriteRequest
login str [optional]
representing str [optional]

Return type

WriteResponse

Authorization

OAuth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]