factern-java-client

For more information, please visit https://next.factern.com/company/contact

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.factern</groupId>
  <artifactId>factern-java-client</artifactId>
  <version>1.0.58</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.factern:factern-java-client:1.0.58"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/factern-java-client-1.0.SNAPSHOT.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.factern.*;
import com.factern.auth.*;
import com.factern.model.*;
import com.factern.api.FactsApi;

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

public class FactsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure OAuth2 access token for authorization: OAuth2
        OAuth OAuth2 = (OAuth) defaultClient.getAuthentication("OAuth2");
        OAuth2.setAccessToken("YOUR ACCESS TOKEN");

        FactsApi apiInstance = new FactsApi();
        String login = "login_example"; // String | 
        String representing = "representing_example"; // String | 
        CreateMemberRequest createMemberRequest = new CreateMemberRequest(); // CreateMemberRequest | 
        try {
            CreateMemberResponse result = apiInstance.addMember(login, representing, createMemberRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FactsApi#addMember");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FactsApi	addMember	POST /createmember	Create Member
FactsApi	bid	POST /createbid	Create Bid
FactsApi	createAlias	POST /createalias	Create Alias
FactsApi	createApplication	POST /createapplication	Create Application
FactsApi	createDomain	POST /createdomain	Create Domain
FactsApi	createEntity	POST /createentity	Create Entity
FactsApi	createField	POST /createfield	Create Field
FactsApi	createFilter	POST /createfilter	Create Filter
FactsApi	createGroup	POST /creategroup	Create Group
FactsApi	createInformation	POST /createinformation	Create Information
FactsApi	createInterface	POST /createinterface	Create Interface
FactsApi	createLabelList	POST /createlabellist	Create Label List
FactsApi	createLogin	POST /createlogin	Create Login
FactsApi	createMirror	POST /createmirror	Create Mirror
FactsApi	createPrice	POST /createprice	Create Price
FactsApi	createScope	POST /createscope	Create Scope
FactsApi	createStatement	POST /createstatement	Create Statement
FactsApi	createTemplate	POST /createtemplate	Create Template
FactsApi	delete	POST /delete	Deleting
FactsApi	deleteNode	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	readInformation	POST /readinformation	Read Information
FactsApi	replaceInformation	POST /replaceinformation	Replace
FactsApi	requestPermission	POST /requestpermission	Request Permission
FactsApi	resetLogin	POST /resetlogin	Changing Login Password
FactsApi	searchAlias	POST /searchalias	Search For Alias
FactsApi	searchEntity	POST /searchentity	Search For Entity
FactsApi	settleAccount	POST /settleaccount	Settle Account
FactsApi	updateApplication	POST /updateapplication	Resetting Application Secret
FactsApi	updateStatus	POST /updatestatus	Enabling/Disabling Nodes
FactsApi	watch	POST /watch	Create Watch Trigger
FactsApi	write	POST /write	Writing by Template

Documentation for Models

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

Documentation for Authorization

Authentication schemes defined for the API:

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

mailto:support@factern.com