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

/mission

Previous/matchNext/progress

Last updated 2 months ago

Retrieves a single Mission by id or by name

get

Looks up a mission by the passed in identifier

Authorizations
Path parameters
missionNameOrIdanyRequired
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/mission/{missionNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}

Deletes the Mission identified by id or by name

delete

Deletes a mission by the passed in identifier

Authorizations
Path parameters
missionNameOrIdanyRequired
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/mission/{missionNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
  "code": "text",
  "message": "text"
}
  • GETSearch Missions
  • POSTCreates a new mission
  • GETRetrieves a single Mission by id or by name
  • PUTUpdates an entire single Mission
  • DELETEDeletes the Mission identified by id or by name

Search Missions

get

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

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

Creates a new mission

post

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.

Authorizations
Body
idanyRequired

The unique ID of the mission

nameanyRequired

The name of the mission

displayNameanyRequired

The display name for the mission

descriptionanyRequired

The description of the mission

tagsanyOptional

The tags used to categorize this mission

stepsanyOptional

The steps that constitute the mission (may be null if finalRepeatStep is specified)

metadataanyOptional

The metadata for this mission

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/mission HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 697

{
  "id": null,
  "name": null,
  "displayName": null,
  "description": null,
  "tags": [],
  "steps": [
    {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": "[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": "[Circular Reference]",
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "metadata": null
}
{
  "code": "text",
  "message": "text"
}

Updates an entire single Mission

put

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.

Authorizations
Path parameters
missionNameOrIdanyRequired
Body
idanyRequired

The unique ID of the mission

nameanyRequired

The name of the mission

displayNameanyRequired

The display name for the mission

descriptionanyRequired

The description of the mission

tagsanyOptional

The tags used to categorize this mission

stepsanyOptional

The steps that constitute the mission (may be null if finalRepeatStep is specified)

metadataanyOptional

The metadata for this mission

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/mission/{missionNameOrId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 697

{
  "id": null,
  "name": null,
  "displayName": null,
  "description": null,
  "tags": [],
  "steps": [
    {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        {
          "item": {
            "id": null,
            "name": null,
            "tags": [],
            "displayName": null,
            "description": null,
            "category": "FUNGIBLE",
            "metadataSpec": "[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": "[Circular Reference]",
          "metadata": null,
          "publicVisible": null
        },
        "quantity": null,
        "metadata": null
      }
    ],
    "metadata": null
  },
  "metadata": null
}
{
  "code": "text",
  "message": "text"
}