amsdal-server 0.1.0

The API server is a RESTful API that allows you to perform CRUD operations on the data stored in the database. The API server is built using the FastAPI framework.

You can use AMSDAL CLI to run the development API server locally with amsdal serve command.

Authentication

By default, AMSDAL Server does not require authentication for API requests. You can enable authentication by setting permissions for your models.

See more details about Auth mechanism of AMSDAL Auth plugin here: AMSDAL Auth

In order to authorize you need to get token and put it into Authorization header.

Use the /api/objects/ to get token by user's email and password. For example, using cURL:

curl --location 'https://example.com/api/objects/?class_name=LoginSession' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "myuser@example.com",
    "password": "myuserpassword"
}'

Note

Replace example.com domain to yours one.

After receiving token, you need to put it in Authorization header. For example:

Authorization: hSdjw1723bbdfFLqwJgah32

Filters

Some endpoints support filtering. You can filter the results by adding a query parameter filter to the URL.

To use filters, use the following syntax:

?filter[<field_name>__<field_type>]=<value>

where - field_name - the name of the field you want to filter by - field_type - filter operator

We support the following filter types:

• eq - equal
• neq - not equal
• gt - greater than to value
• gte - greater than or equal to value
• lt - less than to value
• lte - less than or equal to value
• contains - contains the value (case sensitive)
• startswith - starts with value (case sensitive)

Examples:

/classes/Person?filter[firstname__eq]=Employee

/classes/Person?filter[firstname__startswith]=Empl

Fields restrictions

In order to optimize requests, we want to omit some fields when querying for objects.

To do this, we should be able to optionally specify a fields[TYPE] field in the object request that will accept, separated by commas, the fields we want to receive from the server. TYPE - is the type of requested object, so in the common case it will be name of the requested class, or Metadata.

For example:

/classes/EmployeeProfile?include_metadata=true&fields[EmployeeProfile]=first_nam
e,last_name&fields[Metadata]=address,version_id

All object fields with some metadata fields:

/classes/EmployeeProfile?fields[Metadata]=lakehouse_address

You can limit to only one field:

/classes/EmployeeProfile?fields[Metadata]=lakehouse_address&fields[EmployeeProfi
le]=first_name

Also, you can omit all the fields, just leave the values blank:

/classes/EmployeeProfile?fields[Metadata]=lakehouse_address&fields[EmployeeProfi
le]=

---

Classes

---

POST /api/classes/

Class Create

Description

Register a class.

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
skip_data_migrations	query	boolean	False	No

Request body

application/json

{
    "class_schema": {
        "title": "string",
        "type": "string",
        "properties": {},
        "required": [
            "string"
        ],
        "indexed": [
            "string"
        ],
        "unique": [
            [
                "string"
            ]
        ],
        "custom_code": "string"
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "properties": {
        "class_schema": {
            "$ref": "#/components/schemas/ClassSchema"
        }
    },
    "type": "object",
    "required": [
        "class_schema"
    ],
    "title": "RegisterClassData"
}

Response 200 OK

application/json

{
    "class": "string",
    "properties": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "class": {
            "type": "string",
            "title": "Class"
        },
        "properties": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Properties"
        },
        "count": {
            "type": "integer",
            "title": "Count",
            "default": 0
        }
    },
    "type": "object",
    "required": [
        "class",
        "properties"
    ],
    "title": "ClassInfo"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/classes/

Class List

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
cache_control	query	None		No	Cache-Control max-age value

Response 200 OK

application/json

{
    "columns": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "rows": [
        null
    ],
    "total": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "rows": {
            "items": {},
            "type": "array",
            "title": "Rows"
        },
        "total": {
            "type": "integer",
            "title": "Total"
        }
    },
    "type": "object",
    "required": [
        "columns",
        "rows",
        "total"
    ],
    "title": "ObjectsResponse"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

DELETE /api/classes/{class_name}/

Class Delete

Description

Delete a class.

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
class_name	path	string		No

Response 204 No Content

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/classes/{class_name}/

Get Class

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
cache_control	query	None		No	Cache-Control max-age value
class_name	path	string		No

Response 200 OK

application/json

