Scheduler Service (1.0.0)

Download OpenAPI specification:Download

Andriy Kornatskyy: andriy.kornatskyy@live.com License: MIT

REST API for the Scheduler Service. This API allows create and manage scheduled jobs.

collections

Provides operations for creating and managing collections of scheduled jobs.

Retrieves a list of job collections

Responses

Response samples

200

Content type

application/json

{"items": [{"id": "65ada2f9-be3d-4960-a7f4-ea47fe3323b9",
"name": "My App #1",
"state": "enabled"
},
{"id": "7d76cb30-f581-49ca-a718-d353a1d129a8",
"name": "My Other App",
"state": "disabled"
}
]
}

Creates a job collection

Request Body schema: application/json

a job collection to create

id	string
name required	string [ 3 .. 64 ] unique job collection name
state	string Default: "enabled" Enum: "enabled" "disabled"

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "My App #1",
"state": "enabled"
}

Response samples

201

Content type

application/json

"string"

Retrieves a specified job collection

path Parameters

id

required

string

header Parameters

If-None-Match

string (ETag)

Example: "fde7bculys"

Responses

Response samples

200

Content type

application/json

{"updated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "My App #1",
"state": "enabled"
}

Updates a job collection

path Parameters

id

required

string

header Parameters

If-Match

string (ETag)

Example: "fde7bculys"

Request Body schema: application/json

a job collection to update

id	string
name required	string [ 3 .. 64 ] unique job collection name
state	string Default: "enabled" Enum: "enabled" "disabled"

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "My App #1",
"state": "enabled"
}

Response samples

204

Content type

application/json

null

DeleteCollection

Deletes a single job collection

path Parameters

id

required

string

header Parameters

If-Match

string (ETag)

Example: "fde7bculys"

Responses

jobs

Provides operations for creating and managing scheduled jobs.

Retrieves a list of jobs

query Parameters

collectionId

string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": "7ce1f17e-48b1-4e73-be22-771fa764993a",
"name": "My Task #1",
"schedule": "@every 15s",
"state": "disabled"
},
{"id": "94946f60-711f-4044-b08e-ccd9ba998f88",
"name": "My Task #2",
"schedule": "@every 1m",
"state": "enabled"
}
]
}

Creates a job

Request Body schema: application/json

a job to create

required	object (Action)
collectionId required	string
name	string unique job name
state	string Enum: "enabled" "disabled"
schedule	string

Responses

Request samples

Payload

Content type

application/json

{"action": {"type": "HTTP",
"request": {"method": "GET",
"uri": "http://example.com",
"headers": [{"name": "X-Requested-With",
"value": "XMLHttpRequest"
}
],
"body": "string"
},
"retryPolicy": {"retryCount": 3,
"retryInterval": "10s",
"deadline": "1m"
}
},
"collectionId": "string",
"name": "My Task #1",
"state": "enabled",
"schedule": "@every 1h"
}

Response samples

201

Content type

application/json

"string"

Retrieves a specified job definition

path Parameters

id

required

string

header Parameters

If-None-Match

string (ETag)

Example: "fde7bculys"

Responses

Response samples

200

Content type

application/json

{"updated": "2019-08-24T14:15:22Z",
"action": {"type": "HTTP",
"request": {"method": "GET",
"uri": "http://example.com",
"headers": [{"name": "X-Requested-With",
"value": "XMLHttpRequest"
}
],
"body": "string"
},
"retryPolicy": {"retryCount": 3,
"retryInterval": "10s",
"deadline": "1m"
}
},
"id": "string",
"collectionId": "string",
"name": "My Task #1",
"state": "enabled",
"schedule": "@every 1h"
}

Updates a job definition

path Parameters

id

required

string

header Parameters

If-Match

string (ETag)

Example: "fde7bculys"

Request Body schema: application/json

a job definition to update

required	object (Action)
collectionId required	string
name	string unique job name
state	string Enum: "enabled" "disabled"
schedule	string

Responses

Request samples

Payload

Content type

application/json

{"action": {"type": "HTTP",
"request": {"method": "GET",
"uri": "http://example.com",
"headers": [{"name": "X-Requested-With",
"value": "XMLHttpRequest"
}
],
"body": "string"
},
"retryPolicy": {"retryCount": 3,
"retryInterval": "10s",
"deadline": "1m"
}
},
"collectionId": "string",
"name": "My Task #1",
"state": "enabled",
"schedule": "@every 1h"
}

DeleteJob

Deletes a single job definition

path Parameters

id

required

string

header Parameters

If-Match

string (ETag)

Example: "fde7bculys"

Responses

Retrieves a specified job status

path Parameters

id

required

string

header Parameters

If-None-Match

string (ETag)

Example: "fde7bculys"

Responses

Response samples

200

Content type

application/json

{"running": true,
"runCount": 157,
"errorCount": 39,
"lastRun": "2019-08-24T14:15:22Z",
"nextRun": "2019-08-24T14:15:22Z"
}

Updates a specified job status

path Parameters

id

required

string

header Parameters

If-Match

string (ETag)

Example: "fde7bculys"

Request Body schema: application/json

job to run

running

boolean

Responses

Request samples

Payload

Content type

application/json

{"running": true
}

history

Provides operations for managing job history.

Retrieves a list of specified job history

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"action": "HTTP",
"started": "2019-08-24T14:15:22Z",
"finished": "2019-08-24T14:15:22Z",
"status": "completed",
"retryCount": 0,
"message": null
}
]
}

DeleteJobHistory

Deletes a specified job history

path Parameters

id

required

string

query Parameters

before

string <date-time>

Responses

others

Queries health-related information

Responses

Response samples

200
503

Content type

application/json

{"status": "up",
"message": "string"
}