REredocly
Tasks

Update job

Changed on

Scout sends this API request after completing a job. Supports only PROCESSING -> COMPLETED and PROCESSING -> FAILED transitions.

patch/orgs/{orgId}/projects/{projectId}/scout/tasks/{jobId}

Request

Path parameters

orgIdstring required
Example:acme-inc

Organization ID.

projectIdstring required
Example:my-project

Project ID.

jobIdstring ulid required
Example:sjob_01h2t9ksv7vmsvbhh5ty40zctw

Job ID.

Headers

x-redocly-scout-versionstring
Example:1.0.0

Scout version.

Request body

status'COMPLETED' | 'FAILED' required

Job status.

Example request

{
  "metadata": {
    "scoutVersion": "1.0.0"
  }
}

Response

OK.

idstring ulid required

ID of the job.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Job status.

type'PROCESS_GIT_REPO' | 'UPDATE_STATUS' required

Type of job.

organizationIdstring

Organization ID.

projectIdstring

Project ID.

providerIdstring

Git provider identifier (appId for GitHub).

providerType'GITHUB_CLOUD' | 'GITHUB_SERVER' | 'GITLAB_CLOUD' | 'GITLAB_SELF_MANAGED' | 'BITBUCKET_CLOUD' | 'BITBUCKET_DATACENTER' | 'AZURE' required

Git provider type.

namespaceIdstring required

Git repo namespace id (organization login for GitHub).

repositoryIdstring required

Git repo id.

branchstring required

Git branch name.

commitShastring required

Git commit SHA.

isMainBranchboolean

True if branch is main.

prIdstring

Git pull request ID.

attemptsinteger required

Number of attempts to process the job.

parentJobIdstring ulid

ID of the parent job, if any.

startedAtstring date-time

Job start date.

createdAtstring date-time required

Job creation date.

updatedAtstring date-time required

Job last update date.

Example response

{
  "id": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "parentJobId": "sjob_01h2t9ksv7vmsvbhh5ty40zctw",
  "checks": [
    {
      "name": "Scorecard - Compliance API"
    }
  ],
  "metadata": {
    "scoutVersion": "1.0.0"
  }
}

Changes

  • 5dc606d075e4Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status