Public API v2 → Execute Load Plan Endpoint

About the /load-plan/execute endpoint

The /load-plan/execute endpoint executes a load plan and returns the execution ID.

Note

You can use the execution ID to check the execution status using the Load Plan Execution Status (/load-plan/status/{execution-id}) endpoint.

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

Note

You must use the HTTPS scheme to be able to successfully run the API endpoints. Additionally, you must specify the tenant name (case-sensitive) in the endpoint request URL.

Request URL

https://<cluster_URL>/incorta/api/v2/{tenantName}/load-plan/execute

Parameter	Description	Type	Required
tenantName	The tenant name (case-sensitive)	String	Required

HTTP method

POST

Request body

{
   "loadPlanName": "string"
}

Parameter	Type	Description	Required
loadPlanName	String	The load plan you want to execute (case-sensitive)	Required

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 SuperRole or Schema Manager role. Additionally, this user must have edit access rights to all schemas in the load plan that you want to execute.

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

Request headers example

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

Endpoint response

The following table shows the HTTP response status codes for this endpoint.

Code	Description	Payload Response
200	The endpoint started the execution of the load plan successfully.	The execution ID. Example: `{"loadPlanExecutionId": 3}`
400	Bad request	`{"message": "string"}` Example: `{"message": "INC_05290501: A load job cannot be started as another job of the same load plan is being executed. "}`
401	Unauthorized ● Invalid or expired access token. ● The tenant name doesn’t match the tenant in the access token.	`{"message": "string"}` Example: `{"message": "INC_09030108: Invalid authentication header. Invalid Token [abcde12345]"}`
403	Forbidden	`{"message": "string"}` Example: `{"message": "INC_02010000: You are not authorized to EDIT the OnlineStore SCHEMADEFINITION of ID [185]."}`
404	Not found ● The tenant doesn't exist or is disabled. ● The load plan cannot be found.	`{"message": "string"}` Examples: `{"message" : "Invalid [DEFAULT] tenant in resource path"}` `{"message": "INC_05290503: The [SALES] LOAD_PLAN cannot be found."}`
422	Unprocessable Entity	`{"message": "string"}` Example: `{"message": "INC_01210000: loadPlanName may not be null"}`
500	Internal Server Error	`{"message": "string"}` Example: `{"message": "INC_05150402: No loader services are currently available for this tenant."}`

Content