Missions and Rewards
Last updated
Last updated
Looks up a mission by the passed in identifier
Searches all missions in the system and returning a number of matches against the given search filter, delimited by the offset and count.
020Gets the current Profile's rank among all players for the particular leaderboard.
Deletes a progress by the passed in identifier
Looks up a progress by the passed in identifier
020Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.
020Looks up a schedule by the passed in identifier
Deletes a schedule by the passed in identifier
Fetches all current assignments to the currently logged-in profile.
020Searches all schedules in the system and returning a number of matches against the given search filter, delimited by the offset and count.
020Looks up a schedule by the passed in identifier
Deletes a schedule by the passed in identifier
Deletes a mission by the passed in identifier
Supplying a mission, this will update the Mission identified by the name or ID in the path with contents from the passed in request body.
The unique ID of the mission
The name of the mission
The display name for the mission
The description of the mission
The tags used to categorize this mission
The steps that constitute the mission (may be null if finalRepeatStep is specified)
The metadata for this mission
Supplying a mission object, this will create a new mission with a newly assigned unique id. The Mission representation returned in the response body is a representation of the Mission as persisted with a unique identifier assigned and with its fields properly normalized. The supplied mission object submitted with the request must have a name property that is unique across all items.
The unique ID of the mission
The name of the mission
The display name for the mission
The description of the mission
The tags used to categorize this mission
The steps that constitute the mission (may be null if finalRepeatStep is specified)
The metadata for this mission
Supplying a progress object, this will create a new progress with a newly assigned unique id. The Progress representation returned in the response body is a representation of the Progress as persisted with a unique identifier assigned and with its fields properly normalized.
The unique ID of the progress instance
The remaining actions
List of all reward issuances that are issued but not expired, or redeemed but persistent.
The current number of completed steps. Note that this may exceed the total number of steps, i.e. the final step may be repeated infinitely.
Indicates that this progress is managed by a Schedule. If true, the Progress will be deleted when no schedules have the progress active. This will be true if the Progress was created as part of a Schedule.
A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.
A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.
Supplying a progress, this will update the Progress identified by the ID in the path with contents from the passed in request body.
The unique ID of the progress instance
The remaining actions
List of all reward issuances that are issued but not expired, or redeemed but persistent.
The current number of completed steps. Note that this may exceed the total number of steps, i.e. the final step may be repeated infinitely.
Indicates that this progress is managed by a Schedule. If true, the Progress will be deleted when no schedules have the progress active. This will be true if the Progress was created as part of a Schedule.
A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.
A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a 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.
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.
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.
[^_]\w+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.
[^_]\w+