/schedule

Search ScheduleEvents

get

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/schedule/{scheduleNameOrId}/event HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Creates a new schedule

post

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The ScheduleEvent representation returned in the response body is a representation of the ScheduleEvent as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Body

beginanyOptional

endanyOptional

missionNamesOrIdsanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/schedule/{scheduleNameOrId}/event HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "begin": null,
  "end": null,
  "missionNamesOrIds": []
}

{
  "code": "text",
  "message": "text"
}

Retrieves a single ScheduleEvent by id or by name

get

Looks up a schedule by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

scheduleEventIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Updates an entire single ScheduleEvent

put

Supplying a schedule, this will update the ScheduleEvent identified by the name or ID in the path with contents from the passed in request body.

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

scheduleEventIdanyRequired

Body

beginanyOptional

endanyOptional

missionNamesOrIdsanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "begin": null,
  "end": null,
  "missionNamesOrIds": []
}

{
  "code": "text",
  "message": "text"
}

Deletes the ScheduleEvent identified by id or by name

delete

Deletes a schedule by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

scheduleEventIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Gets all Progresses assigned via this schedule

get

Fetches all current assignments to the currently logged-in profile.

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/schedule/{scheduleNameOrId}/progress HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Search Schedules

get

Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.

Authorizations

auth_bearersession_secret

Query parameters

offsetanyOptionalDefault: 0

countanyOptionalDefault: 20

tagsanyOptional

searchanyOptional

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/schedule HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Creates a new schedule

post

Supplying a schedule object, this will create a new schedule with a newly assigned unique id. The Schedule representation returned in the response body is a representation of the Schedule as persisted with a unique identifier assigned and with its fields properly normalized. The supplied schedule object submitted with the request must have a name property that is unique across all items.

Authorizations

auth_bearersession_secret

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/schedule HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": null,
  "displayName": null,
  "description": null
}

{
  "code": "text",
  "message": "text"
}

Retrieves a single Schedule by id or by name

get

Looks up a schedule by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

get

HTTPcURLJavaScriptPython

GET /api/rest/schedule/{scheduleNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}

Updates an entire single Schedule

put

Supplying a schedule, this will update the Schedule identified by the name or ID in the path with contents from the passed in request body.

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Body

nameanyRequiredPattern: [^_]\w+

displayNameanyRequired

descriptionanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

put

HTTPcURLJavaScriptPython

PUT /api/rest/schedule/{scheduleNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "name": null,
  "displayName": null,
  "description": null
}

{
  "code": "text",
  "message": "text"
}

Deletes the Schedule identified by id or by name

delete

Deletes a schedule by the passed in identifier

Authorizations

auth_bearersession_secret

Path parameters

scheduleNameOrIdanyRequired

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/rest/schedule/{scheduleNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*

{
  "code": "text",
  "message": "text"
}