Elements Manual
Elements 3 Manual
Elements 3 Manual
  • Welcome 👋
  • QUICK START
    • Elements in Five Minutes or Less
    • Accessing the Web UI (CRM)
    • Creating A User
  • General
    • General Concepts
    • N-Tier Architecture
    • Security Model
  • Core Features
    • Core API Overview
    • Sessions
    • Applications
    • Users and Profiles
    • Digital Goods
    • Progress and Missions
    • Leaderboards
    • Matchmaking
    • Followers
    • Friends
    • Reward Issuance
    • Save Data
    • Schemas and Metadata Specifications
    • Queries
      • Base Query Syntax
      • Boolean Queries
      • Object Graph Navigation
      • Advanced Operators
        • .ref
        • .name
    • Custom Code
      • Element Structure
      • RESTful APIs
      • Websockets
    • Auth Schemes
      • OIDC
      • OAuth2
  • Web 3
    • Omni Chain Support
    • Vaults
    • Wallets
    • Smart Contracts
      • Smart Contracts: Ethereum
      • Smart Contracts: Flow
      • Smart Contracts: Solana
      • Smart Contracts: Neo
  • CONFIGURATION
    • Direct Database Access and Batch Configuration
    • Batch Samples
      • Item Upload Bash Script Sample
      • Mission Upload Bash Script Sample
  • RESTful APIs
    • Swagger and Swagger UI
    • API Specification
      • /application
      • /application/configuration
      • /auth
      • /auth_scheme
        • /custom
        • /oauth2
        • /oidc
      • /blockchain
      • /followee
      • /follower
      • /friend
      • /google
      • /index
      • /inventory
      • /item
      • /large_object
      • /leaderboard
      • /rank
      • /score
      • /match
      • /mission
      • /progress
      • /reward_issuance
      • /schedule
      • /notification
      • /profile
      • /save_data
      • /metadata_spec
      • /mock_session
      • /session
      • /health
      • /version
      • /signup
      • /user
    • Javadocs
  • Releases
    • 3.1 Release Notes
    • 3.2 Release Notes
Powered by GitBook
On this page
  1. RESTful APIs
  2. API Specification

/progress

Previous/missionNext/reward_issuance

Last updated 2 months ago

Deletes the Progress identified by id

delete

Deletes a progress by the passed in identifier

Authorizations
Path parameters
progressIdanyRequired
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
DELETE /api/rest/progress/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Retrieves a single Progress by id

get

Looks up a progress by the passed in identifier

Authorizations
Path parameters
progressIdanyRequired
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
GET /api/rest/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}
  • GETGets Rank Among all Players
  • POSTCreates a new progress
  • DELETEDeletes the Progress identified by id
  • GETRetrieves a single Progress by id
  • PUTUpdates a single Progress

Gets Rank Among all Players

get

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

Authorizations
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
text/csv
get
GET /api/rest/progress HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Creates a new progress

post

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.

Authorizations
Body
idanyRequired

The unique ID of the progress instance

remaininganyOptional

The remaining actions

rewardIssuancesanyOptional

List of all reward issuances that are issued but not expired, or redeemed but persistent.

sequenceanyOptional

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.

managedByScheduleanyOptional

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.

schedulesanyOptional

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

scheduleEventsanyOptional

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

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
POST /api/rest/progress HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 3465

{
  "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": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": {
            "id": null,
            "category": "MATCHMAKING",
            "uniqueIdentifier": null,
            "parent": "[Circular Reference]",
            "productBundles": [
              {
                "productId": null,
                "displayName": null,
                "description": null,
                "productBundleRewards": [
                  {
                    "itemId": null,
                    "quantity": null
                  }
                ],
                "metadata": null,
                "display": null
              }
            ]
          }
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "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": [
      {
        "item": {
          "id": null,
          "name": null,
          "tags": [],
          "displayName": null,
          "description": null,
          "category": "FUNGIBLE",
          "metadataSpec": {
            "id": null,
            "name": null,
            "type": "STRING",
            "properties": "[Circular Reference]"
          },
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "remaining": null,
  "mission": {
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": [
          {
            "item": {
              "id": null,
              "name": null,
              "tags": [],
              "displayName": null,
              "description": null,
              "category": "FUNGIBLE",
              "metadataSpec": {
                "id": null,
                "name": null,
                "type": "STRING",
                "properties": "[Circular Reference]"
              },
              "metadata": null,
              "publicVisible": null
            },
            "quantity": null,
            "metadata": null
          }
        ],
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": {
              "id": null,
              "name": null,
              "type": "STRING",
              "properties": "[Circular Reference]"
            },
            "metadata": null,
            "publicVisible": null
          },
          "quantity": null,
          "metadata": null
        }
      ],
      "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": {
        "id": null,
        "name": null,
        "tags": [],
        "displayName": null,
        "description": null,
        "category": "FUNGIBLE",
        "metadataSpec": {
          "id": null,
          "name": null,
          "type": "STRING",
          "properties": "[Circular Reference]"
        },
        "metadata": null,
        "publicVisible": null
      },
      "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": [
        {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null,
          "tags": [],
          "steps": [
            "[Circular Reference]"
          ],
          "finalRepeatStep": {
            "displayName": null,
            "description": null,
            "count": null,
            "rewards": "[Circular Reference]",
            "metadata": null
          },
          "metadata": null
        }
      ]
    }
  ]
}
{
  "code": "text",
  "message": "text"
}

