Skip to content

FactsApi.md

Latest commit

 

History

History
2080 lines (1558 loc) · 60.6 KB

FactsApi.md

File metadata and controls

2080 lines (1558 loc) · 60.6 KB

FactsApi

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

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

addMember

CreateMemberResponse addMember(login, representing, createMemberRequest)

Create Member

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createMemberRequest CreateMemberRequest [optional]

Return type

CreateMemberResponse

Authorization

OAuth2

HTTP request headers

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

bid

StandardNodeResponse bid(login, representing, createBidRequest)

Create Bid

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateBidRequest createBidRequest = new CreateBidRequest(); // CreateBidRequest | 
try {
    StandardNodeResponse result = apiInstance.bid(login, representing, createBidRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#bid");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createBidRequest CreateBidRequest [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

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

createAlias

CreateAliasResponse createAlias(login, representing, createAliasRequest)

Create Alias

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateAliasRequest createAliasRequest = new CreateAliasRequest(); // CreateAliasRequest | 
try {
    CreateAliasResponse result = apiInstance.createAlias(login, representing, createAliasRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createAlias");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createAliasRequest CreateAliasRequest [optional]

Return type

CreateAliasResponse

Authorization

OAuth2

HTTP request headers

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

createApplication

CreateApplicationResponse createApplication(login, representing, createApplicationRequest)

Create Application

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateApplicationRequest createApplicationRequest = new CreateApplicationRequest(); // CreateApplicationRequest | 
try {
    CreateApplicationResponse result = apiInstance.createApplication(login, representing, createApplicationRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createApplication");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createApplicationRequest CreateApplicationRequest [optional]

Return type

CreateApplicationResponse

Authorization

OAuth2

HTTP request headers

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

createDomain

CreateDomainResponse createDomain(login, representing, createDomainRequest)

Create Domain

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateDomainRequest createDomainRequest = new CreateDomainRequest(); // CreateDomainRequest | 
try {
    CreateDomainResponse result = apiInstance.createDomain(login, representing, createDomainRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createDomain");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createDomainRequest CreateDomainRequest [optional]

Return type

CreateDomainResponse

Authorization

OAuth2

HTTP request headers

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

createEntity

CreateEntityResponse createEntity(login, representing, createEntityRequest)

Create Entity

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateEntityRequest createEntityRequest = new CreateEntityRequest(); // CreateEntityRequest | 
try {
    CreateEntityResponse result = apiInstance.createEntity(login, representing, createEntityRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createEntity");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createEntityRequest CreateEntityRequest [optional]

Return type

CreateEntityResponse

Authorization

OAuth2

HTTP request headers

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

createField

CreateFieldResponse createField(login, representing, createFieldRequest)

Create Field

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateFieldRequest createFieldRequest = new CreateFieldRequest(); // CreateFieldRequest | 
try {
    CreateFieldResponse result = apiInstance.createField(login, representing, createFieldRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createField");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createFieldRequest CreateFieldRequest [optional]

Return type

CreateFieldResponse

Authorization

OAuth2

HTTP request headers

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

createFilter

CreateFilterResponse createFilter(login, representing, createFilterRequest)

Create Filter

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateFilterRequest createFilterRequest = new CreateFilterRequest(); // CreateFilterRequest | 
try {
    CreateFilterResponse result = apiInstance.createFilter(login, representing, createFilterRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createFilter");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createFilterRequest CreateFilterRequest [optional]

Return type

CreateFilterResponse

Authorization

OAuth2

HTTP request headers

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

createGroup

CreateGroupResponse createGroup(login, representing, createGroupRequest)

Create Group

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateGroupRequest createGroupRequest = new CreateGroupRequest(); // CreateGroupRequest | 
try {
    CreateGroupResponse result = apiInstance.createGroup(login, representing, createGroupRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createGroupRequest CreateGroupRequest [optional]

Return type

CreateGroupResponse

Authorization

OAuth2

HTTP request headers

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

createInformation

CreateInformationResponse createInformation(login, representing, createInformationRequest)

Create Information

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateInformationRequest createInformationRequest = new CreateInformationRequest(); // CreateInformationRequest | 
try {
    CreateInformationResponse result = apiInstance.createInformation(login, representing, createInformationRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createInformation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createInformationRequest CreateInformationRequest [optional]

Return type

CreateInformationResponse

Authorization

OAuth2

HTTP request headers

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

createInterface

CreateInterfaceResponse createInterface(login, representing, createInterfaceRequest)

Create Interface

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateInterfaceRequest createInterfaceRequest = new CreateInterfaceRequest(); // CreateInterfaceRequest | 
try {
    CreateInterfaceResponse result = apiInstance.createInterface(login, representing, createInterfaceRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createInterface");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createInterfaceRequest CreateInterfaceRequest [optional]

Return type

CreateInterfaceResponse

Authorization

OAuth2

HTTP request headers

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

createLabelList

CreateLabelListResponse createLabelList(login, representing, createLabelListRequest)

Create Label List

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateLabelListRequest createLabelListRequest = new CreateLabelListRequest(); // CreateLabelListRequest | 
try {
    CreateLabelListResponse result = apiInstance.createLabelList(login, representing, createLabelListRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createLabelList");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createLabelListRequest CreateLabelListRequest [optional]

Return type

CreateLabelListResponse

Authorization

OAuth2

HTTP request headers

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

createLogin

CreateLoginResponse createLogin(login, representing, createLoginRequest)

Create Login

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateLoginRequest createLoginRequest = new CreateLoginRequest(); // CreateLoginRequest | 
try {
    CreateLoginResponse result = apiInstance.createLogin(login, representing, createLoginRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createLogin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createLoginRequest CreateLoginRequest [optional]

Return type

CreateLoginResponse

Authorization

OAuth2

HTTP request headers

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

createMirror

CreateMirrorResponse createMirror(login, representing, createMirrorRequest)

Create Mirror

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateMirrorRequest createMirrorRequest = new CreateMirrorRequest(); // CreateMirrorRequest | 
try {
    CreateMirrorResponse result = apiInstance.createMirror(login, representing, createMirrorRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createMirror");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createMirrorRequest CreateMirrorRequest [optional]

Return type

CreateMirrorResponse

Authorization

OAuth2

HTTP request headers

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

createPrice

CreatePriceResponse createPrice(login, representing, createPriceRequest)

Create Price

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreatePriceRequest createPriceRequest = new CreatePriceRequest(); // CreatePriceRequest | 
try {
    CreatePriceResponse result = apiInstance.createPrice(login, representing, createPriceRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createPrice");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createPriceRequest CreatePriceRequest [optional]

Return type

CreatePriceResponse

Authorization

OAuth2

HTTP request headers

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

createScope

CreateScopeResponse createScope(login, representing, createScopeRequest)

Create Scope

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateScopeRequest createScopeRequest = new CreateScopeRequest(); // CreateScopeRequest | 
try {
    CreateScopeResponse result = apiInstance.createScope(login, representing, createScopeRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createScope");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createScopeRequest CreateScopeRequest [optional]

Return type

CreateScopeResponse

Authorization

OAuth2

HTTP request headers

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

createStatement

AddStatementResponse createStatement(login, representing, addStatementRequest)

Create Statement

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
AddStatementRequest addStatementRequest = new AddStatementRequest(); // AddStatementRequest | 
try {
    AddStatementResponse result = apiInstance.createStatement(login, representing, addStatementRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createStatement");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
addStatementRequest AddStatementRequest [optional]

Return type

AddStatementResponse

Authorization

OAuth2

HTTP request headers

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

createTemplate

CreateTemplateResponse createTemplate(login, representing, createTemplateRequest)

Create Template

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateTemplateRequest createTemplateRequest = new CreateTemplateRequest(); // CreateTemplateRequest | 
try {
    CreateTemplateResponse result = apiInstance.createTemplate(login, representing, createTemplateRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#createTemplate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createTemplateRequest CreateTemplateRequest [optional]

Return type

CreateTemplateResponse

Authorization

OAuth2

HTTP request headers

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

delete

DeleteResponse delete(login, representing, deleteRequest)

Deleting

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
DeleteRequest deleteRequest = new DeleteRequest(); // DeleteRequest | 
try {
    DeleteResponse result = apiInstance.delete(login, representing, deleteRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#delete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
deleteRequest DeleteRequest [optional]

Return type

DeleteResponse

Authorization

OAuth2

HTTP request headers

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

deleteNode

StandardNodeResponse deleteNode(login, representing, nodeIdRequest)

Delete Node

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
NodeIdRequest nodeIdRequest = new NodeIdRequest(); // NodeIdRequest | 
try {
    StandardNodeResponse result = apiInstance.deleteNode(login, representing, nodeIdRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#deleteNode");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
nodeIdRequest NodeIdRequest [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

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

describe

DescribeResponse describe(login, representing, describeRequest)

Describe

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
DescribeRequest describeRequest = new DescribeRequest(); // DescribeRequest | 
try {
    DescribeResponse result = apiInstance.describe(login, representing, describeRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#describe");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
describeRequest DescribeRequest [optional]

Return type

DescribeResponse

Authorization

OAuth2

HTTP request headers

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

history

NodeListing history(login, representing, nodeIdRequest)

History

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
NodeIdRequest nodeIdRequest = new NodeIdRequest(); // NodeIdRequest | 
try {
    NodeListing result = apiInstance.history(login, representing, nodeIdRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#history");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
nodeIdRequest NodeIdRequest [optional]

Return type

NodeListing

Authorization

OAuth2

HTTP request headers

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

label

AddLabelResponse label(login, representing, addLabelRequest)

Label a Node

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
AddLabelRequest addLabelRequest = new AddLabelRequest(); // AddLabelRequest | 
try {
    AddLabelResponse result = apiInstance.label(login, representing, addLabelRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#label");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
addLabelRequest AddLabelRequest [optional]

Return type

AddLabelResponse

Authorization

OAuth2

HTTP request headers

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

obliterate

StandardNodeResponse obliterate(login, representing, nodeIdRequest)

Obliterating Information Nodes

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
NodeIdRequest nodeIdRequest = new NodeIdRequest(); // NodeIdRequest | 
try {
    StandardNodeResponse result = apiInstance.obliterate(login, representing, nodeIdRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#obliterate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
nodeIdRequest NodeIdRequest [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

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

permission

CreatePermissionResponse permission(login, representing, createPermissionRequest)

Create Permission

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreatePermissionRequest createPermissionRequest = new CreatePermissionRequest(); // CreatePermissionRequest | 
try {
    CreatePermissionResponse result = apiInstance.permission(login, representing, createPermissionRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#permission");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createPermissionRequest CreatePermissionRequest [optional]

Return type

CreatePermissionResponse

Authorization

OAuth2

HTTP request headers

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

read

ReadResponse read(login, representing, readRequest)

Reading

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
ReadRequest readRequest = new ReadRequest(); // ReadRequest | 
try {
    ReadResponse result = apiInstance.read(login, representing, readRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#read");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
readRequest ReadRequest [optional]

Return type

ReadResponse

Authorization

OAuth2

HTTP request headers

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

readInformation

ReadInformationResponse readInformation(login, representing, readInformationRequest)

Read Information

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
ReadInformationRequest readInformationRequest = new ReadInformationRequest(); // ReadInformationRequest | 
try {
    ReadInformationResponse result = apiInstance.readInformation(login, representing, readInformationRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#readInformation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
readInformationRequest ReadInformationRequest [optional]

Return type

ReadInformationResponse

Authorization

OAuth2

HTTP request headers

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

replaceInformation

Information replaceInformation(login, representing, replaceFieldRequest)

Replace

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
ReplaceFieldRequest replaceFieldRequest = new ReplaceFieldRequest(); // ReplaceFieldRequest | 
try {
    Information result = apiInstance.replaceInformation(login, representing, replaceFieldRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#replaceInformation");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
replaceFieldRequest ReplaceFieldRequest [optional]

Return type

Information

Authorization

OAuth2

HTTP request headers

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

requestPermission

StandardNodeResponse requestPermission(login, representing, nodeIdRequest)

Request Permission

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
NodeIdRequest nodeIdRequest = new NodeIdRequest(); // NodeIdRequest | 
try {
    StandardNodeResponse result = apiInstance.requestPermission(login, representing, nodeIdRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#requestPermission");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
nodeIdRequest NodeIdRequest [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

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

resetLogin

ResetLoginResponse resetLogin(login, representing, resetLoginCredentialsRequest)

Changing Login Password

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
ResetLoginCredentialsRequest resetLoginCredentialsRequest = new ResetLoginCredentialsRequest(); // ResetLoginCredentialsRequest | 
try {
    ResetLoginResponse result = apiInstance.resetLogin(login, representing, resetLoginCredentialsRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#resetLogin");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
resetLoginCredentialsRequest ResetLoginCredentialsRequest [optional]

Return type

ResetLoginResponse

Authorization

OAuth2

HTTP request headers

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

searchAlias

SearchAliasResponse searchAlias(login, representing, searchAliasRequest)

Search For Alias

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
SearchAliasRequest searchAliasRequest = new SearchAliasRequest(); // SearchAliasRequest | 
try {
    SearchAliasResponse result = apiInstance.searchAlias(login, representing, searchAliasRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#searchAlias");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
searchAliasRequest SearchAliasRequest [optional]

Return type

SearchAliasResponse

Authorization

OAuth2

HTTP request headers

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

searchEntity

EntityListResponse searchEntity(login, representing, searchEntityRequest)

Search For Entity

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
SearchEntityRequest searchEntityRequest = new SearchEntityRequest(); // SearchEntityRequest | 
try {
    EntityListResponse result = apiInstance.searchEntity(login, representing, searchEntityRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#searchEntity");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
searchEntityRequest SearchEntityRequest [optional]

Return type

EntityListResponse

Authorization

OAuth2

HTTP request headers

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

settleAccount

SettleAccountResponse settleAccount(login, representing, settleAccountRequest)

Settle Account

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
SettleAccountRequest settleAccountRequest = new SettleAccountRequest(); // SettleAccountRequest | 
try {
    SettleAccountResponse result = apiInstance.settleAccount(login, representing, settleAccountRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#settleAccount");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
settleAccountRequest SettleAccountRequest [optional]

Return type

SettleAccountResponse

Authorization

OAuth2

HTTP request headers

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

updateApplication

UpdateApplicationResponse updateApplication(login, representing, updateApplicationRequest)

Resetting Application Secret

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
UpdateApplicationRequest updateApplicationRequest = new UpdateApplicationRequest(); // UpdateApplicationRequest | 
try {
    UpdateApplicationResponse result = apiInstance.updateApplication(login, representing, updateApplicationRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#updateApplication");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
updateApplicationRequest UpdateApplicationRequest [optional]

Return type

UpdateApplicationResponse

Authorization

OAuth2

HTTP request headers

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

updateStatus

StandardNodeResponse updateStatus(login, representing, updateStatusRequest)

Enabling/Disabling Nodes

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
UpdateStatusRequest updateStatusRequest = new UpdateStatusRequest(); // UpdateStatusRequest | 
try {
    StandardNodeResponse result = apiInstance.updateStatus(login, representing, updateStatusRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#updateStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
updateStatusRequest UpdateStatusRequest [optional]

Return type

StandardNodeResponse

Authorization

OAuth2

HTTP request headers

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

watch

CreateWatchResponse watch(login, representing, createWatchRequest)

Create Watch Trigger

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
CreateWatchRequest createWatchRequest = new CreateWatchRequest(); // CreateWatchRequest | 
try {
    CreateWatchResponse result = apiInstance.watch(login, representing, createWatchRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#watch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
createWatchRequest CreateWatchRequest [optional]

Return type

CreateWatchResponse

Authorization

OAuth2

HTTP request headers

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

write

WriteResponse write(login, representing, writeRequest)

Writing by Template

Example

// Import classes:
//import com.factern.ApiClient;
//import com.factern.ApiException;
//import com.factern.Configuration;
//import com.factern.auth.*;
//import com.factern.api.FactsApi;

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 | 
WriteRequest writeRequest = new WriteRequest(); // WriteRequest | 
try {
    WriteResponse result = apiInstance.write(login, representing, writeRequest);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FactsApi#write");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
login String [optional]
representing String [optional]
writeRequest WriteRequest [optional]

Return type

WriteResponse

Authorization

OAuth2

HTTP request headers

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