/mission

Last updated 11 days ago

Search Missions

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

get

/mission

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/mission' \
  --header 'Authorization: YOUR_API_KEY'

400

401

403

404

409

500

501

503

default

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

Creates a new 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.

post

/mission

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

tagsany

The tags used to categorize this mission

stepsany

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

finalRepeatStepobject

metadataany

The metadata for this mission

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/mission' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "tags": [],
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

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

Retrieves a single Mission by id or by name

Looks up a mission by the passed in identifier

get

/mission/{missionNameOrId}

Authorizations

Path parameters

missionNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Updates an entire single Mission

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.

put

/mission/{missionNameOrId}

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

tagsany

The tags used to categorize this mission

stepsany

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

finalRepeatStepobject

metadataany

The metadata for this mission

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://localhost:8080/api/rest/mission/{missionNameOrId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "id": null,
    "name": null,
    "displayName": null,
    "description": null,
    "tags": [],
    "steps": [
      {
        "displayName": null,
        "description": null,
        "count": null,
        "rewards": "[Circular Reference]",
        "metadata": null
      }
    ],
    "finalRepeatStep": {
      "displayName": null,
      "description": null,
      "count": null,
      "rewards": [
        "[Circular Reference]"
      ],
      "metadata": null
    },
    "metadata": null
  }'

400

401

403

404

409

500

501

503

default

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

Deletes the Mission identified by id or by name

Deletes a mission by the passed in identifier

delete

/mission/{missionNameOrId}

Authorizations

Path parameters

missionNameOrIdanyrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

400

401

403

404

409

500

501

503

default

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

Search Missions

Creates a new mission

Show child attributes

Retrieves a single Mission by id or by name

Updates an entire single Mission

Show child attributes

Deletes the Mission identified by id or by name