Sign in

Create Run

Create a new Run.

post/projects/{projectId}/runs

Path parameters

projectIdstring required
Example:314

The ID of the Project.

Request body

testsetIdstring nullable

The ID of the Testset this Run is testing.

systemVersionIdstring uuid nullable

The ID of the system version this Run is using.

metricIdsstring[] required

The IDs of the metrics this Run is using.

Response

Run created successfully

idstring required

The ID of the Run.

testsetIdstring nullable required

The ID of the Testset this Run is testing.

systemIdstring uuid nullable required

The ID of the system this Run is using.

systemVersionIdstring uuid nullable required

The ID of the system version this Run is using.

metricIdsstring[] required

The IDs of the metrics this Run is using.

metricVersionIdsstring[] required

The IDs of the metric versions this Run is using.

numRecordsnumber required

The number of records in the Run.

numExpectedRecordsnumber nullable required

The number of expected records in the Run. Determined by the number of testcases in the Run's Testset at the time of Run creation.

numScoresnumber required

The number of completed scores in the Run so far.

status'pending' | 'awaiting_execution' | 'running_execution' | 'awaiting_scoring' | 'running_scoring' | 'awaiting_human_scoring' | 'completed' required

The status of the Run.

Changes

Changed in 4 of the 37 revisions of this API.2212

  • 47c2214e718017See the full diff
    • ▲

      the response property systemVersionId became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property systemVersionId became nullable

      request-property-became-nullable

    • ○

      the response property systemVersionId became required for the status 201

      response-property-became-required

    • ○

      added the required property metricVersionIds to the response with the 201 status

      response-required-property-added

    • ○

      added the required property numExpectedRecords to the response with the 201 status

      response-required-property-added

    • ○

      added the required property numRecords to the response with the 201 status

      response-required-property-added

    • ○

      added the required property numScores to the response with the 201 status

      response-required-property-added

    • ○

      added the required property systemId to the response with the 201 status

      response-required-property-added

  • f8f811fe2ec922See the full diff
    • ●

      removed the request property systemConfigId

      request-property-removed

    • ●

      removed the optional property systemConfigId from the response with the 201 status

      response-optional-property-removed

    • ○

      added the new optional request property systemVersionId

      new-optional-request-property

    • ○

      added the optional property systemVersionId to the response with the 201 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b33acf308c1f12See the full diff
    • ▲

      the response property testsetId became nullable for the status 201

      response-property-became-nullable

    • ○

      the request property testsetId became nullable

      request-property-became-nullable

    • ○

      the request property testsetId became optional

      request-property-became-optional

  • e3159f1f21c41See the full diff
    • ○

      added the required property status to the response with the 201 status

      response-required-property-added