Get job iteration

client.jobIterations.retrieve(, ?): JobIterationRetrieveResponse { id, created_at, iteration_name, 7 more }

GET/api/job-iterations/{id}/

Get job iteration

ParametersExpand Collapse

id: string

formatuuid

ReturnsExpand Collapse

JobIterationRetrieveResponse { id, created_at, iteration_name, 7 more }

id: string

formatuuid

created_at: string

formatdate-time

iteration_name: string

maxLength64

job: string

formatuuid

agent_code?: string

avg_score?: number

formatdouble

description?: string

dimension_scores?: unknown

order?: number

maximum9223372036854776000

minimum-9223372036854776000

formatint64

status?: "keep" | "discard"

keep - Keep
discard - Discard

Accepts one of the following:

"keep"

"discard"

Get job iteration

import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const jobIteration = await client.jobIterations.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(jobIteration.id);

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "iteration_name": "iteration_name",
  "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_code": "agent_code",
  "avg_score": 0,
  "description": "description",
  "dimension_scores": {},
  "order": -9007199254740991,
  "status": "keep"
}

Returns Examples

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "created_at": "2019-12-27T18:11:19.117Z",
  "iteration_name": "iteration_name",
  "job": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "agent_code": "agent_code",
  "avg_score": 0,
  "description": "description",
  "dimension_scores": {},
  "order": -9007199254740991,
  "status": "keep"
}