@factern/factern-client

Python Client for Factern API v2

• API version: 2.0.0
• Package version: 1.0.5 For more information, please visit https://next.factern.com/company/contact

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

The python package is hosted on pypi, you can install directly from command line

pip install factern_client

(you may need to run pip with root permission: sudo pip install factern_client)

Then import the package:

import factern_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import factern_client

Getting Started

Please follow the installation procedure and then run the following:

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)

Documentation for API Endpoints

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

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

Documentation For Models

• Account
• Agent
• AliasNode
• ApiEndpoint
• ApplicationNode
• BaseRequest
• BaseResponse
• BidNode
• Cost
• DeleteResponse
• DeletedItem
• DeletedStatusItem
• DescribeResponse
• DomainNode
• EntityListResponse
• EntityNode
• ExternalDataUsage
• FactCount
• FieldNode
• FieldStoreValues
• FilterNode
• FilterStatement
• GasCost
• GroupNode
• HttpHeader
• InformationListResponse
• InformationNode
• InterfaceNode
• LabelListMemberNode
• LabelListNode
• LabelStatement
• ListCriteria
• LoginNode
• MemberNode
• MirrorNode
• NamedNode
• NodeListing
• PermissionAction
• PermissionEffect
• PermissionNode
• PermissionPolicyDocument
• PriceDetails
• PriceNode
• ReadInformationResponse
• ReadItem
• ReadResponse
• ReadStatusItem
• ScopeNode
• SearchAliasResponse
• Searches
• SettleAccountResponse
• StandardNode
• StandardNodeResponse
• StatementStatement
• Summary
• TemplateNode
• TokenPayment
• TransformElement
• WatchEventNode
• WatchNode
• WriteItem
• WriteResponse
• AddLabelRequest
• AddLabelResponse
• AddStatementRequest
• AddStatementResponse
• Alias
• Application
• Bid
• CreateAliasRequest
• CreateAliasResponse
• CreateApplicationResponse
• CreateBidRequest
• CreateBidResponse
• CreateChildRequest
• CreateDomainResponse
• CreateEntityResponse
• CreateFieldResponse
• CreateFilterResponse
• CreateGroupResponse
• CreateInformationResponse
• CreateInterfaceResponse
• CreateLabelListResponse
• CreateLoginRequest
• CreateLoginResponse
• CreateMemberResponse
• CreateMirrorRequest
• CreateMirrorResponse
• CreatePermissionRequest
• CreatePermissionResponse
• CreatePriceRequest
• CreatePriceResponse
• CreateScopeResponse
• CreateTemplateResponse
• CreateWatchRequest
• CreateWatchResponse
• DeleteRequest
• DescribeRequest
• Domain
• Entity
• Field
• Filter
• Group
• Information
• Interface
• Label
• LabelList
• LabelListMember
• Login
• Member
• Mirror
• NodeIdRequest
• Permission
• Price
• ReadInformationRequest
• ReadRequest
• ReplaceFieldRequest
• ResetLoginCredentialsRequest
• ResetLoginResponse
• Scope
• SearchAliasRequest
• SearchEntityRequest
• SettleAccountRequest
• Statement
• Template
• UpdateApplicationRequest
• UpdateApplicationResponse
• Watch
• WatchEvent
• WriteRequest
• CreateInformationRequest
• CreateMemberRequest
• CreateNamedRequest
• UpdateStatusRequest
• CreateApplicationRequest
• CreateDomainRequest
• CreateEntityRequest
• CreateFieldRequest
• CreateFilterRequest
• CreateGroupRequest
• CreateInterfaceRequest
• CreateLabelListRequest
• CreateScopeRequest
• CreateTemplateRequest

Documentation For Authorization

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://factern-test.eu.auth0.com/oauth/token
• Scopes:
• profile: Grants read and write access to administrative information
• openid: Grants read and write access to administrative information
• email: Grants read and write access to administrative information
• phone: Grants write access
• address: Grants read access

Author

Factern Ltd. mailto:support@factern.com