Update an execution's properties (admin only).

Authentication: JWT token required Authorization: Admin level access required Access: Only admin users can update execution properties

Path Parameters:

  • execution: Execution ID (UUID format)

Request Body:

{
  "status": "CANCELLED",
  "progress": 100,
  "results": {
    "reason": "User requested cancellation"
  }
}

Updatable Fields:

  • status: Execution status (PENDING, RUNNING, SUCCESS, FAILED, CANCELLED)
  • progress: Progress percentage (0-100)
  • results: Results data (JSON object)
  • end_date: End timestamp (ISO 8601 format)

Response Schema:

{
  "data": {
    "id": "abc123-def456",
    "script_id": "vegetation-analysis",
    "status": "CANCELLED",
    "progress": 100,
    "user_id": "user-789",
    "start_date": "2025-01-15T10:30:00Z",
    "end_date": "2025-01-15T10:35:00Z",
    "results": {
      "reason": "User requested cancellation"
    }
  }
}

Error Responses:

  • 401 Unauthorized: JWT token required
  • 403 Forbidden: Admin access required
  • 404 Not Found: Execution does not exist
  • 422 Unprocessable Entity: Invalid request data
  • 500 Internal Server Error: Server error
patch/api/v1/execution/{execution}

Path parameters

executionstring required

Path parameter: execution

Request body

object required

Response

Success

object required

Changes

No recorded changes to this endpoint across all 1 revision of this API.