/progress

Previous/mission Next/reward_issuance

Last updated 13 days ago

Gets Rank Among all Players

Gets the current Profile's rank among all players for the particular leaderboard.

get

/progress

Authorizations

Responses

application/json

text/csv

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Creates a new progress

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.

post

/progress

Authorizations

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobject

remainingany

The remaining actions

missionobjectrequired

rewardIssuancesany

Represents a Reward that has been issued but has not yet been claimed by the user. The reward is assigned a unique ID to ensure that it may not have been applied more than once.

sequenceany

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.

managedByScheduleany

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.

schedulesany

A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

scheduleEventsany

A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/progress' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "name": null,
        "description": null,
        "gitBranch": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": "[Circular Reference]"
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "state": "EMPTY",
        "lastModified": null
      },
      "displayName": null,
      "metadata": null,
      "lastLogin": null
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "steps": [
        "[Circular Reference]"
      ],
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      },
      "tags": [],
      "metadata": null
    },
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "level": "UNPRIVILEGED"
        },
        "state": "ISSUED",
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "type": "PERSISTENT",
        "source": null,
        "metadata": null,
        "tags": [],
        "expirationTimestamp": null,
        "uuid": null
      }
    ],
    "sequence": null,
    "managedBySchedule": null,
    "schedules": [
      {
        "id": null,
        "name": null,
        "displayName": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the Progress identified by id

Deletes a progress by the passed in identifier

delete

/progress/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Retrieves a single Progress by id

Looks up a progress by the passed in identifier

get

/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates a single Progress

Supplying a progress, this will update the Progress identified by the ID in the path with contents from the passed in request body.

put

/progress/{progressId}

Authorizations

Path parameters

progressIdanyrequired

Body

idanyrequired

The unique ID of the progress instance

profileobjectrequired

currentStepobject

remainingany

The remaining actions

missionobjectrequired

rewardIssuancesany

Represents a Reward that has been issued but has not yet been claimed by the user. The reward is assigned a unique ID to ensure that it may not have been applied more than once.

sequenceany

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.

managedByScheduleany

schedulesany

A listing of the Schedules which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

scheduleEventsany

A listing of ScheduleEvents which are managing this Progress. Empty or null if the Progress is not managed as part of a Schedule.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/progress/{progressId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "profile": {
      "id": null,
      "user": {
        "id": null,
        "name": null,
        "firstName": null,
        "lastName": null,
        "email": null,
        "primaryPhoneNb": null,
        "level": "UNPRIVILEGED"
      },
      "application": {
        "id": null,
        "name": null,
        "description": null,
        "gitBranch": null,
        "scriptRepoUrl": null,
        "httpDocumentationUrl": null,
        "httpDocumentationUiUrl": null,
        "httpTunnelEndpointUrl": null,
        "attributes": null,
        "applicationConfiguration": "[Circular Reference]"
      },
      "imageUrl": null,
      "imageObject": {
        "id": null,
        "url": null,
        "mimeType": null,
        "state": "EMPTY",
        "lastModified": null
      },
      "displayName": null,
      "metadata": null,
      "lastLogin": null
    },
    "currentStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "remaining": null,
    "mission": {
      "id": null,
      "name": null,
      "displayName": null,
      "description": null,
      "steps": [
        "[Circular Reference]"
      ],
      "finalRepeatStep": {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      },
      "tags": [],
      "metadata": null
    },
    "rewardIssuances": [
      {
        "id": null,
        "user": {
          "id": null,
          "name": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "primaryPhoneNb": null,
          "level": "UNPRIVILEGED"
        },
        "state": "ISSUED",
        "item": "[Circular Reference]",
        "itemQuantity": null,
        "context": null,
        "type": "PERSISTENT",
        "source": null,
        "metadata": null,
        "tags": [],
        "expirationTimestamp": null,
        "uuid": null
      }
    ],
    "sequence": null,
    "managedBySchedule": null,
    "schedules": [
      {
        "id": null,
        "name": null,
        "displayName": null,
        "description": null
      }
    ],
    "scheduleEvents": [
      {
        "id": null,
        "begin": null,
        "end": null,
        "schedule": {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null
        },
        "missions": "[Circular Reference]"
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

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

Gets Rank Among all Players

Creates a new progress

Show child attributes

Show child attributes

Show child attributes

Deletes the Progress identified by id

Retrieves a single Progress by id

Updates a single Progress

Show child attributes

Show child attributes

Show child attributes