SUsuperit
kb

Get Kb Curation Job

Get one KB curation job.

get/api/kb/{team_key}/jobs/curation/{job_key}

Request

  • Base URL
    https://api.superit.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

job_keystring required
team_keystring required

Response

Successful Response

keystring required
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required

Status of a job.

dateFilterMonthsinteger nullable required
dateFromstring date-time nullable required
dateTostring date-time nullable required
selectionMode'only_new' | 'reprocess_all' required

How ticket-analysis artifacts are selected for a curation run.

dryRunboolean required
autoPublishboolean required
maxWritesinteger required
progressTotalItemsinteger required
progressProcessedItemsinteger required
successCountinteger required
skipCountinteger required
errorCountinteger required
createdArticlesinteger required
updatedArticlesinteger required
createdResourcesinteger required
consolidationStatus'queued' | 'running' | 'completed' | 'failed' | 'cancelled'

Status of the follow-up KB consolidation phase for a curation job.

consolidationSummarystring nullable
consolidationErrorstring nullable
consolidationKeepCountinteger
consolidationUpdateCountinteger
consolidationMergeCountinteger
consolidationArchiveCountinteger
consolidationJobKeystring nullable
consolidationCompletedPassesinteger
consolidationMaxPassesinteger
consolidationConvergedboolean
startedAtstring date-time nullable required
completedAtstring date-time nullable required
errorMessagestring nullable required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.