/schedule

Previous/reward_issuance Next/notification

Last updated 11 days ago

Search ScheduleEvents

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

get

/schedule/{scheduleNameOrId}/event

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new schedule

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.

post

/schedule/{scheduleNameOrId}/event

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

beginany

endany

missionNamesOrIdsanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "begin": null,
    "end": null,
    "missionNamesOrIds": []
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single ScheduleEvent by id or by name

Looks up a schedule by the passed in identifier

get

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an entire single ScheduleEvent

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.

put

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Body

beginany

endany

missionNamesOrIdsanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "begin": null,
    "end": null,
    "missionNamesOrIds": []
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the ScheduleEvent identified by id or by name

Deletes a schedule by the passed in identifier

delete

/schedule/{scheduleNameOrId}/event/{scheduleEventId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

scheduleEventIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/event/{scheduleEventId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Gets all Progresses assigned via this schedule

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

get

/schedule/{scheduleNameOrId}/progress

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}/progress' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Search Schedules

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

get

/schedule

Authorizations

Query parameters

offsetany · default: 0

countany · default: 20

tagsany

searchany

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new schedule

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.

post

/schedule

Authorizations

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/schedule' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "displayName": null,
    "description": null
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Schedule by id or by name

Looks up a schedule by the passed in identifier

get

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Updates an entire single Schedule

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.

put

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Body

nameanyrequired

Pattern: [^_]\w+

displayNameanyrequired

descriptionanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": null,
    "displayName": null,
    "description": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the Schedule identified by id or by name

Deletes a schedule by the passed in identifier

delete

/schedule/{scheduleNameOrId}

Authorizations

Path parameters

scheduleNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://localhost:8080/api/rest/schedule/{scheduleNameOrId}' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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