Public API v2 → Load Plan Execution Status Endpoint

About the /load-plan/status/{execution-id} endpoint

The /load-plan /status/{execution-id} endpoint returns the status of a load plan execution. By default, this endpoint returns the load status of the load plan only. However, you can specify the level of details that the endpoint returns to include the status of loading groups, schemas, and objects.

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/{tenant}/load-plan/status/{execution-id}?level={DetailsLevel}

Request URL and query parameters

Parameter	Description	Type	Required
tenantName	The tenant name (case-sensitive)	String	Required
execution-id	The ID of the load plan execution that you want to get its status	Integer	Required
level	The level of details you want the endpoint to return. Valid values are: ● 1 (Default): The load plan execution status ● 2: The load plan execution status and the status per load group ● 3: The load plan execution status, load group status, and the status per schema ● 4: The load plan execution status, load group status, schema status, and the status per object	Integer	Optional

Request URL example

https://my-cluster.cloud.incorta.com/incorta/api/v2/default/load-plan/status/23?level=2

HTTP method

GET

Request headers

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

You must use a valid access token of a user who has at least View access rights to any schema in the load plan that you want to check its execution status.

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 returned the load plan execution status successfully.	The load job execution status and details according to the specified level. For more information, see Response parameters.
400	Bad request	`{"message": "string"}`
401	Unauthorized Invalid or expired access token.	`{"message": "string"}` Example: `{"message": "INC_09030108: Invalid authentication header. Invalid Token [abcde12345]"}`
403	Forbidden	`{"message": "string"}`
404	Not found ● The tenant doesn't exist. ● The load plan cannot be found.	`{"message": "string"}` Examples: `{"message" : "Invalid [DEFAULT] tenant in resource path"}` `{"message": "INC_05291904: The LOAD_PLAN of ID [111] cannot be found."}`
422	Unprocessable Entity	`{"message": "string"}`
500	Internal Server Error	`{"message": "string"}` Example: `{"message": "INC_05150402: No loader services are currently available for this tenant."}`

Response parameters

The following are the parameters in the /load-plan /status/{execution-id} endpoint response when the execution status and details are returned successfully (code 200).

{
  "name": "string",
  "type": "string",
  "status":  {
     "stateType": "string",
     "jobStatus": "string"},
  "childStatusDetails": [
      {
      "name": "string",
        "type": "string",
        "status": {
              "stateType": "string",
                "jobStatus": "string"},
        "childStatusDetails": [...]
}]
}

The following table describes these response parameters.

Parameter	Description	Type/Value
name	The name of the entity whose status details are returned. This can be the name of the load plan, a load group, a schema, or a schema object.	String
type	The entity type	String Expected values are: ● LOAD_PLAN ● GROUP ● SCHEMA ● TABLE
status	The details of the entity status
status > stateType	The returned state type	String Expected values are: ● Terminator State: indicates a completed job. ● Load State: indicates a running job.
status > jobStatus	The entity’s job status	String Expected values vary according to the state type and entity type.
childStatusDetails	The status details of the child entities: load group, schemas, and objects, according to the level of details specified. The details are the same as the status details of the load plan. (name, type, status...etc.).	Array of objects

Response example

The following is an example of the endpoint response.

{
  "name": "LoadPlan_Demo",
  "type": "LOAD_PLAN",
  "status": {
       "stateType": "Terminator State",
       "jobStatus": "Finished with Errors"},
  "childStatusDetails": [
       {
       "name": "Group 1",
       "type": "GROUP",
       "status": {
           "stateType": "Terminator State",
           "jobStatus": "Finished with Errors"},
       "childStatusDetails": [
           {
           "name": "OnlineStore",
           "type": "SCHEMA",
           "status": {
               "stateType": "Terminator State",
               "jobStatus": "Finished with Errors"},
           "childStatusDetails": [
               {
               "name": "OnlineStore.productmodel",
               "type": "TABLE",
               "status": {
                   "stateType": "Terminator State",
                   "jobStatus": "Success"}
               },
]}]}]}

Content