Schedules | Heeler User Guide

Get Schedule Terms

get

Authorizations

Responses

200

Successful Response

application/json

404

Not found

get

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

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

List Schedules

post

Authorizations

Query parameters

multi_tenantbooleanOptionalDefault: false

pageintegerOptionalDefault: 0

limitintegerOptionalDefault: 100

orderany ofOptional

stringOptional

or

nullOptional

directionany ofOptional

stringOptional

or

nullOptional

searchany ofOptional

stringOptional

or

nullOptional

Body

any ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

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",
      "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,
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Add Schedule

post

Authorizations

Body

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

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

schedule_idintegerRequired

argsany ofOptional

or

nullOptional

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

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"
}

Update Schedule

post

Authorizations

Path parameters

schedule_idintegerRequired

Body

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

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"
}