Get round | Softmax docs

GET/v2/rounds/{round_id}

Return one visible round with scored results and commissioner output metadata.

Authorization

BearerAuth

AuthorizationBearer <token>

Bearer token issued by Softmax

In: header

Path Parameters

round_id*Round Id

Round associated with the requested resource.

Match^round_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

bash

curl -X GET "https://example.com/v2/rounds/string"

json

{
  "id": "string",
  "round_number": 0,
  "commissioner_key": "string",
  "execution_backend": "dispatch",
  "round_config": {},
  "round_display": {},
  "status": "pending",
  "scheduled_by": "ladder",
  "error": "string",
  "skip_kind": "budget_refused",
  "started_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "division": {
    "id": "string",
    "name": "string",
    "level": 0,
    "type": "string",
    "description": "string",
    "hidden": true,
    "archived_at": "2019-08-24T14:15:22Z",
    "round_schedule": {},
    "notes": "string",
    "league": {
      "name": "string",
      "short_name": "string",
      "description": "string",
      "commissioner_key": "string",
      "commissioner_config": {},
      "commissioner_migration_version": "string",
      "rounds_paused_at": "2019-08-24T14:15:22Z",
      "submissions_locked_at": "2019-08-24T14:15:22Z",
      "settings": {},
      "filler_policy_version_ids": [
        "19818f13-26cb-4fdd-9b0c-2e0096e5f70d"
      ],
      "seed_policy_version_ids": [
        "9b626be7-cdd2-4e22-8014-dab46ae046a1"
      ],
      "seed_policy_number": 0,
      "rules": {},
      "public": false,
      "hidden": false,
      "is_game_of_week": false,
      "disabled_at": "2019-08-24T14:15:22Z",
      "notes": "string",
      "id": "string",
      "game": {
        "name": "string",
        "coworld_name": "string",
        "description": "string",
        "owner_user_id": "string",
        "notes": "string",
        "id": "string",
        "default_league_id": "string",
        "coworld_id": "string",
        "canonical_coworld_id": "string",
        "coworld_tags": [
          "string"
        ],
        "created_at": "2019-08-24T14:15:22Z"
      },
      "mod": {
        "name": "string",
        "description": "string",
        "owner_user_id": "string",
        "notes": "string",
        "id": "string",
        "game": {
          "name": "string",
          "coworld_name": "string",
          "description": "string",
          "owner_user_id": "string",
          "notes": "string",
          "id": "string",
          "default_league_id": "string",
          "coworld_id": "string",
          "canonical_coworld_id": "string",
          "coworld_tags": [
            "string"
          ],
          "created_at": "2019-08-24T14:15:22Z"
        },
        "created_at": "2019-08-24T14:15:22Z"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "participation_url": "string",
      "forum_markdown_url": "string",
      "wiki_markdown_url": "string",
      "logs_reporter_id": "string",
      "handicaps": {
        "property1": 0,
        "property2": 0
      },
      "handicap_dynamic": {
        "max_handicap": 0.5,
        "curve": 1,
        "min_entrants": 3,
        "dominance_ratio_for_max": 3,
        "winrate_for_max": 0.85
      }
    },
    "created_at": "2019-08-24T14:15:22Z",
    "commissioner_description": {
      "round_schedule": "string",
      "next_round": "string",
      "round_structure": "string",
      "leaderboard_rules": "string",
      "scoring_mechanics": "string",
      "changelog": [
        {
          "date": "string",
          "title": "string",
          "detail": "string",
          "category": "string"
        }
      ]
    }
  },
  "created_at": "2019-08-24T14:15:22Z",
  "results": [
    {
      "id": "string",
      "rank": 0,
      "score": 0,
      "result_metadata": {},
      "policy_version": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "policy": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string"
        },
        "version": 0,
        "player_id": "string",
        "label": "string"
      },
      "player": {
        "id": "string",
        "name": "string",
        "avatar_url": "string"
      },
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "entrant_count": 0,
  "commissioner_report": {},
  "has_commissioner_logs": false,
  "has_commissioner_report_render": false
}