Game Objects
Was this helpful?
Was this helpful?
Get ranked Game Object results for a player
ID value. Only alphanumeric, underscore, and hyphen are allowed.
^[a-zA-Z0-9_-]+$Specify comma-separated input tags that will be used to score the game objects associated with the output tag.
If the output tag is included in the input tags, the player's score for those game object will be used as base scores
Specify the output tag of the game objects to get ranked results for
GET /api/game-objects/ranked?playerId=text&inputTags=text&outputTag=text HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"scores": [
{
"gameObject": {
"id": "text",
"name": "text"
},
"score": 1
}
]
}Get all Game Objects. Paginated by default. Supports filtering and sorting.
100Comma-separated Game Object IDs to filter by
Set to true to enable fuzzy ID filtering. If false, only returns exact matches.
falseComma-separated Game Object names to filter by
Set to true to enable fuzzy name filtering. If false, only returns exact matches.
falseComma-separated list of tag IDs the resulting game objects must have
Comma-separated list of tag IDs to exclude from the response. Use this to exclude game objects that have a specific tag, even if they match the requiredTags filter.
include: Include all game objects, regardless of whether they have tags or not.
exclude: Exclude game objects that have no tags.
untagged-only: Only return game objects that have no tags. Setting this option will ignore requiredTags and excludeTags, since tagged items shouldn't appear in the results.
includePossible values: Field to sort by
Sort order for the selected field
Set to true to include additional tags info in the response
falseComma-separated list of Game Object IDs to exclude from the response
GET /api/game-objects HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"gameObjects": [
{
"id": "text",
"name": "text",
"description": "text",
"createdAt": "text",
"updatedAt": "text",
"tags": [
"text"
],
"related": [
"text"
]
}
],
"tags": [
{
"id": "text",
"name": "text",
"description": "text",
"createdAt": "text",
"updatedAt": "text"
}
]
}Delete one or more game objects by their IDs
DELETE /api/game-objects HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"deletedCount": 1
}Get the total Game Object count. Supports filtering.
Comma-separated Game Object IDs to filter by
Set to true to enable fuzzy ID filtering. If false, only returns exact matches.
falseComma-separated Game Object names to filter by
Set to true to disable fuzzy name filtering. If false, only returns exact matches.
falseComma-separated list of tag IDs the resulting game objects must have
Comma-separated list of tag IDs to exclude from the response. Use this to exclude game objects that have a specific tag, even if they match the requiredTags filter.
include: Include all game objects, regardless of whether they have tags or not.
exclude: Exclude game objects that have no tags.
untagged-only: Only return game objects that have no tags. Setting this option will ignore requiredTags and excludeTags, since tagged items shouldn't appear in the results.
includePossible values: Comma-separated list of Game Object IDs to exclude from the response
GET /api/game-objects/count HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1
}Get a Game Object by its ID.
ID value. Only alphanumeric, underscore, and hyphen are allowed.
^[a-zA-Z0-9_-]+$GET /api/game-objects/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"gameObject": {
"id": "text",
"name": "text",
"description": "text",
"createdAt": "text",
"updatedAt": "text",
"tags": [
{
"id": "text",
"name": "text"
}
],
"related": [
"text"
]
}
}Create a new Game Object
ID value. Only alphanumeric, underscore, and hyphen are allowed.
^[a-zA-Z0-9_-]+$POST /api/game-objects HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71
{
"id": "text",
"name": "text",
"description": "text",
"tags": [
{
"id": "text"
}
]
}{
"createdGameObject": {
"id": "text",
"name": "text",
"description": "text",
"createdAt": "text",
"updatedAt": "text"
}
}Update a Game Object by its ID
ID value. Only alphanumeric, underscore, and hyphen are allowed.
^[a-zA-Z0-9_-]+$PUT /api/game-objects/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"data": {
"id": "text",
"name": "text",
"description": "text",
"tags": [
"text"
]
}
}{
"updatedGameObject": {
"id": "text",
"name": "text",
"description": "text",
"createdAt": "text",
"updatedAt": "text"
}
}