Updates a single Progress

put

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

Authorizations
Path parameters
progressIdanyRequired
Body
idanyRequired

The unique ID of the progress instance

remaininganyOptional

The remaining actions

rewardIssuancesanyOptional

List of all reward issuances that are issued but not expired, or redeemed but persistent.

sequenceanyOptional

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.

managedByScheduleanyOptional

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.

schedulesanyOptional

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

scheduleEventsanyOptional

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

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
PUT /api/rest/progress/{progressId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 3465

{
  "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": {
        "id": null,
        "category": "MATCHMAKING",
        "uniqueIdentifier": null,
        "parent": {
          "id": null,
          "name": null,
          "description": null,
          "gitBranch": null,
          "scriptRepoUrl": null,
          "httpDocumentationUrl": null,
          "httpDocumentationUiUrl": null,
          "httpTunnelEndpointUrl": null,
          "attributes": null,
          "applicationConfiguration": {
            "id": null,
            "category": "MATCHMAKING",
            "uniqueIdentifier": null,
            "parent": "[Circular Reference]",
            "productBundles": [
              {
                "productId": null,
                "displayName": null,
                "description": null,
                "productBundleRewards": [
                  {
                    "itemId": null,
                    "quantity": null
                  }
                ],
                "metadata": null,
                "display": null
              }
            ]
          }
        },
        "productBundles": [
          {
            "productId": null,
            "displayName": null,
            "description": null,
            "productBundleRewards": [
              {
                "itemId": null,
                "quantity": null
              }
            ],
            "metadata": null,
            "display": null
          }
        ]
      }
    },
    "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": [
      {
        "item": {
          "id": null,
          "name": null,
          "tags": [],
          "displayName": null,
          "description": null,
          "category": "FUNGIBLE",
          "metadataSpec": {
            "id": null,
            "name": null,
            "type": "STRING",
            "properties": "[Circular Reference]"
          },
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "remaining": null,
  "mission": {
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": [
          {
            "item": {
              "id": null,
              "name": null,
              "tags": [],
              "displayName": null,
              "description": null,
              "category": "FUNGIBLE",
              "metadataSpec": {
                "id": null,
                "name": null,
                "type": "STRING",
                "properties": "[Circular Reference]"
              },
              "metadata": null,
              "publicVisible": null
            },
            "quantity": null,
            "metadata": null
          }
        ],
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": {
              "id": null,
              "name": null,
              "type": "STRING",
              "properties": "[Circular Reference]"
            },
            "metadata": null,
            "publicVisible": null
          },
          "quantity": null,
          "metadata": null
        }
      ],
      "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": {
        "id": null,
        "name": null,
        "tags": [],
        "displayName": null,
        "description": null,
        "category": "FUNGIBLE",
        "metadataSpec": {
          "id": null,
          "name": null,
          "type": "STRING",
          "properties": "[Circular Reference]"
        },
        "metadata": null,
        "publicVisible": null
      },
      "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": [
        {
          "id": null,
          "name": null,
          "displayName": null,
          "description": null,
          "tags": [],
          "steps": [
            "[Circular Reference]"
          ],
          "finalRepeatStep": {
            "displayName": null,
            "description": null,
            "count": null,
            "rewards": "[Circular Reference]",
            "metadata": null
          },
          "metadata": null
        }
      ]
    }
  ]
}
{
  "code": "text",
  "message": "text"
}