Sign in

Update a specific iteration.

patch/projects/{projectId}/iterations/{iterationId}

Path parameters

projectIdstring uuid required

Project id.

iterationIdstring uuid required

Iteration id.

Request body

idstring uuid

Gets the id of the iteration.

namestring required

Gets or sets the name of the iteration.

statusstring

Gets the current iteration status.

createdstring date-time

Gets the time this iteration was completed.

lastModifiedstring date-time

Gets the time this iteration was last modified.

trainedAtstring date-time nullable

Gets the time this iteration was last modified.

projectIdstring uuid

Gets the project id of the iteration.

exportableboolean

Whether the iteration can be exported to another format for download.

exportableTostring[]

A set of platforms this iteration can export to.

domainIdstring uuid nullable

Get or sets a guid of the domain the iteration has been trained on.

classificationType'Multiclass' | 'Multilabel' nullable

Gets the classification type of the project.

trainingType'Regular' | 'Advanced'

Gets the training type of the iteration.

reservedBudgetInHoursinteger

Gets the reserved advanced training budget for the iteration.

trainingTimeInMinutesinteger

Gets the training time for the iteration.

publishNamestring

Name of the published model.

originalPublishResourceIdstring

Resource Provider Id this iteration was originally published to.

Response

OK

idstring uuid

Gets the id of the iteration.

namestring required

Gets or sets the name of the iteration.

statusstring

Gets the current iteration status.

createdstring date-time

Gets the time this iteration was completed.

lastModifiedstring date-time

Gets the time this iteration was last modified.

trainedAtstring date-time nullable

Gets the time this iteration was last modified.

projectIdstring uuid

Gets the project id of the iteration.

exportableboolean

Whether the iteration can be exported to another format for download.

exportableTostring[]

A set of platforms this iteration can export to.

domainIdstring uuid nullable

Get or sets a guid of the domain the iteration has been trained on.

classificationType'Multiclass' | 'Multilabel' nullable

Gets the classification type of the project.

trainingType'Regular' | 'Advanced'

Gets the training type of the iteration.

reservedBudgetInHoursinteger

Gets the reserved advanced training budget for the iteration.

trainingTimeInMinutesinteger

Gets the training time for the iteration.

publishNamestring

Name of the published model.

originalPublishResourceIdstring

Resource Provider Id this iteration was originally published to.

Changes

Changed in 3 of the 12 revisions of this API.114

  • e873dad2a18912See the full diff
    • ●

      deleted the header request parameter Training-Key

      request-parameter-removed

    • ○

      api operation id UpdateIteration removed and replaced with Iterations_Update

      api-operation-id-removed

    • ○

      api tag ProjectApi removed

      api-tag-removed

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

  • 82dfb72c78fa2See the full diff
    • ○

      api operation id Iterations_Update removed and replaced with UpdateIteration

      api-operation-id-removed

    • ○

      api tag ProjectApi added

      api-tag-added

  • 8feb7cde15fc1See the full diff
    • ▲

      added the new required header request parameter Training-Key

      new-required-request-parameter

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