Create multiple matches in one request

Authorizations

bearerAuth
stx-engine:match-create

Header Parameters

Idempotency-Key

required

string

Client-generated UUIDv7, required on every mutating request (POST, PUT, PATCH, DELETE), that makes the request safe to retry. A repeated request with the same key and the same payload returns the stored response (marked with the Idempotent-Replayed: true header) instead of executing again; the same key with a different payload is refused with 422. Keys older than the retention window (30 days) are rejected. A key that is not a UUID is refused with 400.

Request Body^required

Create multiple matches in a single request.

Array<object>

>= 1 items <= 50 items

object

gameId

required

string format: uuid

playedAt

required

Date-time (ISO 8601)

string format: date-time

participants

required

Array<object>

>= 1 items

A participant of a match; a ghost player takes part at most once.

object

ghostPlayerId

required

string format: uuid

score

Score of a participant: points (SCORE), seconds (TIME) or turns (TURNS), with at most two decimals; a value with more decimals is refused with 400.

number

>= -99999999.99 <= 99999999.99

rank

Position in the match, 1 for the winner; tied participants share a rank

integer format: int32

>= 1

outcome

string

Allowed values: WIN LOSS

loadoutAttributes

object

key

additional properties

any

expansions

Expansions of the game that were played

Array<string>

unique items

playsetId

string format: uuid

communityId

string format: uuid

editRequestsEnabled

boolean

default: true

207

Batch match creation result (some items may have failed independently)

object

results

required

Array<object>

object

status

required

string

Allowed values: CREATED FAILED

match

object

id

required

string format: uuid

game

required

object

id

required

string format: uuid

displayName

required

string

playset

object

id

required

string format: uuid

displayName

required

string

community

object

id

required

string format: uuid

displayName

required

string

recorder

required

object

id

required

string format: uuid

displayName

required

string

status

required

DRAFT matches are freely mutable directly via PATCH. Once a match is finalized it becomes immutable except through the match-edit proposal and approval workflow.

string

Allowed values: DRAFT FINALIZED

playedAt

required

Date-time (ISO 8601)

string format: date-time

editRequestsEnabled

required

boolean

finalizedAt

When the match was finalized; absent while it is a DRAFT.

string format: date-time

lastEditedAt

Date-time (ISO 8601)

string format: date-time

lastEditedBy

object

id

required

string format: uuid

displayName

required

string

createdAt

required

Date-time (ISO 8601)

string format: date-time

updatedAt

Date-time (ISO 8601)

string format: date-time

expansions

Array<object>

object

id

required

string format: uuid

displayName

required

string

participants

required

Array<object>

>= 1 items

object

id

required

string format: uuid

ghostPlayer

required

object

id

required

string format: uuid

displayName

required

string

score

Score of a participant: points (SCORE), seconds (TIME) or turns (TURNS), with at most two decimals; a value with more decimals is refused with 400.

number

>= -99999999.99 <= 99999999.99

rank

Position in the match, 1 for the winner; tied participants share a rank

integer format: int32

>= 1

outcome

string

Allowed values: WIN LOSS

loadout

object

id

required

string format: uuid

attributes

required

object

key

additional properties

any

createdAt

required

Date-time (ISO 8601)

string format: date-time

updatedAt

Date-time (ISO 8601)

string format: date-time

disputeReason

Why the player disagrees with the recorded result

string

>= 1 characters <= 1000 characters

disputedAt

Date-time (ISO 8601)

string format: date-time

disputedBy

object

id

required

string format: uuid

displayName

required

string

createdAt

required

Date-time (ISO 8601)

string format: date-time

updatedAt

Date-time (ISO 8601)

string format: date-time

error

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Headers

Idempotent-Replayed

string

Allowed values: true

Present (true) when the response was replayed from an earlier request with the same Idempotency-Key, instead of being executed again

400

Request validation failed

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

errors

Array<object>

object

field

required

Field or property that failed validation

string

code

required

Machine-readable validation error code, e.g. REQUIRED, VALUE_TOO_LONG, INVALID_FORMAT, OUT_OF_RANGE. Canonical list is maintained per resource in the documentation.

string

message

required

Human readable validation message

string

rejectedValue

The actual value that failed validation. Omitted if the value is sensitive.

Examples

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Received invalid request data",
  "errors": [
    {
      "field": "displayName",
      "code": "REQUIRED",
      "message": "missing required field"
    }
  ]
}

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Received invalid request data",
  "errors": [
    {
      "field": "participants[2].ghostPlayerId",
      "code": "DUPLICATE_GHOST_PLAYER",
      "message": "the ghost player already takes part in this match"
    }
  ]
}

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Bad Request",
  "status": 400,
  "detail": "Request validation failed",
  "errors": [
    {
      "field": "query",
      "code": "INVALID_SEARCH",
      "message": "'nonsense' is not a filterable field"
    }
  ]
}

401

Authentication required or token invalid

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/authentication",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication required"
}

403

Insufficient permissions

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/authorization",
  "title": "Access denied",
  "status": 403,
  "detail": "Insufficient permissions"
}

409

The requested mutation is not allowed in the resource’s current state, or it conflicts with existing data (a unique value that is already taken)

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/conflict",
  "title": "Already exists",
  "status": 409,
  "detail": "A game with source bgg:199792 already exists."
}

{
  "type": "https://errors.stratastax.dev/conflict",
  "title": "Self ghost player",
  "status": 409,
  "detail": "The ghost player that represents yourself cannot be deleted or unclaimed."
}

{
  "type": "https://errors.stratastax.dev/conflict",
  "title": "Match is finalized",
  "status": 409,
  "detail": "This match is FINALIZED; propose a change via POST /matches/{matchId}/edits instead."
}

422

The Idempotency-Key was already used for a request with a different payload

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

errors

Array<object>

object

field

required

Field or property that failed validation

string

code

required

Machine-readable validation error code, e.g. REQUIRED, VALUE_TOO_LONG, INVALID_FORMAT, OUT_OF_RANGE. Canonical list is maintained per resource in the documentation.

string

message

required

Human readable validation message

string

rejectedValue

The actual value that failed validation. Omitted if the value is sensitive.

Examples

{
  "type": "https://errors.stratastax.dev/validation",
  "title": "Unprocessable Content",
  "status": 422,
  "detail": "Idempotency key reused for a different request",
  "errors": [
    {
      "field": "Idempotency-Key",
      "code": "IDEMPOTENCY_KEY_REUSED",
      "message": "0192f100-0000-7000-8000-0000000000a5 was already used for a different request"
    }
  ]
}

500

Unexpected server error

object

type

required

Canonical error type identifier (URI). The values are the problem types of stratastax-http’s problem-core; stratastax-codegen fails the build of a service when the two disagree.

string

Allowed values: https://errors.stratastax.dev/authentication https://errors.stratastax.dev/authorization https://errors.stratastax.dev/validation https://errors.stratastax.dev/not-found https://errors.stratastax.dev/conflict https://errors.stratastax.dev/precondition-failed https://errors.stratastax.dev/internal

title

required

Short, human-readable summary

string

status

required

HTTP status code

integer format: int32

detail

required

Human-readable explanation

string

instance

URI of the request that caused the error

string format: uri

Examples

{
  "type": "https://errors.stratastax.dev/internal",
  "title": "Oops! Something went wrong.",
  "status": 500,
  "detail": "Try again later."
}

Create multiple matches in one request

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

207

Headers

400

Examples

401

Examples

403

Examples

409

Examples

422

Examples

500

Examples

Request Body^required