¶ FlexVertex REST API Reference Guide
¶ Table of Contents
- API Overview
- Authentication
- Endpoints
- GET /rest/schema/sql
- POST /rest/schema/sql
- GET /rest/schema/loadObject
- GET /rest/schema/loadConnection
- POST /rest/schema/createObject
- POST /rest/schema/createObjects
- POST /rest/schema/executeVoyage
- GET /rest/schema/executeVoyagerAsset
- POST /rest/schema/executeVoyagerAsset
- GET /rest/schema/executeVoyagerAsset (with named parameters)
- POST /rest/schema/createConnection
- POST /rest/schema/createConnections
- POST /rest/schema/saveConnection
- POST /rest/schema/saveConnections
- POST /rest/schema/updateConnection
- POST /rest/schema/updateConnections
- POST /rest/schema/updateObject
- POST /rest/schema/updateObjects
- POST /rest/schema/saveObject
- POST /rest/schema/saveObjects
- DELETE /rest/schema/deleteObject
- DELETE /rest/schema/deleteObjects
- DELETE /rest/schema/deleteConnection
- DELETE /rest/schema/deleteConnections
- Error Handling
- Frequently Asked Questions
¶ API Overview
Title: FlexVertex REST API
Version: 1.0.44
Base URL: https://demo.flexvertex.com
Contact: FlexVertex Support - support@flexvertex.com
The FlexVertex REST API offers a versatile interface for interacting with the FlexVertex Data Multiverse, enabling users to perform core operations like object creation, querying, and establishing connections, all in a stateless manner. Unlike the client-side Java API, which maintains session state for activities such as asset manipulation, the REST API operates independently of session management. This makes it ideal for stateless, scalable integrations.
The majority of actions available in the Java API—such as schema support, creating or updating objects, and querying data—are fully supported by the REST API. However, certain session-related operations, such as more advanced object manipulations that rely on maintaining in-memory state, are not directly replicated in the REST API due to its stateless nature.
¶ Key Capabilities
-
Object Creation and Management: Users can create objects, update properties, and manage connections among them using straightforward REST endpoints.
-
Querying: The REST API supports complex querying capabilities, allowing users to retrieve and filter data based on various criteria, such as object properties, connections, and class types.
-
Schema Operations: You can interact with and manipulate the schema through the REST API, such as defining new object types or updating existing ones.
-
Connections and Relationships: The API allows for the creation and management of relationships between objects via connections, akin to the capabilities in the Java API.
-
Selectable Data Hierarchies: Your REST operations will use the Domain/Nexus/Schema of the logged in user. If you want to use another, feel free to specify this property in your API invocations.
¶ Statelessness
Unlike the Java API, which retains context across sessions, the REST API requires that each request include the necessary context (e.g., authentication tokens, object IDs) for the action being performed. This makes the REST API well-suited for environments where scalability, distributed processing, or serverless architectures are required.
¶ Use Cases
The FlexVertex REST API is ideal for applications that need to interact programmatically with FlexVertex in a lightweight, stateless manner. It's well-suited for:
- Web and mobile applications
- Server-side integrations with other systems
- Automation and workflow tools (e.g., n8n)
In summary, the FlexVertex REST API provides extensive support for most key operations, with the exception of session-dependent actions found in the Java API. Its stateless nature and broad compatibility with modern development environments make it an essential tool for scalable integration and automation.
Note that FlexVertex generates a new object key each time an object is instantiated, so your object keys will be different than the ones shown in this guide.
For definitions of key terms used throughout this guide, please refer to our glossary
¶ Authentication
The FlexVertex REST API uses HTTP Basic Authentication to secure access. With this method, you provide your credentials (username and password) in the request's Authorization header. Most API clients, browsers, and tools automatically handle encoding these credentials into the required Base64 format.
The Authorization header will look like this:
Authorization: Basic <Base64EncodedCredentials>
Note that some REST API clients require the Basic prefix explicitly, while others may not.
To ensure security, always use HTTPS when making requests with Basic Authentication. This encrypts the entire communication, including your credentials, to protect against interception.
Most tools and libraries (like Postman, cURL, and browser-based requests) handle this process for you, so you don't need to manually encode your credentials.
Contact your system administrator if you don't have a username and password. Otherwise, contact support@flexvertex.com.
¶ Endpoints
¶ GET /rest/schema/sql
Summary: Submits a SQL query to the current schema using query parameters.
Query Parameters:
Query(string): The SQL query. Required@paramName(string): paramName is the actual parameter name, such as 'Age'.DNS(string): Specify the Domain/Nexus/Schema hierarchy if an alternate hierarchy is desired to query against.
Sample Request: (Query)
GET /rest/schema/sql?Query=select * from Person where InfluencerRating >95&DNS=/Your-domain/Your-nexus/Your-schema
Sample Response:
{
"ResultSet": {
"Duration": 2,
"Count": 2,
"Objects": [
{
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMHwDlcRcU0KpoJRI8c_s-Ow="
},
"Properties": {
"Name": "Prasad",
"Income": 70000,
"DOB": "1999-08-28 00:00:00",
"InfluencerRating": 98,
"ImageKey": "FgEAFgEBFgECFggDMH03UN2ZOENxmeIJzsGYk5M="
}
},
{
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMO9vp5-HeUKDsoiwzdbMZWA="
},
"Properties": {
"Name": "Nicole",
"Income": 112000,
"InfluencerRating": 97,
"DOB": "1994-07-24 00:00:00",
"ImageKey": "FgEAFgEBFgECFggDMNW7LCFW2UMErhgbc147x_U="
}
}
]
},
"EndPoint": "/rest/schema/sql",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request: (Update)
GET /rest/schema/sql?Query=update Person set Income=75000 where InfluencerRating=77&DNS=/Your-domain/Your-nexus/Your-schema
Sample Response:
{
"ResultSet": {
"Duration": 37,
"Count": 1,
"Objects": [
{
"ObjectKey": "FgEAFgEBFgECFlAAMFY88SUL8E3SixF-6wSVfNA="
}
]
},
"EndPoint": "/rest/schema/sql",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/sql
Summary: Submits a SQL query to the current schema using a JSON payload.
Request Body (application/json): An object containing the SQL query, named parameters, and DNS.
Sample Request:
POST /rest/schema/sql
Content-Type: application/json
{
"Query": "insert into Destination (Location, Type) values ('Hawaii', 'Tropical')",
"DNS": "/Your-domain/Your-nexus/Your-schema"
}
Sample Response:
{
"ResultSet": {
"Duration": 61,
"Count": 1,
"Objects": [
{
"ObjectKey": "FgEAFgEBFgECFlABMMUrWUlpXEfgngs68qcsSSQ="
}
]
},
"EndPoint": "/rest/schema/sql",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ GET /rest/schema/loadObject
Summary: Retrieves a single IFlexObject.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the IFlexObject's FlexObjectKey.
Sample Request:
GET /rest/schema/loadObject?ObjectKey=FgEAFgEBFgECFlABMMUrWUlpXEfgngs68qcsSSQ=
Sample Response:
{
"Object": {
"Metadata": {
"Class": "Destination",
"ObjectKey": "FgEAFgEBFgECFlABMMUrWUlpXEfgngs68qcsSSQ="
},
"Properties": {
"Location": "Hawaii",
"Type": "Tropical"
}
},
"Count": 1,
"EndPoint": "/rest/schema/loadObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ GET /rest/schema/loadConnection
Summary: Retrieves a single IFlexConnection.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the IFlexConnection's FlexObjectKey.
Sample Request: (Connection without properties)
GET /rest/schema/loadConnection?ObjectKey=FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zAUI2dzSh1Nha5gaJ81VT4uAAEAHAEAAQEBAlAAMF0w8YdsTEh6jKVTjGG0ujA=
Sample Response:
{
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zAUI2dzSh1Nha5gaJ81VT4uAAEAHAEAAQEBAlAAMF0w8YdsTEh6jKVTjGG0ujA="
},
"OriginKey": "FgEAFgEBFgECFlAAMBQjZ3NKHU2FrmBonzVVPi4=",
"DestinationKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Count": 1,
"EndPoint": "/rest/schema/loadConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request: (Connection with properties)
GET /rest/schema/loadConnection?ObjectKey=FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMLJpHIykRE_2hia0UiNYmN8=
Sample Response:
{
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMLJpHIykRE_2hia0UiNYmN8="
},
"Properties": {
"Skill": "Expert"
},
"OriginKey": "FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=",
"DestinationKey": "FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc="
},
"Count": 1,
"EndPoint": "/rest/schema/loadConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/createObject
Summary: Creates a new IFlexObject using a JSON payload using the current schema (or DNS).
Request Body (application/json): An object specifying the class, properties, and DNS of the new IFlexObject.
Sample Request:
POST /rest/schema/createObject
Content-Type: application/json
{
"Class": "Destination",
"Properties": {"Location": "Denali", "Type": "Mountain"},
"DNS": "/Your-domain/Your-nexus/Your-schema"
}
Sample Response:
{
"ObjectKey": "FgEAFgEBFgECFlABMIFdYivU1k1rnypb3xSlJ9E=",
"EndPoint": "/rest/schema/createObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/createObjects
Summary: Creates new IFlexObjects using a JSON payload using the current schema (or DNS).
Request Body (application/json): An array of objects each specifying the class, properties, and DNS of the new IFlexObjects.
Sample Request:
POST /rest/schema/createObjects
Content-Type: application/json
{
"Objects": [
{"Class": "Person", "Properties": {"Name": "Roberto", "Income": "99999"}},
{"Class": "Interest", "Properties": {"Type": "Golf"}},
{"Class": "Person", "Properties": {"Name": "Lalo", "Income": "83711"}},
{"Class": "Interest", "Properties": {"Type": "Gardening"}}
],
"DNS": "/Your-domain/Your-nexus/Your-schema"
}
Sample Response:
{
"ObjectKeys": [
"FgEAFgEBFgECFlAAMIbiVdvk3kQxoK6xsE2sVGw=",
"FgEAFgEBFgECFlACMO1cbP48vEXzlXhmRds1lfs=",
"FgEAFgEBFgECFlAAMBJFJJEDPkTXkRtNmXfoHxo=",
"FgEAFgEBFgECFlACMPQQsh74F049iCVtBIkNLlU="
],
"Count": 4,
"EndPoint": "/rest/schema/createObjects",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/executeVoyage
Summary: Executes an inlined Voyager script using optional query parameters, returns results where applicable.
Query Parameters:
Voyage(string): A valid Voyager script RequiredNamed parameter(s)(string): One or more named parameters - with a name of your choosing - that will be passed to the Voyager script.DNS(string): Specify the Domain/Nexus/Schema hierarchy if an alternate hierarchy is desired to query against.
Sample Request:
POST /rest/schema/createObjects
Content-Type: application/json
{
"Voyage": "Voyage { journey('select * from Person where Name = @name', namedParams).connection().both().name('Friend').target().explore() }",
"NamedParams": { "name":"Nicole" }
}
Sample Response:
{
"Cargo": {
"Duration": 61,
"Returned": {
"Journey": {
"Duration": 21,
"Count": 2,
"Segments": [
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMO9vp5-HeUKDsoiwzdbMZWA="
},
"Properties": {
"Name": "Nicole",
"Income": 112000,
"InfluencerRating": 97,
"DOB": "1994-07-24 00:00:00",
"ImageKey": "FgEAFgEBFgECFggDMNW7LCFW2UMErhgbc147x_U="
}
},
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVAQEWAQD_FgEBFgECFlAA_zDvb6efh3lCg7KIsM3WzGVgAAJGcmllbmQAHAEAAQEBAlAAME-9bqacQkmkh6Jmck1iWF8="
},
"OriginKey": "FgEAFgEBFgECFlAAMO9vp5-HeUKDsoiwzdbMZWA=",
"DestinationKey": "FgEAFgEBFgECFlAAMJksTqXe50ujlJ3lVU5MvfY="
},
"Target": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJksTqXe50ujlJ3lVU5MvfY="
},
"Properties": {
"Name": "Danielle",
"Income": 180000,
"InfluencerRating": 93,
"DOB": "1997-02-04 00:00:00",
"ImageKey": "FgEAFgEBFgECFggDMLv_bpxmx08CngEqiLHUaPo="
}
},
"Direction": "To",
"ConnectionName": "Friend"
},
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMO9vp5-HeUKDsoiwzdbMZWA="
},
"Properties": {
"Name": "Nicole",
"Income": 112000,
"InfluencerRating": 97,
"DOB": "1994-07-24 00:00:00",
"ImageKey": "FgEAFgEBFgECFggDMNW7LCFW2UMErhgbc147x_U="
}
},
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVAQEWAQD_FgEBFgECFlAA_zC62nVpN7dMZZHkD72BTkw4AAJGcmllbmQAHAEAAQEBAlAAMLzWNg7FBkVQqwFLhZCsmS0="
},
"OriginKey": "FgEAFgEBFgECFlAAMLradWk3t0xlkeQPvYFOTDg=",
"DestinationKey": "FgEAFgEBFgECFlAAMO9vp5-HeUKDsoiwzdbMZWA="
},
"Target": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMLradWk3t0xlkeQPvYFOTDg="
},
"Properties": {
"Name": "Kublai",
"Income": 35000.5,
"InfluencerRating": 82,
"DOB": "1996-03-09 00:00:00",
"ImageKey": "FgEAFgEBFgECFggDMFd7-BUbP0nCpKOi9i9GTt4="
}
},
"Direction": "From",
"ConnectionName": "Friend"
}
]
}
}
},
"EndPoint": "/rest/schema/executeVoyage",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ GET /rest/schema/executeVoyagerAsset
Summary: Executes a hosted Voyager script using query parameters, returns results where applicable.
Query Parameters:
AssetPath(string): Either an absolute or relative path to the Voyager asset. An absolute path (begins with /) and points to the entire DNS + asset path (/D/N/S/Home/Scripts/Test.voyage). A relative path just points to the asset path (Home/Scripts/Test.voyage). RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if an alternate hierarchy is desired to query against.
Sample Voyager Script (hosted)
Voyage {
FlexJourney j = journey("Person where Name='Marco'") // Start a journey to find an object representing a person named Marco
.connection() // Search for connections from Marco's object
.name("Likes") // Evaluate those connections named "Likes" to find Marco's interests
.explore() // Execute the journey and return Marco's interests
return j
}
Sample Visual Representation
Sample Request
GET /rest/schema/executeVoyagerAsset?AssetPath=Home/Training classes/Introduction to FlexVertex/Querying Data/Voyager/What are Marco's interests.voyage
Sample Response
{
"Cargo": {
"Author": "FlexVertex",
"Comment": "Use named 'Likes' connections to find Marco's interests",
"Duration": 30,
"Tab": "Marco's interests",
"Title": "What are Marco's interests?",
"Returned": {
"Journey": {
"Duration": 12,
"Count": 2,
"Segments": [
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEAFgEBFgECFggDMMhaY7LjbEjiuYrEfXh5mJ0="
}
},
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVAQEWAQD_FgEBFgECFlAA_zCeui_MIA5MKouRpPFBxQ-6AAJMaWtlcwAcAQABAQECUAIwSk3_F-1rTom50HtcYpCgcA=="
},
"Properties": {
"Intensity": 1
},
"OriginKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o=",
"DestinationKey": "FgEAFgEBFgECFlACMHELu8sVC0zJn6ieqCnu6aE="
},
"Target": {
"Metadata": {
"Class": "Interest",
"ObjectKey": "FgEAFgEBFgECFlACMHELu8sVC0zJn6ieqCnu6aE="
},
"Properties": {
"Type": "Tea drinking",
"ImageKey": "FgEAFgEBFgECFggDMFWx21w4Qk2VkGSU6tSJAww="
}
},
"Direction": "To",
"ConnectionName": "Likes"
},
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEAFgEBFgECFggDMMhaY7LjbEjiuYrEfXh5mJ0="
}
},
"Connection": {
"Metadata": {
"Class": "FlexConnection",
"ObjectKey": "FgEAFgEBFgECFZEVAQEWAQD_FgEBFgECFlAA_zCeui_MIA5MKouRpPFBxQ-6AAJMaWtlcwAcAQABAQECUAIwqYW0FpM2RXOemcjpPMI9VQ=="
},
"Properties": {
"Intensity": 3
},
"OriginKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o=",
"DestinationKey": "FgEAFgEBFgECFlACMAilH70YvEgkmpytuzxpwsk="
},
"Target": {
"Metadata": {
"Class": "Interest",
"ObjectKey": "FgEAFgEBFgECFlACMAilH70YvEgkmpytuzxpwsk="
},
"Properties": {
"Type": "Fitness",
"ImageKey": "FgEAFgEBFgECFggDMCiMutOqSk01sRn5yysr6AQ="
}
},
"Direction": "To",
"ConnectionName": "Likes"
}
]
}
}
},
"EndPoint": "/rest/schema/executeVoyagerAsset",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/executeVoyagerAsset
Summary: Executes a hosted Voyager script using a JSON payload, returns results where applicable.
Request Body (application/json):
AssetPath(string): Either an absolute or relative path to the Voyager asset. An absolute path (begins with /) and points to the entire DNS + asset path (/D/N/S/Home/Scripts/Test.voyage). A relative path just points to the asset path (Home/Scripts/Test.voyage). RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if an alternate hierarchy is desired to query against.
Sample Voyager Script (hosted)
Voyage {
return journey("Person where Name='Marco'") // Begin by finding an object with a Name property of 'Marco'
.connection("Visited") // Search for connections from the "Visited" class to find places Marco has visited
.explore() // Execute the journey and return the results
}
Sample Visual Representation
Sample Request
POST /rest/schema/executeVoyagerAsset
Content-Type: application/json
{
"AssetPath": "Home/Training classes/Introduction to FlexVertex/Querying Data/Voyager/Where has Marco visited.voyage"
}
Sample Response
{
"Cargo": {
"Author": "FlexVertex",
"Comment": "Use 'Visited' class connections to see where Marco has gone",
"Duration": 38,
"Tab": "Marco's visits",
"Title": "Where has Marco visited?",
"Returned": {
"Journey": {
"Duration": 30,
"Count": 3,
"Segments": [
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEAFgEBFgECFggDMMhaY7LjbEjiuYrEfXh5mJ0="
}
},
"Connection": {
"Metadata": {
"Class": "Leisure",
"ObjectKey": "FgEAFgEBFgECFlAEFQQBFgEA_xYBARYBAhZQAP8wnrovzCAOTCqLkaTxQcUPugABABwBAAEBAQJQATAmdQvW6ZVCUIVXDYM6rEwH"
},
"Properties": {
"VisitDate": "2024-05-01 00:00:00",
"Promotion": true,
"Bundle": false,
"Activity": "Golf"
},
"OriginKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o=",
"DestinationKey": "FgEAFgEBFgECFlABMEM0ENGKLUFDqE80NDJlqgc="
},
"Target": {
"Metadata": {
"Class": "Destination",
"ObjectKey": "FgEAFgEBFgECFlABMEM0ENGKLUFDqE80NDJlqgc="
},
"Properties": {
"Location": "Aruba",
"Type": "Tropical",
"ImageKey": "FgEAFgEBFgECFggDMDzxUa-1FUSUj4Xuq7nUJ98="
}
},
"Direction": "To"
},
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEAFgEBFgECFggDMMhaY7LjbEjiuYrEfXh5mJ0="
}
},
"Connection": {
"Metadata": {
"Class": "Leisure",
"ObjectKey": "FgEAFgEBFgECFlAEFQQBFgEA_xYBARYBAhZQAP8wnrovzCAOTCqLkaTxQcUPugABABwBAAEBAQJQATBzJnhsto9JEoIe6ZQxDvFN"
},
"Properties": {
"VisitDate": "2024-02-25 00:00:00",
"Promotion": false,
"Bundle": false,
"Activity": "Shopping"
},
"OriginKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o=",
"DestinationKey": "FgEAFgEBFgECFlABMLhsoOXL0kkRqaBDIBrLXWQ="
},
"Target": {
"Metadata": {
"Class": "Destination",
"ObjectKey": "FgEAFgEBFgECFlABMLhsoOXL0kkRqaBDIBrLXWQ="
},
"Properties": {
"Location": "Mexico City",
"Type": "City",
"ImageKey": "FgEAFgEBFgECFggDMMx4p5Ii7UwjjcvZQ79qOqM="
}
},
"Direction": "To"
},
{
"Source": {
"Metadata": {
"Class": "Person",
"ObjectKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
},
"Properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEAFgEBFgECFggDMMhaY7LjbEjiuYrEfXh5mJ0="
}
},
"Connection": {
"Metadata": {
"Class": "Business",
"ObjectKey": "FgEAFgEBFgECFlAFFQQBFgEA_xYBARYBAhZQAP8wnrovzCAOTCqLkaTxQcUPugABABwBAAEBAQJQATBUFDDrXa5NXp_hCpHiE3Ma"
},
"Properties": {
"VisitDate": "2024-01-10 00:00:00",
"ChargeCode": "PR1DA"
},
"OriginKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o=",
"DestinationKey": "FgEAFgEBFgECFlABMC7VUWz0Gk3fkOyG_CaOiQo="
},
"Target": {
"Metadata": {
"Class": "Destination",
"ObjectKey": "FgEAFgEBFgECFlABMC7VUWz0Gk3fkOyG_CaOiQo="
},
"Properties": {
"Location": "Istanbul",
"Type": "City",
"ImageKey": "FgEAFgEBFgECFggDMF55J1nrh0Vjq-eO6OmSB_o="
}
},
"Direction": "To"
}
]
}
}
},
"EndPoint": "/rest/schema/executeVoyagerAsset",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ GET /rest/schema/executeVoyagerAsset (with named parameters)
Summary: Executes a dynamic Voyager query using query and named parameters, returns results where applicable.
Query Parameters:
assetPath(string): Either an absolute or relative path to the Voyager asset. An absolute path (begins with /) and points to the entire DNS + asset path (/D/N/S/Home/Scripts/Test.voyage). A relative path just points to the asset path (Home/Scripts/Test.voyage). Requirednamed parameter(s)(string): One or more named parameters that will be passed to the Voyager script.DNS(string): Specify the Domain/Nexus/Schema hierarchy if an alternate hierarchy is desired to query against.
Sample Voyager Script
Voyage
{
FlexNamedParameters fnp = new FlexNamedParameters() // Instantiate a FlexNamedParameters object
fnp.addParameter("paramName", personName) // Add a parameter meant to be used to search for a person by name
fnp.addParameter("paramConnection", connectionType) // Add a parameter meant to be used to search for named connections
journey("Person where Name=@paramName", fnp) // Start a journey to find an object representing a person with a name provided in the parameter
.connection() // Search for connections from the person's object
.name(connectionType) // Evaluate those connections based on the connection type, taken from the parameter
.explore() // Execute the journey and return their immediate friends
}
Sample Visual Representation
Sample Request
GET /rest/schema/executeVoyagerAsset?assetPath=Home/test2.voyage&@personName=Jade&@connectionType=Likes
◊
Sample Response
{
"count": 3,
"segments": [
{
"source": {
"ObjectKey": "FgEBFgEBFgECFlAAMFIDZQ5Rw0_KtwNnBrbeU50=",
"class": "Person",
"properties": {
"Name": "Jade",
"Income": 75000,
"InfluencerRating": 58,
"DOB": "1985-01-25 00:00:00",
"ImageKey": "FgEBFgEBFgECFggDMD_PGlTQakI5ptowFXB2F-4="
}
},
"connection": {
"ObjectKey": "FgEBFgEBFgECFZEVAQEWAQEWAQEWAQIWUAD_MFIDZQ5Rw0_KtwNnBrbeU50AAkxpa2VzABwBAQEBAQJQAjAe36axDutOzZUQ97aUuM5O",
"class": "FlexConnection",
"properties": {
"Intensity": 2
}
},
"target": {
"ObjectKey": "FgEBFgEBFgECFlACMArAqtAM9kEJsghPxomUpFk=",
"class": "Interest",
"properties": {
"Type": "Fitness",
"ImageKey": "FgEBFgEBFgECFggDMJuouFW_SUQ7ikL6ztxzYuY="
}
},
"direction": "To"
},
{
"source": {
"ObjectKey": "FgEBFgEBFgECFlAAMFIDZQ5Rw0_KtwNnBrbeU50=",
"class": "Person",
"properties": {
"Name": "Jade",
"Income": 75000,
"InfluencerRating": 58,
"DOB": "1985-01-25 00:00:00",
"ImageKey": "FgEBFgEBFgECFggDMD_PGlTQakI5ptowFXB2F-4="
}
},
"connection": {
"ObjectKey": "FgEBFgEBFgECFZEVAQEWAQEWAQEWAQIWUAD_MFIDZQ5Rw0_KtwNnBrbeU50AAkxpa2VzABwBAQEBAQJQAjBXLB_ShJlHr7fiVe1ROdon",
"class": "FlexConnection",
"properties": {
"Intensity": 3
}
},
"target": {
"ObjectKey": "FgEBFgEBFgECFlACMBzwmQ6VJ0jhgOBgSYaQZgk=",
"class": "Interest",
"properties": {
"Type": "Tea drinking",
"ImageKey": "FgEBFgEBFgECFggDMJetVAC6T0Ltp56lHIy8Ejc="
}
},
"direction": "To"
},
{
"source": {
"ObjectKey": "FgEBFgEBFgECFlAAMFIDZQ5Rw0_KtwNnBrbeU50=",
"class": "Person",
"properties": {
"Name": "Jade",
"Income": 75000,
"InfluencerRating": 58,
"DOB": "1985-01-25 00:00:00",
"ImageKey": "FgEBFgEBFgECFggDMD_PGlTQakI5ptowFXB2F-4="
}
},
"connection": {
"ObjectKey": "FgEBFgEBFgECFZEVAQEWAQEWAQEWAQIWUAD_MFIDZQ5Rw0_KtwNnBrbeU50AAkxpa2VzABwBAQEBAQJQAjC0JV4NfSxILrZ-D8YN8y_H",
"class": "FlexConnection",
"properties": {
"Intensity": 3
}
},
"target": {
"ObjectKey": "FgEBFgEBFgECFlACMLcIgVEqpEn5gy2iRZ4TaOM=",
"class": "Interest",
"properties": {
"Type": "Photography",
"ImageKey": "FgEBFgEBFgECFggDMJ3rcjuX7E1Cj-w0VR3bYzU="
}
},
"direction": "To"
}
],
"duration": 122,
"endPoint": "/rest/schema/executeVoyagerAsset",
"statusCode": 200,
"statusMessage": "Success"
}
¶ POST /rest/schema/createConnection
Summary: Creates a new connection between two objects specified by their keys in the current schema.
Request Body (application/json):
OriginKey: The origin for the connection. RequiredDestinationKey: The destination for the connection. RequiredClass: The class of the connection.Name: The name of the connection.Properties: One or more properties to attach to the connection.DNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete a connection in an alternate hierarchy.
Sample Request (Basic Connection):
POST /rest/schema/createConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMBQjZ3NKHU2FrmBonzVVPi4=",
"DestinationKey": "FgEAFgEBFgECFlAAMJ66L8wgDkwqi5Gk8UHFD7o="
}
Sample Response: (Basic Connection):
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCG4lXb5N5EMaCusbBNrFRsAAEAHAEAAQEBAlACMI0Mt8XFy0zks8IS_ODt1gc=",
"EndPoint": "/rest/schema/createConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request (Connection with class and properties):
POST /rest/schema/createConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMIbiVdvk3kQxoK6xsE2sVGw=",
"DestinationKey": "FgEAFgEBFgECFlABMLhsoOXL0kkRqaBDIBrLXWQ=",
"Class": "Business",
"Properties":
{
"ChargeCode": "TVC15"
}
}
Sample Response: (Connection with class and properties):
{
"ObjectKey": "FgEAFgEBFgECFlAFFQQBFgEA_xYBARYBAhZQAP8whuJV2-TeRDGgrrGwTaxUbAABABwBAAEBAQJQATAjBpM0Rd1H1qkyh-QvwEpb",
"EndPoint": "/rest/schema/createConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request (Named connection with properties)
POST /rest/schema/createConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMIbiVdvk3kQxoK6xsE2sVGw=",
"DestinationKey": "FgEAFgEBFgECFlACMNYzhMJdHUj7qi5f0CslEIw=",
"Name": "Interest",
"Properties":
{
"Intensity": "1"
}
}
Sample Response: (Named connection with properties)
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCG4lXb5N5EMaCusbBNrFRsAAEAHAEAAQEBAlACMF1ScNXgKEfAmlHTKUyDUdE=",
"EndPoint": "/rest/schema/createConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request (Named connection with two different names)
POST /rest/schema/createConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMIbiVdvk3kQxoK6xsE2sVGw=",
"DestinationKey": "FgEAFgEBFgECFlAAMJksTqXe50ujlJ3lVU5MvfY=",
"ToName": "Father",
"FromName": "Daughter",
"Properties":
{
"Gift": "Telescope"
}
}
Sample Response: (Named connection with two different names)
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCG4lXb5N5EMaCusbBNrFRsAAEAHAEAAQEBAlAAMA_xQKa9cEQRn-fGUGvHBO4=",
"EndPoint": "/rest/schema/createConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/createConnections
Summary: Create new connections between multiple pairs of two objects specified by their keys in the current schema. Similar use cases as /rest/schema/createConnection
Request Body (application/json):
OriginKey: The origin for the connection. RequiredDestinationKey: The destination for the connection. RequiredClass: The class of the connection.Name: The name of the connection.Properties: One or more properties to attach to the connection.DNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete a connection in an alternate hierarchy.
Sample Request
POST /rest/schema/createConnections
Content-Type: application/json
{
"Connections" :
[
{"OriginKey": "FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=", "DestinationKey": "FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc=", "Properties": {"Skill": "Expert"}},
{"OriginKey": "FgEAFgEBFgECFlAAMG8gut-9QEWKpLid6fNKVxg=", "DestinationKey": "FgEAFgEBFgECFlAAMJHi5-IG3krrkQoEaSrWTt8=", "Properties": {"Team": "Amazons"}}
]
}
Sample Response
{
"ObjectKeys": [
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMLJpHIykRE_2hia0UiNYmN8=",
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMBLBcIAM-ExbkbJa0Xy34WY="
],
"Count": 2,
"EndPoint": "/rest/schema/createConnections",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/saveConnection
Summary: Create a new connection if you don't specify the connection's object key, or updates an existing connection if you do.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the connection object's FlexObjectKey.OriginKey(string): The Base64-encoded string representing the origin object's FlexObjectKey. Required if ObjectKey is missingDestinationKey(string): The Base64-encoded string representing the destination object's FlexObjectKey. Required if ObjectKey is missingProperties(object): Any properties you wish to associate with the connection.Options(object): Assign strings to serve as the name for the connection ORtoNameandfromNamelabels for the connection.DNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to specify a connection in an alternate hierarchy.
Sample Request: (No ObjectKey specified)
POST /rest/schema/saveConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=",
"DestinationKey": "FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc=",
"Properties": {"Duration": "90 minutes"}
}
Sample Response: (No ObjectKey specified)
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMK5NK-odgUBxtve_F90A2P4=",
"EndPoint": "/rest/schema/saveConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request: (ObjectKey + To & from name specified)
POST /rest/schema/saveConnection
Content-Type: application/json
{
"OriginKey": "FgEAFgEBFgECFlAAMG8gut-9QEWKpLid6fNKVxg=",
"DestinationKey": "FgEAFgEBFgECFlAAMJHi5-IG3krrkQoEaSrWTt8=",
"Properties": {"Level": "Apprentice"},
"Options": {"toName": "Teacher", "fromName": "Student"}
}
Sample Response: (ObjectKey + To & from name specified)
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMNzIounO3EIYp5V3Q7FCqiw=",
"EndPoint": "/rest/schema/saveConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/saveConnections
Summary: Creates new connections if you don't specify the connections' object keys, or updates an existing connection if you do.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the connection object's FlexObjectKey.OriginKey(string): The Base64-encoded string representing the origin object's FlexObjectKey. Required if ObjectKey is missingDestinationKey(string): The Base64-encoded string representing the destination object's FlexObjectKey. Required if ObjectKey is missingProperties(object): Any properties you wish to associate with the connection.Options(object): Assign strings to serve as the name for the connection ORfromNameandtoNamelabels for the connection.DNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to specify a connection in an alternate hierarchy.
Sample Request:(No existing connection ObjectKey specified)
{
"SaveConnections" :
[
{"OriginKey": "FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc=", "DestinationKey": "FgEAFgEBFgECFlAAMJHi5-IG3krrkQoEaSrWTt8=", "Properties": {"Skill": "Amateur"}},
{"OriginKey": "FgEAFgEBFgECFlAAMG8gut-9QEWKpLid6fNKVxg=", "DestinationKey": "FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=", "Properties": {"Team": "Vandals"}}
]
}
Sample Response: (No existing connection ObjectKey specified)
{
"SavedConnections": [
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBIQT7TqeFH6pMJgoPxofDHAAEAHAEAAQEBAlAAMCGpbfkGWkbdhXDVvN0tIUc="
},
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMIyIiQqJpkrkgiq9dsU2DhU="
}
],
"SaveCount": 2,
"DeleteCount": 0,
"EndPoint": "/rest/schema/saveConnections",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request:(Existing connection ObjectKey specified)
{
"SaveConnections" :
[
{"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBIQT7TqeFH6pMJgoPxofDHAAEAHAEAAQEBAlAAMCGpbfkGWkbdhXDVvN0tIUc=", "Properties": {"Skill": "Professional"}},
{"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMIyIiQqJpkrkgiq9dsU2DhU=", "Properties": {"Team": "Decorators"}}
]
}
Sample Response:(Existing connection ObjectKey specified)
{
"SavedConnections": [
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBIQT7TqeFH6pMJgoPxofDHAAEAHAEAAQEBAlAAMCGpbfkGWkbdhXDVvN0tIUc="
},
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMIyIiQqJpkrkgiq9dsU2DhU="
}
],
"SaveCount": 2,
"DeleteCount": 0,
"EndPoint": "/rest/schema/saveConnections",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/updateConnection
Summary: Updates properties on an existing connection specified by its object key.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the connection's FlexObjectKey. RequiredProperties(object): A collection of values to be associated with the connection. Mandatory properties must be populated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to update a connection in an alternate hierarchy.
Sample Request:
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCG4lXb5N5EMaCusbBNrFRsAAEAHAEAAQEBAlAAMA_xQKa9cEQRn-fGUGvHBO4=",
"Properties": {"Gift": "Skis", "Cost": 1000}
}
Sample Response:
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCG4lXb5N5EMaCusbBNrFRsAAEAHAEAAQEBAlAAMA_xQKa9cEQRn-fGUGvHBO4=",
"EndPoint": "/rest/schema/updateConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/updateConnections
Summary: Updates properties on existing connections specified by their object keys.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing each connection's FlexObjectKey. RequiredProperties(object): A collection of values to be associated with the connection. Mandatory properties must be populated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to update a connection in an alternate hierarchy.
Sample Request:
{
"Connections" :
[
{"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBIQT7TqeFH6pMJgoPxofDHAAEAHAEAAQEBAlAAMCGpbfkGWkbdhXDVvN0tIUc=", "properties": {"Skill": "Trainer"}},
{"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMIyIiQqJpkrkgiq9dsU2DhU=", "properties": {"Team": "Panickers"}}
]
}
Sample Response:
{
"ObjectKeys": [
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBIQT7TqeFH6pMJgoPxofDHAAEAHAEAAQEBAlAAMCGpbfkGWkbdhXDVvN0tIUc=",
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMIyIiQqJpkrkgiq9dsU2DhU="
],
"Count": 2,
"EndPoint": "/rest/schema/updateConnections",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/updateObject
Summary: Updates properties on an existing object specified by its object key.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the object's FlexObjectKey. RequiredProperties(object): A collection of values to be associated with the object. Mandatory properties must be populated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to update an object in an alternate hierarchy.
Sample Request:
POST /rest/schema/updateObject
Content-Type: application/json
{
"ObjectKey": "FgEAFgEBFgECFlAAMNGAP_RuYUOBgUHiNABudlM=",
"Properties": {"Name":"Vittoria", "EyeColor": "Green"}
}
Sample Response:
{
"ObjectKey": "FgEAFgEBFgECFlAAMNGAP_RuYUOBgUHiNABudlM=",
"EndPoint": "/rest/schema/updateObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/updateObjects
Summary: Updates properties on multiple existing objects specified by their object keys. Objects may belong to different classes.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing each object's FlexObjectKey. Requiredproperties(object): A collection of values to be associated with each object. Mandatory properties must be populated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to update objects in an alternate hierarchy.
Sample Request:
POST /rest/schema/updateObjects
Content-Type: application/json
{
"Objects": [
{"ObjectKey": "FgEAFgEBFgECFlAAMPM2x_y61Un9jPGFszFPf3c=", "Properties": {"Name": "Cindy", "Position": "Sales"}},
{"ObjectKey": "FgEAFgEBFgECFlAAMNGAP_RuYUOBgUHiNABudlM=", "Properties": {"Name": "Vittoria", "Position": "Support"}}
]
}
Sample Response:
{
"ObjectKeys": [
"FgEAFgEBFgECFlAAMPM2x_y61Un9jPGFszFPf3c=",
"FgEAFgEBFgECFlAAMNGAP_RuYUOBgUHiNABudlM="
],
"Count": 2,
"EndPoint": "/rest/schema/updateObjects",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/saveObject
Summary: Creates a new object or updates an existing object, based on whether an object key is provided.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the object's FlexObjectKey. Required for updatesClass(string): The object's class. Required for createsProperties(object): One or more properties to be either created or updated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to create or update objects in an alternate hierarchy.
Sample Request: (creating a new object)
POST /rest/schema/saveObject
Content-Type: application/json
{
"Class": "Interest",
"Properties": {"Type": "Skating", "Cost": 75}
}
Sample Response: (creating a new object)
{
"ObjectKey": "FgEAFgEBFgECFlACMBVqreg5Z0Pxo-e9L1-xNW4=",
"EndPoint": "/rest/schema/saveObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request: (updating an existing object)
POST /rest/schema/saveObject
Content-Type: application/json
{
"ObjectKey": "FgEAFgEBFgECFlACMBVqreg5Z0Pxo-e9L1-xNW4=",
"Properties": {"Type": "Skating", "Cost": 100}
}
Sample Response: (updating an existing object)
{
"ObjectKey": "FgEAFgEBFgECFlACMBVqreg5Z0Pxo-e9L1-xNW4=",
"EndPoint": "/rest/schema/saveObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ POST /rest/schema/saveObjects
Summary: Creates new objects or updates existing objects, based on whether object keys are provided.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the object's FlexObjectKey. Required for updatesClass(string): The object's class. Multiple classes may be specified. Required for createsProperties(object): One or more properties to be either created or updated. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to create or update objects in an alternate hierarchy.
Sample Request: (creating new objects)
POST /rest/schema/saveObjects
Content-Type: application/json
{
"SaveObjects":
[
{"Class": "Person", "Properties": {"Name": "Bob", "Age": 50}},
{"Class": "Interest", "Properties": {"Type": "Curling"}},
{"Class": "Person", "Properties": {"Name": "Mickey", "Age": 45}}
]
}
Sample Response: (creating new objects)
{
"SavedObjects": [
{
"ObjectKey": "FgEAFgEBFgECFlAAMKU6ryku10_MjgSQPKRI1nU="
},
{
"ObjectKey": "FgEAFgEBFgECFlACMMXZBDxAAEc8jk14sycofio="
},
{
"ObjectKey": "FgEAFgEBFgECFlAAMA-_NE6IYEUzk8kQnojPKKQ="
}
],
"SaveCount": 3,
"DeleteCount": 0,
"EndPoint": "/rest/schema/saveObjects",
"StatusCode": 200,
"StatusMessage": "Success"
}
Sample Request: (updating existing objects)
POST /rest/schema/saveObjects
Content-Type: application/json
{
"SaveObjects": [
{"ObjectKey": "FgEAFgEBFgECFlAAMKU6ryku10_MjgSQPKRI1nU=", "Properties": {"Name": "Bob", "Age": 51}},
{"ObjectKey": "FgEAFgEBFgECFlACMMXZBDxAAEc8jk14sycofio=", "Properties": {"Type": "Curling", "Cost": 125}},
{"ObjectKey": "FgEAFgEBFgECFlAAMA-_NE6IYEUzk8kQnojPKKQ=", "Properties": {"Name": "Mickey", "Age": 45, "Profession": "Entertainer"}}
]
}
Sample Response: (updating existing objects)
{
"SavedObjects": [
{
"ObjectKey": "FgEAFgEBFgECFlAAMKU6ryku10_MjgSQPKRI1nU="
},
{
"ObjectKey": "FgEAFgEBFgECFlACMMXZBDxAAEc8jk14sycofio="
},
{
"ObjectKey": "FgEAFgEBFgECFlAAMA-_NE6IYEUzk8kQnojPKKQ="
}
],
"SaveCount": 3,
"DeleteCount": 0,
"EndPoint": "/rest/schema/saveObjects",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ DELETE /rest/schema/deleteObject
Summary: Deletes an existing object specified by its object key.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the object's FlexObjectKey. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete an object in an alternate hierarchy.
Sample Request:
DELETE /rest/schema/deleteObject?ObjectKey=FgEAFgEBFgECFlACMBVqreg5Z0Pxo-e9L1-xNW4=
Sample Response:
{
"ObjectKey": "FgEAFgEBFgECFlACMBVqreg5Z0Pxo-e9L1-xNW4=",
"EndPoint": "/rest/schema/deleteObject",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ DELETE /rest/schema/deleteObjects
Summary: Deletes existing objects specified by their object keys.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing each object's FlexObjectKey. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete objects in an alternate hierarchy.
Sample Request:
DELETE /rest/schema/deleteObjects
Content-Type: application/json
{
"ObjectKeys": [
"FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=",
"FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc=",
"FgEAFgEBFgECFlAAMG8gut-9QEWKpLid6fNKVxg=",
"FgEAFgEBFgECFlAAMJHi5-IG3krrkQoEaSrWTt8="
]
}
Sample Response:
{
"ObjectKeys": [
"FgEAFgEBFgECFlAAMK--LUis5Udii8w_lqr5Zi4=",
"FgEAFgEBFgECFlAAMEhBPtOp4UfqkwmCg_Gh8Mc=",
"FgEAFgEBFgECFlAAMG8gut-9QEWKpLid6fNKVxg=",
"FgEAFgEBFgECFlAAMJHi5-IG3krrkQoEaSrWTt8="
],
"Count": 4,
"EndPoint": "/rest/schema/deleteObjects",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ DELETE /rest/schema/deleteConnection
Summary: Deletes an existing connection specified by the connection's object key.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing the connection's FlexObjectKey. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete a connection in an alternate hierarchy.
Sample Request:
DELETE /rest/schema/deleteConnection?ObjectKey=FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMNzIounO3EIYp5V3Q7FCqiw=
Sample Response:
{
"ObjectKey": "FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMNzIounO3EIYp5V3Q7FCqiw=",
"EndPoint": "/rest/schema/deleteConnection",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ DELETE /rest/schema/deleteConnections
Summary: Deletes multiple existing connections specified by the connections' object keys.
Query Parameters:
ObjectKey(string): The Base64-encoded string representing each connection's FlexObjectKey. RequiredDNS(string): Specify the Domain/Nexus/Schema hierarchy if you want to delete a connection in an alternate hierarchy.
Sample Request:
DELETE /rest/schema/deleteConnections
Content-Type: application/json
{
"ObjectKeys": [
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMLJpHIykRE_2hia0UiNYmN8=",
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMBLBcIAM-ExbkbJa0Xy34WY="
]
}
Sample Response
{
"ObjectKeys": [
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zCvvi1IrOVHYovMP5aq-WYuAAEAHAEAAQEBAlAAMLJpHIykRE_2hia0UiNYmN8=",
"FgEAFgEBFgECFZEVBAEWAQD_FgEBFgECFlAA_zBvILrfvUBFiqS4nenzSlcYAAEAHAEAAQEBAlAAMBLBcIAM-ExbkbJa0Xy34WY="
],
"Count": 2,
"EndPoint": "/rest/schema/deleteConnections",
"StatusCode": 200,
"StatusMessage": "Success"
}
¶ Error Handling
When using the FlexVertex REST API, various HTTP status codes are returned to indicate the success or failure of a request. Below is a list of common status codes and their meanings:
Common HTTP Status Codes
200 OK
- The request was successful, and the server returned the expected data.
201 Created
- The resource was successfully created. The location of the new resource may be provided in the Location header.
400 Bad Request
- The request was malformed or contained invalid parameters. Check the request syntax and ensure that all required fields are included.
401 Unauthorized
- Authentication failed. Ensure your credentials are correct and that the Authorization header is properly set with a valid token.
403 Forbidden
- You do not have permission to access the requested resource. This can happen if your account lacks the necessary privileges.
404 Not Found
- The requested resource could not be found. Verify the endpoint and any resource IDs used in the request.
500 Internal Server Error
- An unexpected error occurred on the server. This is typically a temporary issue, but if it persists, contact support for assistance.
¶ Frequently Asked Questions
-
How do I authenticate with the FlexVertex REST API?
- You can authenticate using HTTP Basic Authentication by including your credentials in the
Authorizationheader. Tools like Postman or cURL will handle Base64 encoding automatically. Make sure to use HTTPS for secure transmission.
- You can authenticate using HTTP Basic Authentication by including your credentials in the
-
What is the best way to handle error codes from the API?
- The API returns standard HTTP status codes to indicate success or failure. Common codes include
200 OKfor success,400 Bad Requestfor invalid input, and401 Unauthorizedfor authentication issues. You can also refer to the error handling section for more detailed responses and suggestions.
- The API returns standard HTTP status codes to indicate success or failure. Common codes include
-
How can I create and manage objects and relationships in FlexVertex?
- The FlexVertex REST API supports creating and managing objects and their relationships. You can send
POSTrequests to create new objects or connections andGETrequests to retrieve existing data. See the endpoint examples for more details on usage.
- The FlexVertex REST API supports creating and managing objects and their relationships. You can send
-
Are there rate limits for the FlexVertex REST API?
- Currently, there are no explicit rate limits imposed on the API. However, for optimal performance, it's recommended to structure your API requests efficiently and avoid unnecessary, repetitive calls.
-
Can I use the API to automate workflows?
- Yes, the API can be integrated into automation tools like n8n, which allow you to automate workflows using data from FlexVertex. You can fetch data, create relationships, and trigger events using FlexVertex API requests.
-
What data formats are supported by the FlexVertex API?
- The API expects JSON for request payloads and returns responses in JSON format. Make sure to structure your requests accordingly to ensure smooth communication.
-
How do I refresh my credentials or obtain new ones if they expire?
- While FlexVertex currently uses Basic Authentication, credentials management and renewal will depend on your specific setup. In cases of expiration, re-issue the credentials through your account or contact support for assistance.
-
Can I try out API calls directly in the documentation?
- At the moment, it's best to use external tools such as Postman for testing API requests.
-
Where can I find definitions for terms used in the API documentation?
- Check out our Glossary for definitions of terms and concepts specific to FlexVertex.