Mockaroo · JSON Structure

Mockaroo Download Structure

Asynchronous background download job status.

Type: object Properties: 6 Required: 2
Test DataMock DataAPI MockingData GenerationDeveloper ToolsQA TestingRealistic DataSchemasDatasetsPublic APIs

MockarooDownload is a JSON Structure definition published by Mockaroo, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/draft-00/schema meta-schema.

Properties

id status percentComplete recordsGenerated error url

Meta-schema: https://json-structure.org/draft-00/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft-00/schema",
  "$id": "https://www.mockaroo.com/structures/mockaroo-download.json",
  "name": "MockarooDownload",
  "type": "object",
  "description": "Asynchronous background download job status.",
  "properties": {
    "id": { "type": "string", "description": "Job identifier." },
    "status": {
      "type": "string",
      "description": "Job state.",
      "enum": ["queued", "in_progress", "success", "failed"]
    },
    "percentComplete": { "type": "double", "description": "Percent of records generated." },
    "recordsGenerated": { "type": "int64", "description": "Records generated so far." },
    "error": { "type": "string", "description": "Failure message." },
    "url": { "type": "string", "description": "Download URL for the completed dataset." }
  },
  "required": ["id", "status"]
}