Entity Data contract
Terminate Feature Flag For Entity
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/featureFlags/{flagName}/terminate HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"entityId": "entity123",
"flagName": "Flag Name",
"description": "Flag description",
"isActive": true,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
}
Get entity level flags of a particular Entity
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/forEntityId/{forEntityId}/featureFlags HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"flags": {
"entityId": "entity123",
"flagName": "Flag Name",
"description": "Flag description",
"isActive": true,
"isEnabled": true,
"createdAt": "2023-06-27T12:45:00Z",
"metadata": {
"key1": "value1",
"key2": "value2"
}
}
}
Get all Data Contracts for specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/dataContracts HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"entityId": "entity123",
"createdBy": "user123",
"name": "Data Contract Name",
"description": "Data Contract Description",
"tags": [
[
"tag1",
"tag2"
]
],
"source": "URL",
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
"value1",
"value2"
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
],
"isDeleted": false,
"createdAt": "2023-06-27T12:45:00Z",
"updatedAt": "2023-06-27T12:45:00Z"
}
}
Add new data contract info of specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
Data Contract Name
Data Contract Description
URL
["tag1","tag2"]
POST /api/entities/{entityId}/dataContracts HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 371
{
"name": "Data Contract Name",
"description": "Data Contract Description",
"source": "URL",
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
[
"value1",
"value2"
]
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
],
"tags": [
[
"tag1",
"tag2"
]
]
}
{
"success": true,
"datasetId": "id-123"
}
Get specific data contract of an entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
GET /api/entities/{entityId}/dataContracts/{dataContractId} HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true,
"data": {
"entityId": "entity123",
"createdBy": "user123",
"name": "Data Contract Name",
"description": "Data Contract Description",
"tags": [
[
"tag1",
"tag2"
]
],
"source": "URL",
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
"value1",
"value2"
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
],
"isDeleted": false,
"createdAt": "2023-06-27T12:45:00Z",
"updatedAt": "2023-06-27T12:45:00Z"
}
}
Update data contract of specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
Data Contract Name
Data Contract Description
URL
["tag1","tag2"]
POST /api/entities/{entityId}/dataContracts/{dataContractId}/update HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 371
{
"name": "Data Contract Name",
"description": "Data Contract Description",
"source": "URL",
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
[
"value1",
"value2"
]
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
],
"tags": [
[
"tag1",
"tag2"
]
]
}
{
"success": true
}
Delete data contracts of specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/dataContracts/{dataContractId}/delete HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Accept: */*
{
"success": true
}
Chat with the specified Data Contract for a specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
User input for the chat conversation.
Flag indicating whether the request is internal (true/false).
POST /api/entities/{entityId}/dataContracts/{dataContractId}/chat HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"userInput": "text",
"isInternal": true
}
{
"success": true,
"data": "Generated chat response",
"queryCount": 42
}
Upload a CSV file to create a new data contract for a specific entity.
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/uploadcsv HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: multipart/form-data
Accept: */*
Content-Length: 26
{
"uploaded_file": "binary"
}
{
"success": true,
"data": {
"entityId": "entity123",
"createdBy": "user123",
"name": "Data Contract Name",
"description": "Data Contract Description",
"tags": [
[
"tag1",
"tag2"
]
],
"source": "URL",
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
"value1",
"value2"
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
],
"isDeleted": false,
"createdAt": "2023-06-27T12:45:00Z",
"updatedAt": "2023-06-27T12:45:00Z"
}
}
Fetch only the fields in schema from Google Sheets & add new data contract
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
https://docs.google.com/spreadsheets/d/18L1234555555/
POST /api/entities/{entityId}/googlesheet HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 75
{
"googleSheetLink": "https://docs.google.com/spreadsheets/d/18L1234555555/"
}
{
"success": true,
"datasetId": "u-123"
}
Auto Generate the description using AI
The Id of the entity.
dummy-entityid
The Id of the user performing the request.
dummy-userid
The API key for authentication
test
The token for user authentication.
dummy-token
POST /api/entities/{entityId}/dataContracts/{dataContractId}/autoGenerate HTTP/1.1
Host: api.questprotocol.xyz
apikey: test
token: dummy-token
Content-Type: application/json
Accept: */*
Content-Length: 261
{
"fields": [
{
"name": "FieldName",
"description": "Field Description",
"validationRules": {
"type": "string",
"required": false,
"unique": false,
"nonnull": false,
"minLength": 0,
"maxLength": 255,
"enum": [
[
"value1",
"value2"
]
],
"regex": "^\\d{3}-\\d{2}-\\d{4}$",
"min": 0,
"max": 100
}
}
]
}
{
"success": true,
"res": "Generated description message"
}
Last updated