Schedules

Get Schedule Terms

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/schedules/_terms

HTTPcURLJavaScriptPython

GET /api/schedules/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "depends_on": [
        "text"
      ],
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

List Schedules

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

multi_tenantbooleanOptionalDefault: false

pageintegerOptionalDefault: 0

limitinteger · min: 1OptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

ordersany ofOptional

string[]Optional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

application/json

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/schedules/

HTTPcURLJavaScriptPython

POST /api/schedules/ HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "schedule_id": 1,
      "tenant_id": "text",
      "current_status": "text",
      "job_name": "text",
      "job_doc": "text",
      "connection_id": 1,
      "connection_name": "text",
      "connection_type": "text",
      "next_run_time": "text",
      "job_submitted": "text",
      "last_job_completed": "text",
      "last_job_failed": "text",
      "last_failure_reason": "text",
      "last_job_duration": 1
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Add Schedule

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

connection_idany ofOptional

integerOptional

or

nullOptional

current_statusstringOptionalDefault: PENDING

next_run_timeany ofOptional

integerOptional

or

nullOptional

job_namestringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/schedules/add

HTTPcURLJavaScriptPython

POST /api/schedules/add HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "connection_id": 1,
  "current_status": "PENDING",
  "next_run_time": 1,
  "job_name": "text"
}

{
  "ok": true,
  "message": "text"
}

Run Job

post

Body

application/json

schedule_idintegerRequired

argsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/schedules/run

HTTPcURLJavaScriptPython

POST /api/schedules/run HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "schedule_id": 1,
  "args": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

{
  "ok": true,
  "message": "text"
}

Trigger Analysis Processor

post

Trigger a HeelerAnalysisProcessor job for a given tenant and code root.

This has the effect of re-analyzing the latest commits from the default branch of the code root for an entire tenant, or all tenants if "" is passed in.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

tenant_idany ofOptional

stringOptional

or

nullOptional

code_root_idany ofOptional

integerOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/schedules/trigger_analysis_processor

HTTPcURLJavaScriptPython

POST /api/schedules/trigger_analysis_processor HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "tenant_id": "text",
  "code_root_id": 1
}

{
  "ok": true,
  "message": "text"
}

Update Schedule

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

schedule_idintegerRequired

Body

application/json

connection_idany ofOptional

integerOptional

or

nullOptional

current_statusstringOptionalDefault: PENDING

next_run_timeany ofOptional

integerOptional

or

nullOptional

job_namestringRequired

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/schedules/{schedule_id}

HTTPcURLJavaScriptPython

POST /api/schedules/{schedule_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "connection_id": 1,
  "current_status": "PENDING",
  "next_run_time": 1,
  "job_name": "text"
}

{
  "ok": true,
  "message": "text"
}