Public API v2 → Load Schema Tables Endpoint

About the /schema/{schemaName}/load endpoint

The /schema/{schemaName}/load endpoint starts a load job for a specific schema, or for one or more tables within that schema. Unlike the /schema/load endpoint, which loads multiple schemas at once, this endpoint targets a single schema identified in the request path. It optionally scopes the load to specific tables within it.

This endpoint is available starting with v8.1.0 - 2026.8.

For information about how to get started with Public API v2, refer to References → Public API v2.

Request URL

https://<cluster_URL>/incorta/api/v2/{tenant}/schema/{schemaName}/load

Request URL Parameters

Parameter	Type	Description	Required?
tenant	String	The tenant name (case-sensitive)	Required
schemaName	String	The name of the schema to load (case-sensitive)	Required

HTTP method

POST

Request headers

{
  "Content-Type": "application/json",
  "Accept": "application/json",
  "Authorization": "Bearer {access_token}"
}

You must use a valid access token of a Super User or a user with the Super Role, Schema Manager, or Schema User role, and this user has edit access rights to the physical schema you want to load.

For information about how to create an access token, refer to Public API v2 → Create an API access token.

Request body

{
  "tables": ["string" ],
  "loadSource": "string"
}

Request body parameters

Parameter	Type	Description	Required?
tables	Array of strings	The list of schema tables you want to load, separated by commas (case-sensitive). If omitted or empty, the endpoint loads the whole schema.	Optional
loadSource	String	The load type. The following are the valid values (case-sensitive): ● FULL ● INCREMENTAL ● STAGING ● PURGING	Required

Request body example

{
  "tables": ["Customers", "Orders"],
  "loadSource": "FULL"
}

Endpoint response

Code	Description	Payload Response
200	Started Load Job Successfully The endpoint successfully started the load job.	The unique identifier of the load job that the endpoint started. `{"loadJobGuid": "string"}` Example: `{"loadJobGuid": "6f9c1w2e-3b4d-1v5f-8a6b-7x8e9f0a1b2c" }`
400	Bad Request You provided invalid values.	`{"message": "string"}` Example: Cannot deserialize value of type `com.incorta.publicapi.model.schema.common.SchemaProperties$LoadSource` from String "full": not one of the values accepted for Enum class: [PURGING, INCREMENTAL, NA, FULL, STAGING]
401	Unauthorized The endpoint couldn't start the load job due to authentication errors, such as an invalid or expired access token.	`{"message": "string"}` Example: `{ "message": "INC_09030108: Invalid authentication header. Invalid Token [+ui37sqittnMaP8zJrwR10/FjUeQe795vRXouPXcCd6jKA7Lbb77jbK9WzoW0nRlw==]" }`
403	Forbidden You don't have access rights to load the specified schema.	`{"message": "string"}` Example: `{"message": "INC_02010000: You are not authorized to EDIT the Audit SCHEMADEFINITION of ID [2,516]" }`
404	Resource Not Found The tenant, schema, or table doesn't exist.	`{"message": "string"}` Example: `{"message": "INC_05020803: The [Audit.Orders] SCHEMADEFINITION cannot be found." }`
422	Unprocessable Entity You provided a value that is out of the accepted range or an invalid enum value.	`{"message": "string"}` Example: `{"errorMessages": [{"message": "INC_01210000: loadSource must not be null"}]}`
500	Internal Server Error The endpoint couldn't start the load job due to a server error or another load job for the same schema is running.	`{"message": "string"}` Example: `{"message": "INC_05270502: A load job cannot be started as the following schemas are currently running: Audit"}`

Content