TechAppForce

Metadata API

Entities, fields, saved queries, screens, scripts, database connections, table and view definitions, environment diffs and releases.

Service
Metadata service
Base path
https://your-metadata-host/api/v1
Authentication
Bearer token and context headers.

The metadata service stores the definition of every application. Reads are cached per app and tenant. A tenant that subscribes to an app reads the app owner's definitions unless it has its own.

GET/api/v1/appobject/{appObjectName}

Get an entity with its fields

Returns the entity definition. Use appObjectId from the response as the entity's identifier.

Authentication
Bearer token and context headers
Permissions
Read access to the app
NameInRequiredDescription
appObjectNamepathYesThe entity name, for example Vendor.
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/appobject/{appObjectName}/relations

Get an entity with its relationships

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/appobject/flags

Turn entity features on or off

Features include tracking, search, sharing, versioning, comments, lifecycle, approvals, soft delete and layouts.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/metadata/schema

Get the whole application schema

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/query/{queryId}

Get a saved query

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/query

Get a saved query by entity and name

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
NameInRequiredDescription
appObjectNamequeryYesEntity name.
queryNamequeryYesSaved query name, for example List_Vendor.
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/query/upsert

Create or update a saved query

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/query/clone

Clone a saved query

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/screen/{screenId}

Get a screen definition for the signed-in user

Components the user may not use are marked hidden or disabled before the definition is returned.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/screen/upsert

Create or update a screen

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/customscript

List scripts for an entity

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/customscript/byname

Get a script by name

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/application/upserttable

Create or extend a table

Plans the change against the live schema and only creates, adds or alters; it never drops. A dry run returns the SQL without running it. Register the table as an entity afterwards.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/application/upsertview

Create or replace a view

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/application/registerappobjects

Register tables and views as entities

Creates the entity, its fields, default queries and default role access for each compatible table. Tables need a GUID primary key.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/application/syncappfields

Re-sync entity fields with the table

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/application/setup

Prepare an environment database

Applies the platform schema to the environment's database, and in Development registers compatible existing tables.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/customappfields/bulk

Add custom fields without a schema change

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/connections/test

Test an environment's database connection

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/connections/schema/validate

Check a database for compatible tables

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/release/diff/metadata

Compare definitions between two environments

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

GET/api/v1/release/diff/data

Compare configuration data between two environments

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.

POST/api/v1/release/apply

Apply a release to the next environment

Applies the selected definitions, configuration data (in foreign-key order) and migration scripts, then pins the target environment to the release version. The same release cannot be applied twice.

Authentication
Bearer token and context headers
Permissions
Your role's access to the resource
Detailed schema in preparation

The route is part of the service today. Its request and response schema will be published here; until then, use the OpenAPI document on your environment.