1. Home
  2. Guides
  3. Concepts
  4. Tools
  5. References
    1. Apache Spark
    2. Built-in Functions
    3. Incorta Component SDK
    4. Incorta Connector SDK
    5. Connectors
    6. Copilot
    7. Data Studio
    8. Public API
      1. Public API v2
        1. Create External Schema
        2. Extract to External Table
        3. Append to External Table
        4. Delete External Table
        5. Delete External Schema
        6. List Catalog Content
        7. List Catalog Folder Content
        8. Search Catalog Content
        9. Create Catalog Folder
        10. Get SQLi Connectiont
        11. Schedule Dashboard Report
        12. Dashboard Prompts
        13. Rename & Move Dashboards
        14. Insight Query
        15. Execute Load Plan
        16. Load Plan Execution Status
        17. Restart Load Plan
        18. Query a Business View
        19. Load Schema
        20. Schema Status
        21. List Schemas
        22. List Schema Objects
        23. Reset Passwords
        24. Transfer Ownership
    9. Security
    10. SQL Interface
    11. Visualizations
    12. Other
  6. Integrations
  7. Data applications
  8. Release Notes
  9. Incorta Premium

Public API v2 → Restart Load Plan Endpoint

About the /load-plan/restart endpoint

The /load-plan/restart endpoint restarts a load plan and returns the execution ID. You can restart the load plan execution from the beginning, a specific group, or failed steps.

Important

Recovering failed steps requires turning on the Enable detailed load jobs tracking option in Server Configurations > Incorta Labs.

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

Use the HTTPS or HTTP scheme according to your installation. You must use the HTTPS scheme to successfully run the API endpoints on Cloud installations.

Endpoint Request

Request URL

https://<cluster_URL>/incorta/api/v2/{tenantName}/load-plan/restart
ParameterDescriptionTypeRequired
tenantNameThe tenant name (case-sensitive)StringRequired

HTTP method

POST

Request body

{  
  "loadPlanName": "string",  
  "groupSequence": 0,  
  "recentLoadPlanExecution": 0  
}
ParameterTypeDescriptionRequired
loadPlanNameStringThe name of the load plan you want to restart its execution (case-sensitive)Required
groupSequenceIntegerThe sequence of the load group to restart the execution fromRequired
recentLoadPlanExecutionIntegerThe ID of the load plan’s latest executionRequired only if you want to restart from the failed tasks of the specified load group

Example:

{  
  "loadPlanName": "MyLoadPlan",  
  "groupSequence": 1,  
  "recentLoadPlanExecution": 12  
}

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 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.

Endpoint response

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

CodeDescriptionPayload Response
200The endpoint successfully started the execution of the load plan.The execution ID.
Example:
{"loadPlanExecutionId": 3}
400Bad request{"message": "string"}
Example:
{"message": "INC_05290501: A load job cannot be started as another job of the same load plan is being executed. "}
401Unauthorized
  ●  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]"}
403Forbidden{"message": "string"}
Example:
{"message": "INC_02010000: You are not authorized to EDIT the OnlineStore SCHEMADEFINITION of ID [185]."}
404Not found
  ●  The tenant doesn't exist or is disabled.
  ●  The load plan cannot be found.		{"message": "string"}
Example:
{"message": "Invalid [DEFAULT] tenant in resource path"} {"message": "INC_05290503: The [SALES] LOAD_PLAN cannot be found."}
422Unprocessable Entity{"message": "string"}
Example:
{"message": "INC_01210000: loadPlanName may not be null"}
500Internal Server Error{"message": "string"}
Example:
{"message": "INC_05150402: No loader services are currently available for this tenant."}

The endpoint behavior

Restarting a load plan depends on two key parameters:

  • Load group sequence number
  • Execution ID

Without an Execution ID
If the execution ID is not provided, Incorta starts the load plan:

  • From the beginning, when sequence ≤ 0
  • From a specific group when sequence > 0

The restart fails if the specified group does not exist.

With an Execution ID
When a valid execution ID is provided (typically the ID of the latest run), Incorta behaves as follows:

  • Resumes from the first failed group when sequence ≤ 0
  • Restarts from a specific group when sequence > 0

In both cases, Incorta skips any steps that were already completed successfully in the load group where the restart begins.

The restart fails in any of the following cases:

  • The provided execution ID is not the most recent.
  • The provided execution does not include any failed groups.
  • The specified group does not exist.
  • The job history for the failed group is unavailable.