NUnugen
Alignment Projects

Stop Alignment

Stop an in-progress train-time alignment.

Path Parameters:

  • alignment_id: Alignment project identifier

Returns:

  • alignment_id: ID of the stopped alignment project
  • status: New status

Raises:

  • 400: If the alignment is already in a terminal state or has not started train-time alignment yet
  • 404: If the alignment project is not found or does not belong to the user
  • 502: If the train GPU server rejected the stop request
  • 503: If the train GPU server is unreachable
post/api/v3/alignment-projects/{alignment_id}/stop

Request

  • Base URL
    https://api.nugen.in
  • Auth
    HTTP bearer

Path parameters

alignment_idstring required

ID of the alignment project, returned when it was created

Response

Stops an in-progress train-time alignment and marks the alignment project as STOPPED.

alignment_idstring required

Identifier of the stopped alignment project.

status'QUEUED' | 'PROCESSING' | 'READY' | 'FAILED' | 'STOPPED' required

Lifecycle status of a resource that runs asynchronously. Stored as is and returned as is, with no translation in between.

  • QUEUED: accepted and waiting for its workflow to start
  • PROCESSING: running
  • READY: finished successfully
  • FAILED: failed at any stage
  • STOPPED: stopped by the user before completion

Changes

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