API Documentation
Health Check
Tenant Options
Get Tenant Options
Authorizations
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/tenant-options HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"options_values": [
{
"name": "text",
"values": [
"text"
]
}
]
}
Add Tenant Options
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-options HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"options": [
{
"name": "text",
"values": [
"text"
]
}
]
}
{
"message": "text"
}
Product Options
Get Product Options
Authorizations
Query parameters
limitany ofOptional
Maximum number of records to return
integer Β· min: 1Optional
nullOptional
offsetany ofOptional
Number of records to skip
integerOptional
nullOptional
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/product-options HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"options_values": [
{
"product": "text",
"option_values": [
{
"option_name": "text",
"option_values": [
"text"
]
}
]
}
]
}
Add Product Options
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/product-options HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"product_options": [
{
"product": "text",
"option_values": [
{
"option_name": "text",
"option_values": [
"text"
]
}
]
}
]
}
{
"message": "text"
}
Tenant Data Connection Configs
Get Tenant Data Connections
Get all data connection configs for the current tenant.
Authorizations
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
GET /v1/tenant-data-conn-configs HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"data_connections": [
{
"name": "text",
"type": "text",
"configs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
Create Tenant Data Connections
Add data connection configs for the current tenant.
Authorizations
Header parameters
correlation-idstringRequired
Body
Request model for adding one or more dataβconnection configs to a tenant.
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-data-conn-configs HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 101
{
"data_connections": [
{
"name": "text",
"type": "text",
"configs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
{
"message": "text"
}
Update Tenant Data Connection
Update dataβconnection config by name for the current tenant.
Authorizations
Path parameters
namestringRequired
Header parameters
correlation-idstringRequired
Body
typeany ofOptional
New connection type, if updating
stringOptional
nullOptional
configsany ofOptional
New configs map, if updating
or
nullOptional
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /v1/tenant-data-conn-configs/{name} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"type": "text",
"configs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
{
"message": "text"
}
Delete Tenant Data Connection
DELETE one dataβconnection config by name for the current tenant.
Authorizations
Path parameters
namestringRequired
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/tenant-data-conn-configs/{name} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"message": "text"
}
Users
Get Users
Authorizations
Query parameters
roleany ofOptional
Filter users by role
string Β· enumOptionalPossible values:
nullOptional
Header parameters
correlation-idstringRequired
Responses
200
List of users retrieved successfully
application/json
400
Bad Request
422
Validation Error
application/json
500
Internal server error
get
GET /v1/users HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"users": [
{
"user_name": "text",
"email_id": "text",
"tenant_id": "text",
"tenant_name": "text",
"role": "CANSO_ADMIN",
"status": "ACTIVE"
}
]
}
Tenant Data ET Configs
Create Tenant Data ET
Authorizations
Header parameters
correlation-idstringRequired
Body
Responses
201
Successful Response
application/json
422
Validation Error
application/json
post
POST /v1/tenant-data-et-configs HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"data_ets": [
{
"unit_name": "text",
"configs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
]
}
{
"message": "text"
}
Update Tenant Data ET
Update data ET config by unit_name for the current tenant.
Authorizations
Path parameters
unit_namestringRequired
Header parameters
correlation-idstringRequired
Body
Responses
200
Successful Response
application/json
422
Validation Error
application/json
patch
PATCH /v1/tenant-data-et-configs/{unit_name} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"configs": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
{
"message": "text"
}
Delete Tenant Data ET
DELETE one data ET config by unit_name for the current tenant.
Authorizations
Path parameters
unit_namestringRequired
Header parameters
correlation-idstringRequired
Responses
200
Successful Response
application/json
422
Validation Error
application/json
delete
DELETE /v1/tenant-data-et-configs/{unit_name} HTTP/1.1
Host:
Authorization: Bearer YOUR_OAUTH2_TOKEN
correlation-id: text
Accept: */*
{
"message": "text"
}
Last updated
Was this helpful?