Update request phase

1 min

PATCH

https://api.app.kognic.com/v1/request-phases/{requestPhaseId}

Update name and configuration of a phase. The configuration replaces the phase's current one, so send every field, not only the ones that change. Returns 400 if the configuration does not match the phase's type, or if perInputFrameSampling is present with a sampleRatePercent outside 1-100.

Path Parameters

requestPhaseIdstring<uuid>required
Format
uuid

Body Parameters

bodyUpdateRequestPhaserequired
Description
Phase to update. Configuration should correspond to the type of the phase
- configPhaseConfig
  - AnnotatePhaseConfig
    - configClassstringrequired
  - BasicReviewPhaseConfig
    - allowToPerformConsecutiveTasksbooleanrequired
    - assignCorrectionsToLastInputAssigneebooleanrequired
    - configClassstringrequired
    - keepReviewerThroughoutPhasebooleanrequired
  - BlockerPhaseConfig
    - configClassstringrequired
  - DeliveryPhaseConfig
    - allowOwnerToQuickOrApiRejectboolean
    - allowToPerformConsecutiveTasksbooleanrequired
    - assignCorrectionsToLastInputAssigneebooleanrequired
    - configClassstringrequired
    - keepReviewerThroughoutPhasebooleanrequired
  - SampledReviewPhaseConfig
    - Max depth limit reached
- namestring

Responses

200

400Bad request

BadRequest
- errorCodestring
- messagestringrequired

401Unauthorized

Unauthorized
- messagestringrequired

403Forbidden

Forbidden
- messagestringrequired

404Not found

NotFound
- messagestringrequired

413Payload too large

PayloadTooLarge
- messagestringrequired

500Internal server error

InternalServerError
- messagestringrequired

python

import requests
import json

url = "https://api.app.kognic.com/v1/request-phases/{requestPhaseId}"

payload = json.dumps({
   "config": {
      "configClass": ""
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

400

// Bad request
{
  "errorCode": "",
  "message": ""
}

401

// Unauthorized
{
  "message": ""
}

403

// Forbidden
{
  "message": ""
}

404

// Not found
{
  "message": ""
}

413

// Payload too large
{
  "message": ""
}

500

// Internal server error
{
  "message": ""
}