{
    "class": "string",
    "properties": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "class": {
            "type": "string",
            "title": "Class"
        },
        "properties": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Properties"
        },
        "count": {
            "type": "integer",
            "title": "Count",
            "default": 0
        }
    },
    "type": "object",
    "required": [
        "class",
        "properties"
    ],
    "title": "ClassInfo"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Objects

---

POST /api/objects/bulk-create/

Object Bulk Create

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
class_name	query	string		No
load_references	query	boolean	False	No

Request body

application/json

[
    {}
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "array",
    "items": {
        "type": "object"
    },
    "title": "Data"
}

Response 201 Created

application/json

[
    {}
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "type": "object"
    },
    "title": "Response Object Bulk Create Api Objects Bulk Create  Post"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

PUT /api/objects/bulk-update/

Object Bulk Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
load_references	query	boolean	False	No

Request body

application/json

[
    {
        "address": "string",
        "data": {}
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/BulkUpdateBody"
    },
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Bulk Update Api Objects Bulk Update  Put"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/objects/bulk-update/

Object Bulk Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
load_references	query	boolean	False	No

Request body

application/json

[
    {
        "address": "string",
        "data": {}
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/BulkUpdateBody"
    },
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Bulk Update Api Objects Bulk Update  Post"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

PATCH /api/objects/bulk-update/

Object Bulk Partial Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
load_references	query	boolean	False	No

Request body

application/json

[
    {
        "address": "string",
        "data": {}
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/BulkUpdateBody"
    },
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Bulk Partial Update Api Objects Bulk Update  Patch"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/objects/bulk-delete/

Object Bulk Delete

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key

Request body

application/json

[
    {
        "address": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "items": {
        "$ref": "#/components/schemas/BulkAddressBody"
    },
    "type": "array",
    "title": "Data"
}

Response 204 No Content

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/objects/file-download/{object_id}/

File Download

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
height	query	None		No
object_id	path	string		No
version_id	query	string		No
width	query	None		No

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/objects/download-file/

Download File

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
height	query	None		No
object_id	query	string		No
version_id	query	string		No
width	query	None		No

Response 200 OK

application/json

Schema of the response body

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/objects/

Object Create

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
class_name	query	string		No
load_references	query	boolean	False	No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Data"
}

Response 201 Created

application/json

Schema of the response body

{
    "type": "object",
    "title": "Response Object Create Api Objects  Post"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/objects/

Object List

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
all_versions	query	boolean	False	No
cache_control	query	None		No	Cache-Control max-age value
class_name	query	string		No
file_optimized	query	boolean	False	No
include_metadata	query	boolean	True	No
include_subclasses	query	boolean	False	No
load_references	query	boolean	False	No
ordering	query	None		No
page	query	integer	1	No
page_size	query	None		No
select_related	query	None		No	Comma-separated list of related fields to fetch

Response 200 OK

application/json

{
    "columns": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "rows": [
        null
    ],
    "total": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "rows": {
            "items": {},
            "type": "array",
            "title": "Rows"
        },
        "total": {
            "type": "integer",
            "title": "Total"
        }
    },
    "type": "object",
    "required": [
        "columns",
        "rows",
        "total"
    ],
    "title": "ObjectsResponse"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

DELETE /api/objects/{address}/

Object Delete

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
address	path	string		No

Response 204 No Content

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/objects/{address}/

Object Detail

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
address	path	string		No
all_versions	query	boolean	False	No
cache_control	query	None		No	Cache-Control max-age value
file_optimized	query	boolean	False	No
include_metadata	query	boolean	True	No
select_related	query	None		No	Comma-separated list of related fields to fetch
version_id	query	string		No

Response 200 OK

application/json

{
    "columns": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "rows": [
        null
    ],
    "total": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "rows": {
            "items": {},
            "type": "array",
            "title": "Rows"
        },
        "total": {
            "type": "integer",
            "title": "Total"
        }
    },
    "type": "object",
    "required": [
        "columns",
        "rows",
        "total"
    ],
    "title": "ObjectsResponse"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

PUT /api/objects/{address}/

Object Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
address	path	string		No
load_references	query	boolean	False	No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Update Api Objects  Address   Put"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/objects/{address}/

Object Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
address	path	string		No
load_references	query	boolean	False	No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Update Api Objects  Address   Post"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

PATCH /api/objects/{address}/

Object Partial Update

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
address	path	string		No
load_references	query	boolean	False	No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Data"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Object Partial Update Api Objects  Address   Patch"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

POST /api/objects/{address}/validate/

Object Validate

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
class_name	query	string		No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Data"
}

Response 204 No Content

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Transactions

---

POST /api/transactions/{transaction_name}/

Transaction Execute

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
transaction_name	path	string		No

Request body

application/json

Schema of the request body

{
    "type": "object",
    "title": "Args"
}

Response 200 OK

application/json

Schema of the response body

{
    "title": "Response Transaction Execute Api Transactions  Transaction Name   Post"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/transactions/{transaction_name}/

Transaction Detail

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
cache_control	query	None		No	Cache-Control max-age value
transaction_name	path	string		No

Response 200 OK

application/json

{
    "columns": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "rows": [
        null
    ],
    "control": {}
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "rows": {
            "items": {},
            "type": "array",
            "title": "Rows"
        },
        "control": {
            "type": "object",
            "title": "Control"
        }
    },
    "type": "object",
    "required": [
        "columns",
        "rows",
        "control"
    ],
    "title": "ObjectsResponseControl"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

---

GET /api/transactions/

Transaction List

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key
cache_control	query	None		No	Cache-Control max-age value

Response 200 OK

application/json

{
    "columns": [
        {
            "type": null,
            "value": null,
            "key": null,
            "label": null,
            "description": null,
            "order": null,
            "options": null,
            "cellTemplateName": null,
            "control": null,
            "validation": null,
            "column_format": null,
            "items": null,
            "next_control": null,
            "head_control": null,
            "read_only": null,
            "required": null,
            "attributes": null,
            "array_type": null,
            "dict_type": null,
            "item_format": null,
            "filters": null
        }
    ],
    "rows": [
        null
    ],
    "total": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "columns": {
            "items": {
                "$ref": "#/components/schemas/ColumnInfo"
            },
            "type": "array",
            "title": "Columns"
        },
        "rows": {
            "items": {},
            "type": "array",
            "title": "Rows"
        },
        "total": {
            "type": "integer",
            "title": "Total"
        }
    },
    "type": "object",
    "required": [
        "columns",
        "rows",
        "total"
    ],
    "title": "ObjectsResponse"
}

Response 422 Unprocessable Entity

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string"
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Probes

---

GET /api/probes/liveness/

Liveness Probe

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key

Response 200 OK

application/json

Schema of the response body

---

GET /api/probes/readiness/

Readiness Probe

Input parameters

Parameter	In	Type	Default	Nullable	Description
AmsdalAuth	header	string	N/A	No	API key

Response 200 OK

application/json

Schema of the response body

---

Schemas

BulkAddressBody

Name	Type
address	string

BulkUpdateBody

Name	Type
address	string
data

ClassInfo

Name	Type
class	string
count	integer
properties	Array<ColumnInfo>

ClassSchema

Name	Type
custom_code	string
indexed	Array<string>
properties
required	Array<string>
title	string
type	string
unique	Array<Array<string>>

ColumnFilter

Name	Type
filters
label
name
tooltip

ColumnFormat

Name	Type
cellTemplate
headerTemplate

ColumnInfo

Name	Type
array_type
attributes
cellTemplateName
column_format
control
description
dict_type
filters
head_control
item_format
items
key
label
next_control
options
order
read_only
required
type
validation
value

DictItem

Name	Type
key	TypeSchema
value	TypeSchema

FieldFilter

Name	Type
control	FieldFilterControl
type	string

FieldFilterControl

Name	Type
key	string
label
options
placeholder
type	FieldFilterInputType
value

FieldFilterInputType

Type: string

HTTPValidationError

Name	Type
detail	Array<ValidationError>

ObjectsResponse

Name	Type
columns	Array<ColumnInfo>
rows	Array<>
total	integer

ObjectsResponseControl

Name	Type
columns	Array<ColumnInfo>
control
rows	Array<>

Option

Name	Type
key	string
value	string

OptionSchema

Name	Type
key	string
value	string

PropertySchema

Name	Type
default
items
options
title
type	string

RegisterClassData

Name	Type
class_schema	ClassSchema

TypeSchema

Name	Type
items
type	string

ValidationError

Name	Type
loc	Array<>
msg	string
type	string

Validator

Name	Type
data
name	string

Security schemes

Name	Type	Scheme	Description
AmsdalAuth	apiKey