¶ FlexVertex REST API Reference Guide
¶ Table of Contents
-
- GET /rest/schema/sql
- POST /rest/schema/sql
- GET /rest/schema/loadObject
- POST /rest/schema/createObject
- POST /rest/schema/createObjects
- GET /rest/schema/executeVoyagerAsset
- POST /rest/schema/executeVoyagerAsset
- GET /rest/schmea/executeVoyagerAsset (with named parameters)
- POST /rest/schema/createConnection
- DELETE /rest/schema/deleteObject
- DELETE /rest/schema/deleteConnection
¶ API Overview
Title: FlexVertex REST API
Version: 1.0.0
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.
¶ 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.
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>
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:
GET /rest/schema/sql?query=select * from Person where InfluencerRating >95&dns=/Your-domain/Your-nexus/Your-schema
Sample Response:
{
"resultSet": [
{
"objectKey": "FgFNFgEBFgECFlAAMA0ctT7Ae0oetoOYS-rGpaA=",
"class": "Person",
"properties": {
"Name": "Nicole",
"Income": 112000,
"InfluencerRating": 97,
"DOB": "1994-07-24 00:00:00",
"ImageKey": "FgFNFgEBFgECFggDMGL6cjQ54Egvmb__3chp94M="
}
},
{
"objectKey": "FgFNFgEBFgECFlAAMGDXe78a70U8j24pEmmsY7o=",
"class": "Person",
"properties": {
"Name": "Prasad",
"Income": 70000,
"DOB": "1999-08-28 00:00:00",
"InfluencerRating": 98,
"ImageKey": "FgFNFgEBFgECFggDMMDRylALVkVtrEPD1Uzl_r4="
}
}
],
"count": 2,
"endPoint": "/rest/schema/sql",
"statusCode": 200,
"statusMessage": "Success"
}
Sample Request:
GET rest/schema/sql?query=update Person set Income=75000 where InfluencerRating=77&dns=/Your-domain/Your-nexus/Your-schema
Sample Response:
{
"resultSet": [
{
"objectKey": "FgEKFgEBFgEDFgUAMGbQJKR7uE3fsfC-3cAFI48=",
"class": "sysclass:FlexResultSet",
"properties": {
"Count": 1,
"Status": "Success"
}
}
],
"count": 1,
"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": [
{
"objectKey": "FgEKFgEBFgEDFgUAMM4Rk3-18kI8ohl0Y2UzN-Y=",
"class": "sysclass:FlexResultSet",
"properties": {
"Count": 1,
"Status": "Success"
}
}
],
"count": 1,
"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=FgEAFgEBFgECFkABMOBq9WoXoEvZuL-6oIdxOw0=
Sample Response:
{
"object": {
"objectKey": "FgFNFgEBFgECFlAAMA0ctT7Ae0oetoOYS-rGpaA=",
"class": "Person",
"properties": {
"Name": "Nicole",
"Income": 112000,
"InfluencerRating": 97,
"DOB": "1994-07-24 00:00:00",
"ImageKey": "FgFNFgEBFgECFggDMGL6cjQ54Egvmb__3chp94M="
}
},
"count": 1,
"endPoint": "/rest/schema/loadObject",
"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": "FgEKFgEBFgEDFlABMPEHlQJFeEuYn-yzML7ATo8=",
"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:
{
"count": 4,
"endPoint": "/rest/schema/createObjects",
"statusCode": 200,
"statusMessage": "Success"
}
¶ GET /rest/schema/executeVoyagerAsset
Summary: Executes a Voyager query 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
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
{
"count": 2,
"segments": [
{
"source": {
"objectKey": "FgEBFgEBFgECFlAAMGfU3t5ZAUAXnHtyOcyXgRU=",
"class": "Person",
"properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEBFgEBFgECFggDMNq_GET22ENNgPHU1ziFyaY="
}
},
"connection": {
"objectKey": "FgEBFgEBFgECFZEVAQEWAQEWAQEWAQIWUAD_MGfU3t5ZAUAXnHtyOcyXgRUAAkxpa2VzABwBAQEBAQJQAjCAGrJKkBZJLoC2ZWDMHLt0",
"class": "FlexConnection",
"properties": {
"Intensity": 3
}
},
"target": {
"objectKey": "FgEBFgEBFgECFlACMArAqtAM9kEJsghPxomUpFk=",
"class": "Interest",
"properties": {
"Type": "Fitness",
"ImageKey": "FgEBFgEBFgECFggDMJuouFW_SUQ7ikL6ztxzYuY="
}
},
"direction": "To"
},
{
"source": {
"objectKey": "FgEBFgEBFgECFlAAMGfU3t5ZAUAXnHtyOcyXgRU=",
"class": "Person",
"properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEBFgEBFgECFggDMNq_GET22ENNgPHU1ziFyaY="
}
},
"connection": {
"objectKey": "FgEBFgEBFgECFZEVAQEWAQEWAQEWAQIWUAD_MGfU3t5ZAUAXnHtyOcyXgRUAAkxpa2VzABwBAQEBAQJQAjCVKlLr_-1EgLJzXAka4aCV",
"class": "FlexConnection",
"properties": {
"Intensity": 1
}
},
"target": {
"objectKey": "FgEBFgEBFgECFlACMBzwmQ6VJ0jhgOBgSYaQZgk=",
"class": "Interest",
"properties": {
"Type": "Tea drinking",
"ImageKey": "FgEBFgEBFgECFggDMJetVAC6T0Ltp56lHIy8Ejc="
}
},
"direction": "To"
}
],
"duration": 13,
"endPoint": "/rest/schema/executeVoyagerAsset",
"statusCode": 200,
"statusMessage": "Success"
}
¶ POST /rest/schema/executeVoyagerAsset
Summary: Executes a Voyager query 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
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
{
"count": 3,
"segments": [
{
"source": {
"objectKey": "FgEBFgEBFgECFlAAMGfU3t5ZAUAXnHtyOcyXgRU=",
"class": "Person",
"properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEBFgEBFgECFggDMNq_GET22ENNgPHU1ziFyaY="
}
},
"connection": {
"objectKey": "FgEBFgEBFgECFlAEFQQBFgEBFgEBFgECFlAA_zBn1N7eWQFAF5x7cjnMl4EVAAEAHAEBAQEBAlABMAGU-DX4fUmkr04ZrA8lCxU=",
"class": "Leisure",
"properties": {
"VisitDate": "2024-05-01 00:00:00",
"Promotion": true,
"Bundle": false,
"Activity": "Golf"
}
},
"target": {
"objectKey": "FgEBFgEBFgECFlABMBh5u_aMnkMHr2U5gUZsZV8=",
"class": "Destination",
"properties": {
"Location": "Aruba",
"Type": "Tropical",
"ImageKey": "FgEBFgEBFgECFggDMAedZZkLNkfSnD0HFZTMzXI="
}
},
"direction": "To"
},
{
"source": {
"objectKey": "FgEBFgEBFgECFlAAMGfU3t5ZAUAXnHtyOcyXgRU=",
"class": "Person",
"properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEBFgEBFgECFggDMNq_GET22ENNgPHU1ziFyaY="
}
},
"connection": {
"objectKey": "FgEBFgEBFgECFlAEFQQBFgEBFgEBFgECFlAA_zBn1N7eWQFAF5x7cjnMl4EVAAEAHAEBAQEBAlABMN3oTX3XLkFBgf84wpnBrPo=",
"class": "Leisure",
"properties": {
"VisitDate": "2024-02-25 00:00:00",
"Promotion": false,
"Bundle": false,
"Activity": "Shopping"
}
},
"target": {
"objectKey": "FgEBFgEBFgECFlABMDKTOJCI50-WhwJQUHT4y54=",
"class": "Destination",
"properties": {
"Location": "Mexico City",
"Type": "City",
"ImageKey": "FgEBFgEBFgECFggDMG-FoxUupkVKrleITbdTh_w="
}
},
"direction": "To"
},
{
"source": {
"objectKey": "FgEBFgEBFgECFlAAMGfU3t5ZAUAXnHtyOcyXgRU=",
"class": "Person",
"properties": {
"Name": "Marco",
"Income": 150000,
"DOB": "1988-09-12 00:00:00",
"InfluencerRating": 88,
"ImageKey": "FgEBFgEBFgECFggDMNq_GET22ENNgPHU1ziFyaY="
}
},
"connection": {
"objectKey": "FgEBFgEBFgECFlAFFQQBFgEBFgEBFgECFlAA_zBn1N7eWQFAF5x7cjnMl4EVAAEAHAEBAQEBAlABMGToaQCqdUENudMS6RbR3SI=",
"class": "Business",
"properties": {
"VisitDate": "2024-01-10 00:00:00",
"ChargeCode": "PR1DA"
}
},
"target": {
"objectKey": "FgEBFgEBFgECFlABMFQGudZgDU0wqvw75CktbLk=",
"class": "Destination",
"properties": {
"Location": "Istanbul",
"Type": "City",
"ImageKey": "FgEBFgEBFgECFggDMKW90IQr7UF5usv0hk7M7M8="
}
},
"direction": "To"
}
],
"duration": 14,
"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": "FgEEFgEBFgEDFlAAMPspfq2gJU9bmk0vyRc8Hto=",
"destinationKey": "FgEEFgEBFgEDFlAAMKJbmaPNz0IkhPJgjzYJOR4="
}
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFZEVBAEWAQQWAQEWAQMWUAD_MPspfq2gJU9bmk0vyRc8HtoAAQAcAQQBAQEDUAAw2R_7WBzvQeiO_mdfPTkcqA==",
"endPoint": "/rest/schema/createConnection",
"statusCode": 200,
"statusMessage": "Success"
}
Sample Request (Connection with class and properties):
POST /rest/schema/createConnection
Content-Type: application/json
{
"originKey": "FgEEFgEBFgEDFlAAMPspfq2gJU9bmk0vyRc8Hto=",
"destinationKey": "FgEEFgEBFgEDFlAAMKJbmaPNz0IkhPJgjzYJOR4=",
"class": "Business",
"properties":
{
"ChargeCode": "PR1DA"
}
}
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFlAFFQQBFgEEFgEBFgEDFlAA_zD7KX6toCVPW5pNL8kXPB7aAAEAHAEEAQEBA1AAMGUY3UxDVEyFkVF_mgdhmm8=",
"endPoint": "/rest/schema/createConnection",
"statusCode": 200,
"statusMessage": "Success"
}
Sample Request (Named connection with properties)
POST /rest/schema/createConnection
Content-Type: application/json
{
"originKey": "FgEEFgEBFgEDFlAAMPspfq2gJU9bmk0vyRc8Hto=",
"destinationKey": "FgEEFgEBFgEDFlAAMKJbmaPNz0IkhPJgjzYJOR4=",
"name": "Interest",
"properties":
{
"Intensity": "5"
}
}
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFZEVAQEWAQQWAQEWAQMWUAD_MPspfq2gJU9bmk0vyRc8HtoAAkludGVyZXN0ABwBBAEBAQNQADAFBW6XhPBEA6u9XEhLI-BQ",
"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": "FgEEFgEBFgEDFlAAMPspfq2gJU9bmk0vyRc8Hto=",
"destinationKey": "FgEEFgEBFgEDFlAAMKJbmaPNz0IkhPJgjzYJOR4=",
"parentName": "Father",
"childName": "Daughter",
"properties":
{
"Gift": "Telescope"
}
}
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFZEVAQEWAQQWAQEWAQMWUAD_MPspfq2gJU9bmk0vyRc8HtoAAkZhdGhlcgAcAQQBAQEDUAAwnQ6AdCUvQWabEbMCamq5-A==",
"endPoint": "/rest/schema/createConnection",
"statusCode": 200,
"statusMessage": "Success"
}
¶ DELETE /rest/schema/deleteObject
Summary: Deletes an existing object specified by the 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=FgEEFgEBFgEDFlAAMLHv5wm_pUdmhZPczPuCOgE=
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFlAAMLHv5wm_pUdmhZPczPuCOgE=",
"endPoint": "/rest/schema/deleteObject",
"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=FgEEFgEBFgEDFZEVAQEWAQQWAQEWAQMWUAD_MLHv5wm_pUdmhZPczPuCOgEAAkZyaWVuZAAcAQQBAQEDUAAwTzzRWhXqSrqrB9_dNL0VWw==
Sample Response:
{
"objectKey": "FgEEFgEBFgEDFZEVAQEWAQQWAQEWAQMWUAD_MLHv5wm_pUdmhZPczPuCOgEAAkZyaWVuZAAcAQQBAQEDUAAwTzzRWhXqSrqrB9_dNL0VWw==",
"endPoint": "/rest/schema/deleteConnection",
"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.