PorticoDocs

Optimization Jobs

Generated optimization jobs operations.

POST/v1/optimization-jobs/{id}/cancelRun optimization jobs cancellibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
post_optimization_jobs_id_cancel
Max body
64 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "idempotencyKey": "string"
}
Schema
  • expectedRevisionintegerrequired
  • idempotencyKeystringrequired

Responses

200Successapplication/json

Example
{
  "bytes": 0,
  "createdMs": 1800000,
  "errorCode": "string",
  "generation": 0,
  "id": "id_8h2k4q",
  "itemId": "id_8h2k4q",
  "phase": "string",
  "profileId": "id_8h2k4q",
  "revision": 0,
  "sourceId": "id_8h2k4q",
  "state": "string",
  "targetId": "id_8h2k4q",
  "updatedMs": 1800000,
  "versionId": "id_8h2k4q"
}
Schema
  • bytesintegerrequired
  • createdMsintegerrequired
  • errorCodestringrequired
  • generationintegerrequired
  • idstringrequired
  • itemIdstringrequired
  • phasestringrequired
  • profileIdstringrequired
  • revisionintegerrequired
  • sourceIdstringrequired
  • statestringrequired
  • targetIdstringrequired
  • updatedMsintegerrequired
  • versionIdstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/optimization-jobs/{id}/cancel" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"idempotencyKey":"string"}'
POST/v1/optimization-jobs/{id}/retryRun optimization jobs retrylibrary
Audience
Clients · Native API
Authorization
API key or personal access token with the library scope, or a signed-in session
OpenAPI operation ID
post_optimization_jobs_id_retry
Max body
64 KiB

Parameters

NameInTypeDescription
idrequiredpathstring

Request body application/json · required

Example
{
  "expectedRevision": 0,
  "idempotencyKey": "string"
}
Schema
  • expectedRevisionintegerrequired
  • idempotencyKeystringrequired

Responses

200Successapplication/json

Example
{
  "bytes": 0,
  "createdMs": 1800000,
  "errorCode": "string",
  "generation": 0,
  "id": "id_8h2k4q",
  "itemId": "id_8h2k4q",
  "phase": "string",
  "profileId": "id_8h2k4q",
  "revision": 0,
  "sourceId": "id_8h2k4q",
  "state": "string",
  "targetId": "id_8h2k4q",
  "updatedMs": 1800000,
  "versionId": "id_8h2k4q"
}
Schema
  • bytesintegerrequired
  • createdMsintegerrequired
  • errorCodestringrequired
  • generationintegerrequired
  • idstringrequired
  • itemIdstringrequired
  • phasestringrequired
  • profileIdstringrequired
  • revisionintegerrequired
  • sourceIdstringrequired
  • statestringrequired
  • targetIdstringrequired
  • updatedMsintegerrequired
  • versionIdstringrequired

defaultRequest refused or unavailableapplication/json

Example
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Schema
  • errorobjectrequired
    • codestringrequired
    • messagestringrequired

Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/optimization-jobs/{id}/retry" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0,"idempotencyKey":"string"}'