Metadata

The metadata object includes information about the metadata for the dataset:

{
  "metadata": {
    "id": "ID",
    "parentId": "ID",
    "originId": "ID",
    "name": "dataset name",
    "submitDateTime": "2026-03-10T12:15:50-04:00",
    "startDateTime": "2026-03-10T12:15:50-04:00",
    "activeDateTime": "2026-03-10T12:15:50-04:00",
    "completeDateTime": "2026-03-10T12:15:50-04:00",
    "shutdownDateTime": "2026-03-10T12:15:50-04:00",
    "solverStatus": "DATASET_CREATED",
    "score": "0hard/0medium/100000soft",
    "tags": [
      "Control"
    ],
    "validationResult": {
      "summary": "OK",
      "errors": [
        "Error message"
      ],
      "warnings": [
        "Warning message"
      ]
    },
    "failureMessage": "string"
  }
}

  • id is the ID assigned to the dataset.

  • parentId identifies the dataset this dataset was derived from if the patch operation was used to create a new revision of the dataset.

  • originID identifies the original dataset this dataset was derived from if multiple patch operation were used to create new revisions of the dataset.

  • name is the name that was provided with the input dataset. If no name was provided, one will be automatically generated.

  • submitDateTime is when the dataset was submitted.

  • startDateTime is when the dataset started solving.

  • activeDateTime shows when the solve-phase of the run started.

  • completeDateTime shows when the solve-phase of the run stopped.

  • shutdownDateTime shows when the solver shut down.

  • solverStatus shows the status of the dataset. See dataset lifecycle for more details.

  • score is the hard, medium, and soft scores of the dataset. See constraints for more information about constraint scores.

  • tags contains any tags that were included with the input dataset.

  • validationResult will return VALIDATION_NOT_SUPPORTED, OK, WARNINGS, ERRORS.

  • errors contains the list of errors that occurred during validation.

  • warning contains a list of warnings for the dataset, if any occur.

  • failureMessage describing the reason the run failed if the solverStatus is SOLVING_FAILED.

Next