SCscanopy
Organizations
internal

Populate demo data

Changed on

Only available for demo organizations.

Runs the population off the request thread (a tokio::spawn) and returns 202 immediately — the work is a few hundred sequential DB round-trips and would otherwise exceed the reverse-proxy request timeout against a remote database. Poll GET /{id}/populate-demo/status for completion/failure.

post/api/v1/organizations/{id}/populate-demo

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/organizations/{id}/populate-demo
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Path parameters

idstring uuid required

Organization ID

Response

Demo data population started

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • 51af15be596eRevision changes
    • breaking

      added subschema #1: Running subschema #2: Complete subschema #3: Failed to the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the response property oneOf list for the response status

  • c037832cd07fRevision changes
    • breaking

      removed the success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status