Job

Gets a job definition by its id.

Changed on
get/job/definition/{definitionId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/job/definition/{definitionId}
  • 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 to retrieve.

Response

OK

definitionIdstring required

The job definition id.

namestring required

The name of the job definition.

definitionType'Unknown' | 'Classify' | 'Compare' | 'BoundingBox' | 'Line' | 'Polygon' | 'Locate' | 'Transcription' | 'NamedEntity' | 'FreeText' | 'Scrub' | 'Ranking' | 'GroupedRanking' | 'Evaluation' required
isPublicboolean required

Whether the definition is shared publicly as a reusable template.

createdAtstring date-time required

The creation timestamp.

ownerIdstring uuid required

The id of the job definition's owner.

ownerMailstring required

The email of the job definition's owner.

organizationIdstring required

The id of the organization that owns the entity.

Changes