JobExecution

Create an execution of a Hyperscale Job.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
job_id
required
integer <int64>

The ID number of the hyperscale masking job for which the execution need to be created.

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/executions
Request samples
application/json
{
  • "job_id": 1
}
Response samples
application/json
{
  • "id": 72,
  • "job_id": 5,
  • "status": "SUCCEEDED",
  • "create_time": "2022-12-18T13:38:43.722917Z",
  • "end_time": "2022-12-18T13:43:16.554603Z",
  • "total_objects": 4,
  • "total_rows": 16,
  • "tasks": [
    ]
}

Returns a list of all the executions of a Hyperscale Job in the detailed format.

SecurityApiKeyAuth
Request
query Parameters
job_id
required
integer <int64>

Numeric ID of the Hyperscale Job

Responses
200

OK

404

Object Not Found.

get/executions
Response samples
application/json
[
  • {
    }
]

Returns a list of all the Execution summaries of a Hyperscale Job.

SecurityApiKeyAuth
Request
query Parameters
job_id
required
integer <int64>

Numeric ID of the Hyperscale Job

Responses
200

OK

404

Object Not Found.

get/executions/summary
Response samples
application/json
[
  • {
    }
]

Returns the Job Execution Details by ID.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job Execution.

query Parameters
task
required
string
Default: "ALL"

Task for which details are needed in the response.

Enum: "Unload" "Masking" "Load" "Post Load" "ALL"
object_status
required
string
Default: "ALL"

Status of the objects i.e. source files or tables whose details are needed in the response.

Enum: "FAILED" "SUCCEEDED" "RUNNING" "ALL"
object_details_status
required
string
Default: "ALL"

Status of the post load object details, applicable only for post load task, i.e. constraints, indexes and triggers status.

Enum: "FAILED" "SUCCEEDED" "RUNNING" "ALL"
Responses
200

OK

404

Object Not Found.

get/executions/{id}
Response samples
application/json
{
  • "id": 72,
  • "job_id": 5,
  • "status": "SUCCEEDED",
  • "create_time": "2022-12-18T13:38:43.722917Z",
  • "end_time": "2022-12-18T13:43:16.554603Z",
  • "total_objects": 4,
  • "total_rows": 16,
  • "tasks": [
    ]
}

Clean-up the execution by Id

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job Execution.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/executions/{id}

Returns the Job Execution summary by its ID.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job Execution.

Responses
200

OK

404

Object Not Found.

get/executions/{id}/summary
Response samples
application/json
{
  • "id": 72,
  • "job_id": 5,
  • "status": "SUCCEEDED",
  • "create_time": "2022-12-18T13:38:43.722917Z",
  • "end_time": "2022-12-18T13:43:16.554603Z",
  • "total_objects": 4,
  • "total_rows": 16,
  • "tasks": [
    ]
}

Restart a failed execution.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job Execution.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

put/executions/{id}/restart
Response samples
application/json
{
  • "id": 72,
  • "job_id": 5,
  • "status": "SUCCEEDED",
  • "create_time": "2022-12-18T13:38:43.722917Z",
  • "end_time": "2022-12-18T13:43:16.554603Z",
  • "total_objects": 4,
  • "total_rows": 16,
  • "tasks": [
    ]
}

Cancel a running execution.

SecurityApiKeyAuth
Request
path Parameters
id
required
integer <int64> >= 1

Numeric ID of the Job Execution.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

put/executions/{id}/cancel
Response samples
application/json
{
  • "id": 72,
  • "job_id": 5,
  • "status": "SUCCEEDED",
  • "create_time": "2022-12-18T13:38:43.722917Z",
  • "end_time": "2022-12-18T13:43:16.554603Z",
  • "total_objects": 4,
  • "total_rows": 16,
  • "tasks": [
    ]
}
➔ Next to Sync