ARarcprize
Scorecards

Close scorecard

Changed on

Finalises a previously opened scorecard, locking its data and returning the aggregate results.
After a scorecard is closed, additional RESET or ACTION commands using its card_id are rejected.
You must supply the card_id obtained from /scorecard/open.

post/api/scorecard/close

Request

Request body

card_idstring required

Identifier of the scorecard to close—use the card_id returned by OpenScorecardResponse.

Response

scorecard closed; final aggregate results returned.

card_idstring required

The scorecard ID returned by OpenScorecardResponse.

scorenumber float required

Average of the best per-environment scores in this scorecard.

source_urlstring uri

Link originally supplied in the OpenScorecardRequest.

tagsstring[]

Arbitrary labels echoed back from the open request.

user_namestring

Display name of the user who opened/ran this scorecard.

user_idstring

Stable identifier of the user (e.g. provider subject id).

published_atstring date-time

When the scorecard was closed/published (absent if still open).

opaqueunknown
competition_modeboolean nullable

Whether competition restrictions apply to this scorecard.

open_atstring date-time

When the scorecard was opened.

last_updatestring date-time

When the scorecard was last updated (e.g. last action or close).

total_environments_completedinteger required

Number of environments with at least one run that reached WIN.

total_environmentsinteger required

Total number of environments in this scorecard.

total_levels_completedinteger required

Sum of the highest completed-level count for each environment.

total_levelsinteger required

Total number of levels across all environments.

total_actionsinteger required

Number of actions taken across all recorded runs.

Changes

  • 25b583984ff7Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the ///// response's property type changed from integer to number, and format from no format to float for status

    • breaking

      the //// response's property type changed from integer to number, and format from no format to float for status

    • breaking

      the // response's property type changed from integer to number, and format from no format to float for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from integer to number, and format from no format to float for status

    • breaking

      the // response's property type changed from integer to number, and format from no format to float for status

    • warning

      added the new NOT_PLAYED enum value to the //// response property for the response status

    • warning

      added the new NOT_PLAYED enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      removed the NOT_STARTED enum value from the //// response property for the response status

    • info

      removed the NOT_STARTED enum value from the // response property for the response status