Job

Gets a specific revision for a job definition.

Changed on
get/job/definition/{definitionId}/revision/{revisionNumber}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/job/definition/{definitionId}/revision/{revisionNumber}
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

definitionIdstring required

The id of the job definition.

revisionNumberinteger required

The revision number to retrieve.

Response

OK

definitionIdstring required

The job definition id.

revisionNumberinteger required

The revision number.

state'Pending' | 'Completed' | 'Failed' required
pipelineIdstring required

The pipeline id.

datasetIdstring required

The dataset id.

aggregatorType'NonCommittal' | 'MajorityVote' | 'SimpleMatchup' | 'LocateCluster' | 'Classification' | 'Locate' | 'BoundingBox' | 'Line' | 'Transcription' | 'SinglePointLocate' | 'FreeText' | 'Scrub' | 'Ranking' | 'MultiRanking' nullable

The aggregator type.

validationSetIdstring nullable

The validation set pinned on this revision, or null when none is pinned.

baseRevisionNumberinteger nullable

The revision this one was edited from, when the caller supplied it.

createdAtstring date-time required

The creation timestamp.

createdByIdstring uuid required

The id of the user who created the revision.

createdByMailstring required

The email of the user who created the revision.

isInstructionComplexboolean nullable

Whether the instruction was flagged as too complex for the average annotator to understand. Null until the asynchronous complexity check has completed.

instructionComplexityReasonstring nullable

A short explanation of why the instruction was flagged, when applicable.

Changes

  • 004a977d7d9fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • c72c9f1c8ef5Revision changes
    • info

      removed the undefined enum value from the //// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status

    • info

      removed the undefined enum value from the /////////////////////// response property for the response status