Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
5001 lines (5001 sloc) 218 KB
{
"swagger" : "2.0",
"info" : {
"title" : "OpenML API",
"description" : "REST API for sharing, organizing and reusing machine learning datasets, code, and experiments. Follows a predictive URL scheme from endpoint https://www.openml.org/api/v1/json (or /xml). You need to add your `api_key` to every call (see your account settings), or simply log in. See https://www.openml.org/api_data_docs for the file server API.",
"version" : "1.0.0"
},
"schemes" : [ "https" ],
"basePath" : "/api/v1/json",
"produces" : [ "application/json" ],
"paths" : {
"/data/{id}" : {
"get" : {
"summary" : "Get dataset description",
"description" : "Returns information about a dataset. The information includes the name, information about the creator, URL to download it and more.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"110" : {
"description" : "Please provide data_id."
},
"111" : {
"description" : "Unknown dataset. Data set description with data_id was not found in the database."
},
"112" : {
"description" : "No access granted. This dataset is not shared with you."
},
"200" : {
"description" : "A dataset description",
"schema" : {
"$ref" : "#/definitions/Data"
},
"examples" : {
"application/json" : "{\n \"data_set_description\": {\n \"id\": \"1\",\n \"name\": \"anneal\",\n \"version\": \"2\",\n \"description\": \"...\",\n \"format\": \"ARFF\",\n \"upload_date\": \"2014-04-06 23:19:20\",\n \"licence\": \"Public\",\n \"url\": \"https://www.openml.org/data/download/1/dataset_1_anneal.arff\",\n \"file_id\": \"1\",\n \"default_target_attribute\": \"class\",\n \"version_label\": \"2\",\n \"tag\": [\n \"study_1\",\n \"uci\"\n ],\n \"visibility\": \"public\",\n \"original_data_url\": \"https://www.openml.org/d/2\",\n \"status\": \"active\",\n \"md5_checksum\": \"d01f6ccd68c88b749b20bbe897de3713\"\n }\n}"
}
}
}
},
"delete" : {
"summary" : "Delete dataset",
"description" : "Deletes a dataset. Upon success, it returns the ID of the deleted dataset.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "ID of the deleted dataset",
"schema" : {
"type" : "object",
"properties" : {
"data_delete" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the deleted dataset, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"data_delete\": {\n \"id\": \"4328\"\n }\n}"
}
},
"350" : {
"description" : "Please provide API key. In order to remove your content, please authenticate."
},
"351" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators."
},
"352" : {
"description" : "Dataset does not exists. The data ID could not be linked to an existing dataset."
},
"353" : {
"description" : "Dataset is not owned by you. The dataset is owned by another user. Hence you cannot delete it."
},
"354" : {
"description" : "Dataset is in use by other content. Can not be deleted. The data is used in tasks or runs. Delete other content before deleting this dataset."
},
"355" : {
"description" : "Deleting dataset failed. Deleting the dataset failed. Please contact support team."
}
}
}
},
"/data" : {
"post" : {
"summary" : "Upload dataset",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads a dataset. Upon success, it returns the data id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the dataset. Only name, description, and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.upload) and an [XML example](https://www.openml.org/api/v1/xml_example/data).",
"required" : true,
"type" : "file"
}, {
"name" : "dataset",
"in" : "formData",
"description" : "The actual dataset, being an ARFF file.",
"required" : true,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"130" : {
"description" : "Problem with file uploading. There was a problem with the file upload"
},
"131" : {
"description" : "Problem validating uploaded description file. The XML description format does not meet the standards"
},
"132" : {
"description" : "Failed to move the files. Internal server error, please contact API administrators"
},
"133" : {
"description" : "Failed to make checksum of datafile. Internal server error, please contact API administrators"
},
"134" : {
"description" : "Failed to insert record in database. Internal server error, please contact API administrators"
},
"135" : {
"description" : "Please provide description xml."
},
"136" : {
"description" : "File failed format verification. The uploaded file is not valid according to the selected file format. Please check the file format specification and try again."
},
"137" : {
"description" : "Please provide API key. In order to share content, please log in or provide your API key."
},
"138" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact API administrators"
},
"139" : {
"description" : "Combination name / version already exists. Leave version out for auto increment"
},
"140" : {
"description" : "Both dataset file and dataset url provided. The system is confused since both a dataset file (post) and a dataset url (xml) are provided. Please remove one."
},
"141" : {
"description" : "Neither dataset file or dataset url are provided. Please provide either a dataset file as POST variable, or a dataset url in the description XML"
},
"142" : {
"description" : "Error in processing arff file. Can be a syntax error, or the specified target feature does not exists. For now, we only check on arff files. If a dataset is claimed to be in such a format, and it can not be parsed, this error is returned."
},
"143" : {
"description" : "Suggested target feature not legal. It is possible to suggest a default target feature (for predictive tasks). However, it should be provided in the data."
},
"144" : {
"description" : "Unable to update dataset. The dataset with id could not be found in the database. If you upload a new dataset, unset the id."
},
"200" : {
"description" : "Id of the uploaded dataset",
"schema" : {
"type" : "object",
"properties" : {
"upload_data_set" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the uploaded dataset, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"upload_data_set\": {\n \"id\": \"4328\"\n }\n}"
}
}
}
}
},
"/data/qualities/list" : {
"get" : {
"summary" : "List all data qualities",
"description" : "Returns a list of all data qualities in the system.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of data qualities",
"schema" : {
"$ref" : "#/definitions/DataQualityList"
},
"examples" : {
"application/json" : "{\n \"data_qualities_list\":{\n \"quality\":[\n \"NumberOfClasses\",\n \"NumberOfFeatures\",\n \"NumberOfInstances\",\n \"NumberOfInstancesWithMissingValues\",\n \"NumberOfMissingValues\",\n \"NumberOfNumericFeatures\",\n \"NumberOfSymbolicFeatures\"\n ]\n }\n}"
}
},
"370" : {
"description" : "No data qualities available. There are no data qualities in the system."
}
}
}
},
"/data/qualities" : {
"post" : {
"summary" : "Upload dataset qualities",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads dataset qualities. Upon success, it returns the data id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the dataset. Only name, description, and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.qualities) and an [XML example](https://www.openml.org/api/v1/xml_example/data.qualities).",
"required" : true,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"381" : {
"description" : "Something wrong with XML, please check did and evaluation_engine_id"
},
"382" : {
"description" : "Please provide description xml"
},
"383" : {
"description" : "Problem validating uploaded description file"
},
"384" : {
"description" : "Dataset not processed yet"
}
}
}
},
"/data/status/" : {
"post" : {
"summary" : "Change the status of a dataset",
"consumes" : [ "multipart/form-data" ],
"description" : "Change the status of a dataset, either 'active' or 'deactivated'\n",
"parameters" : [ {
"name" : "data_id",
"in" : "formData",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "status",
"in" : "formData",
"description" : "The status on which to filter the results, either 'active' or 'deactivated'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"691" : {
"description" : "Illegal status"
},
"692" : {
"description" : "Dataset does not exists"
},
"693" : {
"description" : "Dataset is not owned by you"
},
"694" : {
"description" : "Illegal status transition"
},
"695" : {
"description" : "Status update failed"
}
}
}
},
"/data/features" : {
"post" : {
"summary" : "Upload dataset feature description",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads dataset feature description. Upon success, it returns the data id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the dataset. Only name, description, and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.data.features) and an [XML example](https://www.openml.org/api/v1/xml_example/data.features).",
"required" : true,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"431" : {
"description" : "Dataset already processed"
},
"432" : {
"description" : "Please provide description xml"
},
"433" : {
"description" : "Problem validating uploaded description file"
},
"434" : {
"description" : "Could not find dataset"
},
"436" : {
"description" : "Something wrong with XML, check did and evaluation engine id"
}
}
}
},
"/data/features/{id}" : {
"get" : {
"summary" : "Get data features",
"description" : "Returns the features of a dataset.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "All the features of the dataset",
"schema" : {
"$ref" : "#/definitions/DataFeatures"
},
"examples" : {
"application/json" : "{\n \"data_features\": {\n \"feature\": [\n {\n \"index\": \"0\",\n \"name\": \"sepallength\",\n \"data_type\": \"numeric\",\n \"is_target\": \"false\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\n },\n {\n \"index\": \"1\",\n \"name\": \"sepalwidth\",\n \"data_type\": \"numeric\",\n \"is_target\": \"false\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\n },\n {\n \"index\": \"2\",\n \"name\": \"petallength\",\n \"data_type\": \"numeric\",\n \"is_target\": \"false\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\n },\n {\n \"index\": \"3\",\n \"name\": \"petalwidth\",\n \"data_type\": \"numeric\",\n \"is_target\": \"false\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\n },\n {\n \"index\": \"4\",\n \"name\": \"class\",\n \"data_type\": \"nominal\",\n \"is_target\": \"true\",\n \"is_ignore\": \"false\",\n \"is_row_identifier\": \"false\"\n }\n ]\n }\n}"
}
},
"270" : {
"description" : "Please provide dataset ID."
},
"271" : {
"description" : "Unknown dataset. Data set with the given data ID was not found (or is not shared with you)."
},
"272" : {
"description" : "No features found. The dataset did not contain any features, or we could not extract them."
},
"273" : {
"description" : "Dataset not processed yet. The dataset was not processed yet, features are not yet available. Please wait for a few minutes."
},
"274" : {
"description" : "Dataset processed with error. The feature extractor has run into an error while processing the dataset. Please check whether it is a valid supported file. If so, please contact the API admins."
}
}
}
},
"/data/qualities/{id}" : {
"get" : {
"summary" : "Get data qualities",
"description" : "Returns the qualities of a dataset.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "All the qualities of the dataset",
"schema" : {
"$ref" : "#/definitions/DataQualities"
},
"examples" : {
"application/json" : "{\n \"data_qualities\": {\n \"quality\": [\n {\n \"name\": \"ClassCount\",\n \"value\": \"3.0\"\n },\n {\n \"name\": \"ClassEntropy\",\n \"value\": \"1.584962500721156\"\n },\n {\n \"name\": \"NumberOfClasses\",\n \"value\": \"3\"\n },\n {\n \"name\": \"NumberOfFeatures\",\n \"value\": \"5\"\n },\n {\n \"name\": \"NumberOfInstances\",\n \"value\": \"150\"\n },\n {\n \"name\": \"NumberOfInstancesWithMissingValues\",\n \"value\": \"0\"\n },\n {\n \"name\": \"NumberOfMissingValues\",\n \"value\": \"0\"\n },\n {\n \"name\": \"NumberOfNumericFeatures\",\n \"value\": \"4\"\n },\n {\n \"name\": \"NumberOfSymbolicFeatures\",\n \"value\": \"0\"\n }\n ]\n }\n}"
}
},
"360" : {
"description" : "Please provide data set ID"
},
"361" : {
"description" : "Unknown dataset. The data set with the given ID was not found in the database, or is not shared with you."
},
"362" : {
"description" : "No qualities found. The registered dataset did not contain any calculated qualities."
},
"363" : {
"description" : "Dataset not processed yet. The dataset was not processed yet, no qualities are available. Please wait for a few minutes."
},
"364" : {
"description" : "Dataset processed with error. The quality calculator has run into an error while processing the dataset. Please check whether it is a valid supported file. If so, contact the support team."
},
"365" : {
"description" : "Interval start or end illegal. There was a problem with the interval start or end."
}
}
}
},
"/data/list" : {
"get" : {
"summary" : "List all datasets",
"description" : "Returns an array with all datasets in the system. Only returns the 'active' datasets, unless otherwise specified with the 'status' filter.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"370" : {
"description" : "No datasets available. There are no valid datasets in the system."
}
}
}
},
"/data/list/limit/{limit}/offset/{offset}" : {
"get" : {
"summary" : "List datasets within a range.",
"description" : "Returns an array with a limited number of datasets.\n",
"parameters" : [ {
"name" : "limit",
"in" : "path",
"description" : "Optional, although required in this interface. The maximum number of datasets to return. Without specifying an offset, it returns the first 'limit' datasets.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "offset",
"in" : "path",
"description" : "Optional (although required in this interface). The offset to start from. With /limit/5/offset/10, datasets 11..15 will be returned (these are indices, not IDs). Is ignored when no limit is given.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no valid datasets in the system."
}
}
}
},
"/data/list/tag/{tag}" : {
"get" : {
"summary" : "List datasets with given tag",
"description" : "Returns an array with all datasets in the system with the given tag. Can also be combined with limit and offset.\n",
"parameters" : [ {
"name" : "tag",
"in" : "path",
"description" : "The tag on which to filter the results",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets with the given tag",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no datasets in the system with the given tag."
}
}
}
},
"/data/list/data_name/{data_name}" : {
"get" : {
"summary" : "List datasets with the given name.",
"description" : "Returns a list with all datasets in the system with the given name. Can also be combined with all other filters.\n",
"parameters" : [ {
"name" : "data_name",
"in" : "path",
"description" : "The dataset name on which to filter the results",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets with the given name",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no datasets in the system with the given name."
}
}
}
},
"/data/list/{quality}/{value}" : {
"get" : {
"summary" : "List datasets with the given name.",
"description" : "Returns a list with all datasets in the system with the given qualities, where the quality can be 'number_instances', 'number_features', 'number_classes', or 'number_missing_values' \n",
"parameters" : [ {
"name" : "quality",
"in" : "path",
"description" : "The quality name on which to filter on, either 'number_instances', 'number_features', 'number_classes', or 'number_missing_values'",
"required" : true,
"type" : "string"
}, {
"name" : "value",
"in" : "path",
"description" : "The required value for the given quality. Can either be an exact value, e.g. '100' if you only want datasets with 100 instances, or a range '1..100' if you want all datasets with a number of instances between 1 and 100.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets with the given quality constraints",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no datasets in the system with the given quality constraints."
}
}
}
},
"/data/list/status/{status}" : {
"get" : {
"summary" : "List datasets with given status",
"description" : "Returns an array with all datasets in the system with the given status, either 'active', 'deactivated', 'in_preparation', or 'all'. 'all' returns all datasets regardless of status.\n",
"parameters" : [ {
"name" : "status",
"in" : "path",
"description" : "The status on which to filter the results, either 'active', 'deactivated', 'in_preparation', or 'all'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets with the given status",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no datasets in the system with the given status."
}
}
}
},
"/data/list/{filters}" : {
"get" : {
"summary" : "Get datasets by properties",
"description" : "Get tasks based on properties of the data - number_instances, number_features, number_classes or number_missing_values. Properties can be combined, and ranges can be used in the form '0..10'. Can also be combined with limits or tags. Returns an array with all datasets in the system that match the constraints.\n",
"parameters" : [ {
"name" : "filters",
"in" : "path",
"description" : "Any combination of filters (data_id, data_name, number_instances, number_features, number_classes, number_missing_values) and corresponding values or ranges, e.g. 'number_instances/0..50/number_features/0..10'. With or without limits, or tags.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of datasets with the given task",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"372" : {
"description" : "No datasets available. There are no datasets in the system with the given constraints."
}
}
}
},
"/data/tag" : {
"post" : {
"summary" : "Tag a dataset",
"description" : "Tags a dataset.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "data_id",
"in" : "formData",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "The id of the tagged dataset",
"schema" : {
"type" : "object",
"properties" : {
"data_tag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the tagged dataset"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"data_tag\": {\n \"id\": \"2\"\n }\n}"
}
},
"470" : {
"description" : "In order to add a tag, please upload the entity id (either data_id, flow_id, run_id) and tag (the name of the tag)."
},
"471" : {
"description" : "Entity not found. The provided entity_id {data_id, flow_id, run_id} does not correspond to an existing entity."
},
"472" : {
"description" : "Entity already tagged by this tag. The entity {dataset, flow, run} already had this tag."
},
"473" : {
"description" : "Something went wrong inserting the tag. Please contact OpenML Team."
},
"474" : {
"description" : "Internal error tagging the entity. Please contact OpenML Team."
}
}
}
},
"/data/untag" : {
"post" : {
"summary" : "Untag a dataset",
"description" : "Untags a dataset.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "data_id",
"in" : "formData",
"description" : "Id of the dataset.",
"required" : true,
"type" : "number"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "The ID of the untagged dataset",
"schema" : {
"type" : "object",
"properties" : {
"data_untag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the untagged dataset"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"data_untag\": {\n \"id\": \"2\"\n }\n}"
}
},
"475" : {
"description" : "Please give entity_id {data_id, flow_id, run_id} and tag. In order to remove a tag, please upload the entity id (either data_id, flow_id, run_id) and tag (the name of the tag)."
},
"476" : {
"description" : "Entity {dataset, flow, run} not found. The provided entity_id {data_id, flow_id, run_id} does not correspond to an existing entity."
},
"477" : {
"description" : "Tag not found. The provided tag is not associated with the entity {dataset, flow, run}."
},
"478" : {
"description" : "Tag is not owned by you. The entity {dataset, flow, run} was tagged by another user. Hence you cannot delete it."
},
"479" : {
"description" : "Internal error removing the tag. Please contact OpenML Team."
}
}
}
},
"/data/unprocessed/{data_engine_id}/{order}" : {
"get" : {
"summary" : "Get a list of unprocessed datasets",
"description" : "This call is for people running their own dataset processing engines. It returns the details of datasets that are not yet processed by the given processing engine. It doesn't process the datasets, it just returns the dataset info.\n",
"parameters" : [ {
"name" : "data_engine_id",
"in" : "path",
"description" : "The ID of the data processing engine. You get this ID when you register a new data processing engine with OpenML. The ID of the main data processing engine is 1.",
"required" : true,
"type" : "string"
}, {
"name" : "order",
"in" : "path",
"description" : "When there are multiple datasets still to process, this defines which ones to return. Options are 'normal' - the oldest datasets, or 'random'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "evaluation" ],
"responses" : {
"200" : {
"description" : "A list of unprocessed datasets",
"schema" : {
"$ref" : "#/definitions/DataUnprocessed"
},
"examples" : {
"application/json" : {
"data_unprocessed" : {
"run" : [ {
"did" : "1",
"name" : "anneal",
"version" : "2",
"status" : "deactivated",
"format" : "ARFF"
} ]
}
}
}
},
"681" : {
"description" : "No unprocessed datasets."
}
}
}
},
"/data/qualities/unprocessed/{data_engine_id}/{order}" : {
"post" : {
"summary" : "Get a list of datasets with unprocessed qualities\n",
"description" : "This call is for people running their own dataset processing engines. It returns the details of datasets for which certain qualities are not yet processed by the given processing engine. It doesn't process the datasets, it just returns the dataset info.\n",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "data_engine_id",
"in" : "path",
"description" : "The ID of the data processing engine. You get this ID when you register a new data processing engine with OpenML. The ID of the main data processing engine is 1.",
"required" : true,
"type" : "string"
}, {
"name" : "order",
"in" : "path",
"description" : "When there are multiple datasets still to process, this defines which ones to return. Options are 'normal' - the oldest datasets, or 'random'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
}, {
"name" : "qualities",
"in" : "formData",
"description" : "Comma-separated list of (at least two) quality names, e.g. 'NumberOfInstances,NumberOfFeatures'.",
"required" : true,
"type" : "string"
} ],
"tags" : [ "data" ],
"responses" : {
"200" : {
"description" : "A list of unprocessed datasets",
"schema" : {
"$ref" : "#/definitions/DataUnprocessed"
},
"examples" : {
"application/json" : {
"data_unprocessed" : {
"run" : [ {
"did" : "1",
"name" : "anneal",
"version" : "2",
"status" : "deactivated",
"format" : "ARFF"
} ]
}
}
}
},
"686" : {
"description" : "Please specify the features the evaluation engine wants to calculate (at least 2)."
},
"687" : {
"description" : "No unprocessed datasets according to the given set of meta-features."
},
"688" : {
"description" : "Illegal qualities."
}
}
}
},
"/task/{id}" : {
"get" : {
"summary" : "Get task description",
"description" : "Returns information about a task. The information includes the task type, input data, train/test sets, and more.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the task.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"150" : {
"description" : "Please provide task_id."
},
"151" : {
"description" : "Unknown task. The task with the given id was not found in the database"
},
"200" : {
"description" : "A task description",
"schema" : {
"$ref" : "#/definitions/Task"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"input\":[\n {\n \"name\":\"source_data\",\n \"data_set\":{\n \"data_set_id\":\"1\",\n \"target_feature\":\"class\"\n }\n },\n {\n \"name\":\"estimation_procedure\",\n \"estimation_procedure\":{\n \"type\":\"crossvalidation\",\n \"data_splits_url\":\"https://www.openml.org/api_splits/get/1/Task_1_splits.arff\",\n \"parameter\":[\n {\n \"name\":\"number_repeats\",\n \"value\":\"1\"\n },\n {\n \"name\":\"number_folds\",\n \"value\":\"10\"\n },\n {\n \"name\":\"percentage\"\n },\n {\n \"name\":\"stratified_sampling\",\n \"value\":\"true\"\n }\n ]\n }\n },\n {\n \"name\":\"cost_matrix\",\n \"cost_matrix\":[]\n },\n {\n \"name\":\"evaluation_measures\",\n \"evaluation_measures\":\n {\n \"evaluation_measure\":\"predictive_accuracy\"\n }\n }\n ],\n \"output\":{\n \"name\":\"predictions\",\n \"predictions\":{\n \"format\":\"ARFF\",\n \"feature\":[\n {\n \"name\":\"repeat\",\n \"type\":\"integer\"\n },\n {\n \"name\":\"fold\",\n \"type\":\"integer\"\n },\n {\n \"name\":\"row_id\",\n \"type\":\"integer\"\n },\n {\n \"name\":\"confidence.classname\",\n \"type\":\"numeric\"\n },\n {\n \"name\":\"prediction\",\n \"type\":\"string\"\n }\n ]\n }\n },\n \"tag\":[\"basic\",\"study_1\",\"under100k\",\"under1m\"]\n }\n}"
}
}
}
},
"delete" : {
"summary" : "Delete task",
"description" : "Deletes a task. Upon success, it returns the ID of the deleted task.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the task.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "ID of the deleted task",
"schema" : {
"type" : "object",
"properties" : {
"task_delete" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the deleted task, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"task_delete\": {\n \"id\": \"4328\"\n }\n}"
}
},
"450" : {
"description" : "Please provide API key. In order to remove your content, please authenticate."
},
"451" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators."
},
"452" : {
"description" : "Task does not exists. The task ID could not be linked to an existing task."
},
"454" : {
"description" : "Task is executed in some runs. Delete these first."
},
"455" : {
"description" : "Deleting the task failed. Please contact support team."
}
}
}
},
"/task" : {
"post" : {
"summary" : "Upload task",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads a task. Upon success, it returns the task id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the task. Only name, description, and task format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.task.upload) and an [XML example](https://www.openml.org/api/v1/xml_example/task).",
"required" : true,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "Id of the uploaded task",
"schema" : {
"type" : "object",
"properties" : {
"upload_task" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the uploaded task, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"upload_task\": {\n \"id\": \"4328\"\n }\n}"
}
},
"530" : {
"description" : "Description file not present. Please upload the task description."
},
"531" : {
"description" : "Internal error. Please contact api support team"
},
"532" : {
"description" : "Problem validating uploaded description file. The XML description format does not meet the standards"
},
"533" : {
"description" : "Task already exists."
},
"534" : {
"description" : "Error creating the task."
}
}
}
},
"/task/list" : {
"get" : {
"summary" : "List all tasks",
"description" : "Returns an array with all tasks in the system.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"default" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
}
},
"/task/list/limit/{limit}/offset/{offset}" : {
"get" : {
"summary" : "List tasks within a range",
"description" : "Returns an array with a limited number of tasks.\n",
"parameters" : [ {
"name" : "limit",
"in" : "path",
"description" : "Optional, although required in this interface. The maximum number of tasks to return. Without specifying an offset, it returns the first 'limit' tasks.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "offset",
"in" : "path",
"description" : "Optional (although required in this interface). The offset to start from. With /limit/5/offset/10, tasks 11..15 will be returned (these are indices, not IDs). Is ignored when no limit is given.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"default" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
}
},
"/task/list/status/{status}" : {
"get" : {
"summary" : "List tasks with given status",
"description" : "Returns an array with all tasks in the system with the given status, either 'active', 'deactivated', or 'in_preparation'.\n",
"parameters" : [ {
"name" : "status",
"in" : "path",
"description" : "The status on which to filter the results, either 'active', 'deactivated', or 'in_preparation'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks with the given status",
"schema" : {
"$ref" : "#/definitions/DataList"
},
"examples" : {
"application/json" : "{\n \"data\": {\n \"dataset\": [\n {\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\"\n ,\"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ]\n }\n ]\n }\n}"
}
},
"482" : {
"description" : "No tasks available. There are no tasks in the system with the given status."
}
}
}
},
"/task/list/type/{id}" : {
"get" : {
"summary" : "List tasks of given type.",
"description" : "Returns an array with all tasks for the given task type id (1 = Supervised Classification). Can be combined with limits and tags.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "On which task type id to filter the results",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"480" : {
"description" : "Please provide task type ID."
},
"482" : {
"description" : "No results. There where no matches for the given task type ID."
}
}
}
},
"/task/list/tag/{tag}" : {
"get" : {
"summary" : "List tasks with given tag",
"description" : "Returns an array with all tasks with the given tag. Can be combined with limits and other filters.\n",
"parameters" : [ {
"name" : "tag",
"in" : "path",
"description" : "The tag on which to filter the results",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks with the given tag",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"482" : {
"description" : "No results. There where no matches for the given task tag."
}
}
}
},
"/task/list/data_tag/{tag}" : {
"get" : {
"summary" : "List tasks with the given data tag",
"description" : "Returns an array with all tasks where the underlying dataset has the given tag. Can be combined with limits and other filters.\n",
"parameters" : [ {
"name" : "tag",
"in" : "path",
"description" : "The tag on which to filter the results",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks where the underlying dataset has the given tag",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"482" : {
"description" : "No results. There where no matches for the given data tag."
}
}
}
},
"/task/list/{filters}" : {
"get" : {
"summary" : "Get tasks by data properties",
"description" : "Get tasks based on properties of the underlying dataset - data_id, NumberOfInstances, NumberOfFeatures, NumberOfClasses or NumberOfMissingValues. Properties can be combined, and ranges can be used in the form '0..10'. Can also be combined with imits, tags, or types. Returns an array with all tasks in the system that match the constraints.\n",
"parameters" : [ {
"name" : "filters",
"in" : "path",
"description" : "Any combination of filters (data_id, NumberOfInstances, NumberOfFeatures, NumberOfClasses, NumberOfMissingValues) and corresponding values or ranges, e.g. 'NumberOfInstances/0..50/NumberOfFeatures/0..10'. With or without limits, tags, or types.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A list of tasks with the given tag",
"schema" : {
"$ref" : "#/definitions/TaskList"
},
"examples" : {
"application/json" : "{\n \"task\": {\n \"task\": [\n {\n \"task_id\":\"1\",\n \"task_type\":\"Supervised Classification\",\n \"did\":\"1\",\n \"name\":\"anneal\",\n \"status\":\"active\",\n \"format\":\"ARFF\",\n \"input\":[\n {\n \"name\":\"estimation_procedure\",\n \"value\":\"1\"\n },\n {\n \"name\":\"evaluation_measures\",\n \"value\":\"predictive_accuracy\"\n },\n {\n \"name\":\"source_data\",\n \"value\":\"1\"\n },\n {\n \"name\":\"target_feature\",\n \"value\":\"class\"\n }\n ],\n \"quality\":[\n {\n \"name\":\"MajorityClassSize\",\n \"value\":\"684\"\n },\n {\n \"name\":\"MaxNominalAttDistinctValues\",\n \"value\":\"10.0\"\n },\n {\n \"name\":\"MinorityClassSize\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumBinaryAtts\",\n \"value\":\"14.0\"\n },\n {\n \"name\":\"NumberOfClasses\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfFeatures\",\n \"value\":\"39\"\n },\n {\n \"name\":\"NumberOfInstances\",\n \"value\":\"898\"\n },\n {\n \"name\":\"NumberOfInstancesWithMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfMissingValues\",\n \"value\":\"0\"\n },\n {\n \"name\":\"NumberOfNumericFeatures\",\n \"value\":\"6\"\n },\n {\n \"name\":\"NumberOfSymbolicFeatures\",\n \"value\":\"32\"\n }\n ],\n \"tag\":[\n \"basic\",\n \"study_1\",\n \"study_7\",\n \"under100k\",\n \"under1m\"\n ]\n }\n ]\n }\n}"
}
},
"482" : {
"description" : "No results. There where no matches for the given constraints."
}
}
}
},
"/task/tag" : {
"post" : {
"summary" : "Tag a task",
"description" : "Tags a task.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "task_id",
"in" : "formData",
"description" : "Id of the task.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "The id of the tagged task",
"schema" : {
"type" : "object",
"properties" : {
"task_tag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the tagged task"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"task_tag\": {\n \"id\": \"2\"\n }\n}"
}
},
"470" : {
"description" : "In order to add a tag, please upload the entity id (either data_id, task_id, flow_id, run_id) and tag (the name of the tag)."
},
"471" : {
"description" : "Entity not found. The provided entity_id {data_id, task_id, flow_id, run_id} does not correspond to an existing entity."
},
"472" : {
"description" : "Entity already tagged by this tag. The entity {dataset, task, flow, run} already had this tag."
},
"473" : {
"description" : "Something went wrong inserting the tag. Please contact OpenML Team."
},
"474" : {
"description" : "Internal error tagging the entity. Please contact OpenML Team."
}
}
}
},
"/task/untag" : {
"post" : {
"summary" : "Untag a task",
"description" : "Untags a task.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "task_id",
"in" : "formData",
"description" : "Id of the task.",
"required" : true,
"type" : "number"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "task" ],
"responses" : {
"200" : {
"description" : "A the features of the task",
"schema" : {
"type" : "object",
"properties" : {
"task_untag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the untagged task"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"task_untag\": {\n \"id\": \"2\"\n }\n}"
}
},
"475" : {
"description" : "Please give entity_id {data_id, flow_id, run_id} and tag. In order to remove a tag, please upload the entity id (either data_id, task_id, flow_id, run_id) and tag (the name of the tag)."
},
"476" : {
"description" : "Entity {dataset, task, flow, run} not found. The provided entity_id {data_id, task_id, flow_id, run_id} does not correspond to an existing entity."
},
"477" : {
"description" : "Tag not found. The provided tag is not associated with the entity {dataset, task, flow, run}."
},
"478" : {
"description" : "Tag is not owned by you. The entity {dataset, flow, run} was tagged by another user. Hence you cannot delete it."
},
"479" : {
"description" : "Internal error removing the tag. Please contact OpenML Team."
}
}
}
},
"/tasktype/{id}" : {
"get" : {
"summary" : "Get task type description",
"description" : "Returns information about a task type. The information includes a description, the given inputs and the expected outputs.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the task.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "tasktype" ],
"responses" : {
"200" : {
"description" : "A task type description",
"schema" : {
"$ref" : "#/definitions/TaskType"
},
"examples" : {
"application/json" : "{\n \"task_type\": {\n \"id\": \"1\",\n \"name\": \"Supervised Classification\",\n \"description\": \"In supervised classification, you are given an input dataset in which instances are labeled with a certain class. The goal is to build a model that predicts the class for future unlabeled instances. The model is evaluated using a train-test procedure, e.g. cross-validation.<br><br>\\n\\nTo make results by different users comparable, you are given the exact train-test folds to be used, and you need to return at least the predictions generated by your model for each of the test instances. OpenML will use these predictions to calculate a range of evaluation measures on the server.<br><br>\\n\\nYou can also upload your own evaluation measures, provided that the code for doing so is available from the implementation used. For extremely large datasets, it may be infeasible to upload all predictions. In those cases, you need to compute and provide the evaluations yourself.<br><br>\\n\\nOptionally, you can upload the model trained on all the input data. There is no restriction on the file format, but please use a well-known format or PMML.\",\n \"creator\": [\n \"Joaquin Vanschoren\",\n \"Jan van Rijn\",\n \"Luis Torgo\",\n \"Bernd Bischl\"\n ],\n \"contributor\": [\n \"Bo Gao\",\n \"Simon Fischer\",\n \"Venkatesh Umaashankar\",\n \"Michael Berthold\",\n \"Bernd Wiswedel\",\n \"Patrick Winter\"\n ],\n \"creation_date\": \"2013-01-24 00:00:00\",\n \"input\": [\n {\n \"name\": \"source_data\",\n \"requirement\": \"required\",\n \"data_type\": \"numeric\"\n },\n {\n \"name\": \"target_feature\",\n \"requirement\": \"required\",\n \"data_type\": \"string\"\n },\n {\n \"name\": \"estimation_procedure\",\n \"requirement\": \"required\",\n \"data_type\": \"numeric\"\n },\n {\n \"name\": \"cost_matrix\",\n \"data_type\": \"json\"\n },\n {\n \"name\": \"custom_testset\",\n \"data_type\": \"json\"\n },\n {\n \"name\": \"evaluation_measures\",\n \"data_type\": \"string\"\n }\n ]\n }\n}"
}
},
"240" : {
"description" : "Please provide task type ID."
},
"241" : {
"description" : "Unknown task type. The task type with the given id was not found in the database"
}
}
}
},
"/tasktype/list" : {
"get" : {
"summary" : "List all task types",
"description" : "Returns an array with all task types in the system.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "tasktype" ],
"responses" : {
"200" : {
"description" : "A task description",
"schema" : {
"$ref" : "#/definitions/TaskTypeList"
},
"examples" : {
"application/json" : "{\n \"task_types\":{\n \"task_type\":[\n {\n \"id\":\"1\",\n \"name\":\"Supervised Classification\",\n \"description\":\"In supervised classification, you are given ...\",\n \"creator\":\"Joaquin Vanschoren, Jan van Rijn, Luis Torgo, Bernd Bischl\"\n },\n {\n \"id\":\"2\",\n \"name\":\"Supervised Regression\",\n \"description\":\"Given a dataset with a numeric target ...\",\n \"creator\":\"Joaquin Vanschoren, Jan van Rijn, Luis Torgo, Bernd Bischl\"\n },{}\n ]\n }\n}"
}
},
"default" : {
"description" : "Unexpected error",
"schema" : {
"$ref" : "#/definitions/Error"
}
}
}
}
},
"/flow/{id}" : {
"get" : {
"summary" : "Get flow description",
"description" : "Returns information about a flow. The information includes the name, information about the creator, dependencies, parameters, run instructions and more.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the flow.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"180" : {
"description" : "Please provide flow id."
},
"181" : {
"description" : "Unknown flow. The flow with the given ID was not found in the database."
},
"200" : {
"description" : "A flow description",
"schema" : {
"$ref" : "#/definitions/Flow"
},
"examples" : {
"application/json" : "{\n \"flow\": {\n \"id\":\"100\",\n \"uploader\":\"1\",\n \"name\":\"weka.J48\",\n \"version\":\"2\",\n \"external_version\":\"Weka_3.7.5_9117\",\n \"description\":\"...\",\n \"upload_date\":\"2014-04-23 18:00:36\",\n \"language\":\"Java\",\n \"dependencies\":\"Weka_3.7.5\",\n \"parameter\": [\n {\n \"name\":\"A\",\n \"data_type\":\"flag\",\n \"default_value\":[],\n \"description\":\"Laplace smoothing...\"\n },\n {\n \"name\":\"C\",\n \"data_type\":\"option\",\n \"default_value\":\"0.25\",\n \"description\":\"Set confidence threshold...\"\n }\n ]\n }\n}"
}
}
}
},
"delete" : {
"summary" : "Delete a flow",
"description" : "Deletes a flow. Upon success, it returns the ID of the deleted flow.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the flow.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "ID of the deleted flow",
"schema" : {
"type" : "object",
"properties" : {
"flow_delete" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the deleted flow, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"flow_delete\": {\n \"id\": \"4328\"\n }\n}"
}
},
"320" : {
"description" : "Please provide API key. In order to remove your content, please authenticate."
},
"321" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators ."
},
"322" : {
"description" : "Flow does not exists. The flow ID could not be linked to an existing flow."
},
"323" : {
"description" : "Flow is not owned by you. The flow is owned by another user. Hence you cannot delete it."
},
"324" : {
"description" : "Flow is in use by other content. Can not be deleted. The flow is used in runs, evaluations or as a component of another flow. Delete other content before deleting thisflow."
},
"325" : {
"description" : "Deleting flow failed. Deleting the flow failed. Please contact support team."
}
}
}
},
"/flow" : {
"post" : {
"summary" : "Upload a flow",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads a flow. Upon success, it returns the flow id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the flow. Only name and description are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.implementation.upload) and an [XML example](https://www.openml.org/api/v1/xml_example/flow).",
"required" : true,
"type" : "file"
}, {
"name" : "flow",
"in" : "formData",
"description" : "The actual flow, being a source (or binary) file.",
"required" : false,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"160" : {
"description" : "Error in file uploading. There was a problem with the file upload."
},
"161" : {
"description" : "Please provide description xml."
},
"163" : {
"description" : "Problem validating uploaded description file. The XML description format does not meet the standards."
},
"164" : {
"description" : "Flow already stored in database. Please change name or version number"
},
"165" : {
"description" : "Failed to insert flow. There can be many causes for this error. If you included the implements field, it should be an existing entry in the algorithm or math_function table. Otherwise it could be an internal server error. Please contact API support team."
},
"166" : {
"description" : "Failed to add flow to database. Internal server error, please contact API administrators"
},
"167" : {
"description" : "Illegal files uploaded. An non required file was uploaded."
},
"168" : {
"description" : "The provided md5 hash equals not the server generated md5 hash of the file."
},
"169" : {
"description" : "Please provide API key. In order to share content, please authenticate and provide API key."
},
"170" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact API administrators"
},
"171" : {
"description" : "Flow already exists. This flow is already in the database"
},
"172" : {
"description" : "XSD not found. Please contact API support team"
},
"200" : {
"description" : "Id of the uploaded flow",
"schema" : {
"type" : "object",
"properties" : {
"upload_flow" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the uploaded flow, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"upload_flow\": {\n \"id\": \"2520\"\n }\n}"
}
}
}
}
},
"/flow/exists/{name}/{version}" : {
"get" : {
"summary" : "Check whether flow exists",
"description" : "Checks whether a flow with the given name and (external) version exists.\n",
"parameters" : [ {
"name" : "name",
"in" : "path",
"description" : "The name of the flow.",
"required" : true,
"type" : "string"
}, {
"name" : "version",
"in" : "path",
"description" : "The external version of the flow",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "A list of flows",
"schema" : {
"type" : "object",
"properties" : {
"flow_exists" : {
"type" : "object",
"properties" : {
"exists" : {
"type" : "string",
"description" : "true or false"
},
"id" : {
"type" : "string",
"description" : "The id of the flow with the given name and (external) version"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"flow_exists\": {\n \"exists\": \"true\",\n \"id\": \"65\"\n }\n}"
}
},
"330" : {
"description" : "Mandatory fields not present. Please provide name and external_version."
}
}
}
},
"/flow/list" : {
"get" : {
"summary" : "List all flows",
"description" : "Returns an array with all flows in the system.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "A list of flows",
"schema" : {
"$ref" : "#/definitions/FlowList"
},
"examples" : {
"application/json" : "{\n \"flows\":\n {\n \"flow\":[\n {\n \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\",\n \"name\":\"weka.RandomForest\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\":\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\",\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n }\n ]\n }\n }"
}
},
"500" : {
"description" : "There where no results."
}
}
}
},
"/flow/list/limit/{limit}/offset/{offset}" : {
"get" : {
"summary" : "List flows within a range",
"description" : "Returns an array with the requested flows.\n",
"parameters" : [ {
"name" : "limit",
"in" : "path",
"description" : "Optional, although required in this interface. The maximum number of flows to return. Without specifying an offset, it returns the first 'limit' flows.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "offset",
"in" : "path",
"description" : "Optional (although required in this interface). The offset to start from. With /limit/5/offset/10, flows 11..15 will be returned (these are indices, not IDs). Is ignored when no limit is given.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "A list of flows",
"schema" : {
"$ref" : "#/definitions/FlowList"
},
"examples" : {
"application/json" : "{\n \"flows\":\n {\n \"flow\":[\n {\n \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\",\n \"name\":\"weka.RandomForest\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\":\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\",\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n }\n ]\n }\n }"
}
},
"500" : {
"description" : "There where no results."
}
}
}
},
"/flow/list/tag/{tag}" : {
"get" : {
"summary" : "List flows with given tag.",
"description" : "Returns an array with all flows in the system with the given tag.\n",
"parameters" : [ {
"name" : "tag",
"in" : "path",
"description" : "The tag on which to filter the results",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "A list of flows with the given tag",
"schema" : {
"$ref" : "#/definitions/FlowList"
},
"examples" : {
"application/json" : "{\n \"flows\":\n {\n \"flow\":[\n {\n \"id\":\"65\",\n \"full_name\":\"weka.RandomForest(1)\",\n \"name\":\"weka.RandomForest\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_9186\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"66\",\n \"full_name\":\"weka.IBk(1)\",\n \"name\":\"weka.IBk\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n },\n {\n \"id\":\"67\",\n \"full_name\":\"weka.BayesNet_K2(1)\",\n \"name\":\"weka.BayesNet_K2\",\n \"version\":\"1\",\n \"external_version\":\"Weka_3.7.10_8034\",\n \"uploader\":\"1\"\n }\n ]\n }\n }"
}
},
"500" : {
"description" : "There where no results."
}
}
}
},
"/flow/owned" : {
"get" : {
"summary" : "List flows owned by you",
"description" : "Returns an array with all flows owned by you.\n",
"parameters" : [ {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "A list of flows",
"schema" : {
"type" : "object",
"properties" : {
"flow_owned" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"flow_owned\": {\n \"id\": [\n \"111\",\n \"112\",\n \"113\",\n \"114\",\n \"115\",\n \"116\",\n \"117\"\n ]\n }\n}"
}
},
"310" : {
"description" : "Please provide API key to authenticate."
},
"311" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators."
},
"312" : {
"description" : "No flows owned by you."
}
}
}
},
"/flow/tag" : {
"post" : {
"summary" : "Tag a flow",
"description" : "Tags a flow.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "flow_id",
"in" : "formData",
"description" : "Id of the flow.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "The id of the tagged flow",
"schema" : {
"type" : "object",
"properties" : {
"flow_tag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the tagged flow"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"flow_tag\": {\n \"id\": \"2\"\n }\n}"
}
},
"470" : {
"description" : "In order to add a tag, please upload the entity id (either data_id, flow_id, run_id) and tag (the name of the tag)."
},
"471" : {
"description" : "Entity not found. The provided entity_id {data_id, flow_id, run_id} does not correspond to an existing entity."
},
"472" : {
"description" : "Entity already tagged by this tag. The entity {dataset, flow, run} already had this tag."
},
"473" : {
"description" : "Something went wrong inserting the tag. Please contact OpenML Team."
},
"474" : {
"description" : "Internal error tagging the entity. Please contact OpenML Team."
}
}
}
},
"/flow/untag" : {
"post" : {
"summary" : "Untag a flow",
"description" : "Untags a flow.",
"consumes" : [ "application/x-www-form-urlencoded" ],
"parameters" : [ {
"name" : "flow_id",
"in" : "formData",
"description" : "Id of the flow.",
"required" : true,
"type" : "number"
}, {
"name" : "tag",
"in" : "formData",
"description" : "Tag name",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "formData",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "flow" ],
"responses" : {
"200" : {
"description" : "The id of the untagged flow",
"schema" : {
"type" : "object",
"properties" : {
"flow_untag" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the untagged flow"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"flow_untag\": {\n \"id\": \"2\"\n }\n}"
}
},
"475" : {
"description" : "Please give entity_id {data_id, flow_id, run_id} and tag. In order to remove a tag, please upload the entity id (either data_id, flow_id, run_id) and tag (the name of the tag)."
},
"476" : {
"description" : "Entity {dataset, flow, run} not found. The provided entity_id {data_id, flow_id, run_id} does not correspond to an existing entity."
},
"477" : {
"description" : "Tag not found. The provided tag is not associated with the entity {dataset, flow, run}."
},
"478" : {
"description" : "Tag is not owned by you. The entity {dataset, flow, run} was tagged by another user. Hence you cannot delete it."
},
"479" : {
"description" : "Internal error removing the tag. Please contact OpenML Team."
}
}
}
},
"/setup/{id}" : {
"get" : {
"summary" : "Get a hyperparameter setup",
"description" : "Returns information about a setup. The information includes the list of hyperparameters, with name, value, and default value.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the hyperparameter setup (configuration). These IDs are stated in run descriptions.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "setup" ],
"responses" : {
"200" : {
"description" : "A setup description",
"schema" : {
"$ref" : "#/definitions/Setup"
},
"examples" : {
"application/json" : "{\n \"setup_parameters\":{\n \"flow_id\":\"59\",\n \"parameter\":[\n {\n \"full_name\":\"weka.JRip(1)_F\",\n \"parameter_name\":\"F\",\n \"data_type\":\"option\",\n \"default_value\":\"3\",\n \"value\":\"3\"\n },{\n \"full_name\":\"weka.JRip(1)_N\",\n \"parameter_name\":\"N\",\n \"data_type\":\"option\",\n \"default_value\":\"2.0\",\n \"value\":\"2.0\"\n },{\n \"full_name\":\"weka.JRip(1)_O\",\n \"parameter_name\":\"O\",\n \"data_type\":\"option\",\n \"default_value\":\"2\",\n \"value\":\"2\"\n },{\n \"full_name\":\"weka.JRip(1)_S\",\n \"parameter_name\":\"S\",\n \"data_type\":\"option\",\n \"default_value\":\"1\",\n \"value\":\"1\"\n }]\n }\n}"
}
},
"280" : {
"description" : "Please provide setup ID. In order to view setup details, please provide the run ID"
},
"281" : {
"description" : "Setup not found. The setup ID was invalid, or setup does not exist (anymore)."
}
}
}
},
"/run/{id}" : {
"get" : {
"summary" : "Get run description",
"description" : "Returns information about a run. The information includes the name, information about the creator, dependencies, parameters, run instructions and more.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "ID of the run.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A run description",
"schema" : {
"$ref" : "#/definitions/Run"
},
"examples" : {
"application/json" : "{\n \"run\": {\n \"run_id\":\"100\",\n \"uploader\":\"1\",\n \"uploader_name\":\"Jan van Rijn\",\n \"task_id\":\"28\",\n \"task_type\":\"Supervised Classification\",\n \"task_evaluation_measure\":\"predictive_accuracy\",\n \"flow_id\":\"67\",\n \"flow_name\":\"weka.BayesNet_K2(1)\",\n \"setup_string\":\"weka.classifiers.bayes.BayesNet -- -D -Q weka.classifiers.bayes.net.search.local.K2 -- -P 1 -S BAYES -E weka.classifiers.bayes.net.estimate.SimpleEstimator -- -A 0.5\",\n \"parameter_setting\": [\n {\n \"name\":\"D\",\n \"value\":\"true\"\n },\n {\n \"name\":\"Q\",\n \"value\":\"weka.classifiers.bayes.net.search.local.K2\"\n },\n {\n \"name\":\"P\",\n \"value\":\"1\"\n },\n {\n \"name\":\"S\",\n \"value\":\"BAYES\"\n }\n ],\n \"input_data\":\n {\n \"dataset\":\n {\n \"did\":\"28\",\n \"name\":\"optdigits\",\n \"url\":\"https:\\/\\/www.openml.org\\/data\\/download\\/28\\/dataset_28_optdigits.arff\"\n }\n },\n \"output_data\":\n {\n \"file\": [\n {\n \"did\":\"48838\",\n \"file_id\":\"261\",\n \"name\":\"description\",\n \"url\":\"https:\\/\\/www.openml.org\\/data\\/download\\/261\\/weka_generated_run935374685998857626.xml\"\n },\n {\n \"did\":\"48839\",\n \"file_id\":\"262\",\n \"name\":\"predictions\",\n \"url\":\"https:\\/\\/www.openml.org\\/data\\/download\\/262\\/weka_generated_predictions576954524972002741.arff\"\n }\n ],\n \"evaluation\": [\n {\n \"name\":\"area_under_roc_curve\",\n \"flow_id\":\"4\",\n \"value\":\"0.990288\",\n \"array_data\":\"[0.99724,0.989212,0.992776,0.994279,0.980578,0.98649,0.99422,0.99727,0.994858,0.976143]\"\n },\n {\n \"name\":\"confusion_matrix\",\n \"flow_id\":\"10\",\n \"array_data\":\"[[544,1,0,0,7,0,1,0,0,1],[0,511,21,1,0,1,3,1,5,28],[0,7,511,1,0,1,0,3,23,11],[0,2,2,519,0,3,0,12,16,18],[0,3,0,0,528,0,4,21,6,6],[0,1,0,7,5,488,2,0,4,51],[1,7,0,0,2,0,548,0,0,0],[0,2,0,1,9,1,0,545,4,4],[1,25,2,2,3,6,2,1,503,9],[0,7,0,20,16,5,0,19,9,486]]\"\n },\n {\n \"name\":\"f_measure\",\n \"flow_id\":\"12\",\n \"value\":\"0.922723\",\n \"array_data\":\"[0.989091,0.898857,0.935041,0.92431,0.927944,0.918156,0.980322,0.933219,0.895018,0.826531]\"\n },\n {\n \"name\":\"kappa\",\n \"flow_id\":\"13\",\n \"value\":\"0.913601\"\n }\n ]\n }\n }\n}"
}
},
"220" : {
"description" : "Please provide run ID. In order to view run details, please provide the run ID"
},
"221" : {
"description" : "Run not found. The run ID was invalid, run does not exist (anymore)."
}
}
},
"delete" : {
"summary" : "Delete run",
"description" : "Deletes a run. Upon success, it returns the ID of the deleted run.\n",
"parameters" : [ {
"name" : "id",
"in" : "path",
"description" : "Id of the run.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "ID of the deleted run",
"schema" : {
"type" : "object",
"properties" : {
"data_delete" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the deleted run, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"run_delete\": {\n \"id\": \"2520\"\n }\n}"
}
},
"390" : {
"description" : "Please provide API key. In order to remove your content, please authenticate."
},
"391" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators"
},
"392" : {
"description" : "Run does not exists. The run ID could not be linked to an existing run."
},
"393" : {
"description" : "Run is not owned by you. The run was owned by another user. Hence you cannot delete it."
},
"394" : {
"description" : "Deleting run failed. Deleting the run failed. Please contact support team."
}
}
}
},
"/run" : {
"post" : {
"summary" : "Upload run",
"consumes" : [ "multipart/form-data" ],
"description" : "Uploads a run. Upon success, it returns the run id.\n",
"parameters" : [ {
"name" : "description",
"in" : "formData",
"description" : "An XML file describing the dataset. Only name, description, and data format are required. Also see the [XSD schema](https://www.openml.org/api/v1/xsd/openml.run.upload) and an [XML example](https://www.openml.org/api/v1/xml_example/run).",
"required" : true,
"type" : "file"
}, {
"name" : "predictions",
"in" : "formData",
"description" : "The predictions generated by the run",
"required" : true,
"type" : "file"
}, {
"name" : "model_readable",
"in" : "formData",
"description" : "The human-readable model generated by the run",
"required" : false,
"type" : "file"
}, {
"name" : "model_serialized",
"in" : "formData",
"description" : "The serialized model generated by the run",
"required" : false,
"type" : "file"
}, {
"name" : "api_key",
"in" : "query",
"description" : "Api key to authenticate the user",
"required" : true,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "Id of the uploaded run",
"schema" : {
"type" : "object",
"properties" : {
"upload_flow" : {
"type" : "object",
"properties" : {
"id" : {
"type" : "string",
"description" : "ID of the uploaded run, a positive integer"
}
}
}
}
},
"examples" : {
"application/json" : "{\n \"upload_run\": {\n \"id\": \"2520\"\n }\n}"
}
},
"201" : {
"description" : "Authentication failed. The API key was not valid. Please try to login again, or contact api administrators."
},
"202" : {
"description" : "Please provide run XML."
},
"203" : {
"description" : "Could not validate run xml by XSD. Please double check that the xml is valid."
},
"204" : {
"description" : "Unknown task. The task with the given ID was not found in the database."
},
"205" : {
"description" : "Unknown flow. The flow with the given ID was not found in the database."
},
"206" : {
"description" : "Invalid number of files. The number of uploaded files did not match the number of files expected for the task type"
},
"207" : {
"description" : "File upload failed. One of the files uploaded has a problem."
},
"208" : {
"description" : "Error inserting setup record. Please contact api administrators"
},
"210" : {
"description" : "Unable to store run. Please contact api administrators."
},
"211" : {
"description" : "Dataset not in database. One of the datasets of the task was not included in database, please contact api administrators."
},
"212" : {
"description" : "Unable to store file. Please contact api administrators."
},
"213" : {
"description" : "Parameter in run xml unknown. One of the parameters provided in the run xml is not registered as parameter for the flow nor its components."
},
"214" : {
"description" : "Unable to store input setting. Please contact API support team."
},
"215" : {
"description" : "Unable to evaluate predictions. Please contact API support team."
},
"216" : {
"description" : "Error thrown by Java Application. Additional information field is provided."
},
"217" : {
"description" : "Error processing output data. Unknown or inconsistent evaluation measure. One of the provided evaluation measures could not be matched with a record in the math_function or flow table."
},
"218" : {
"description" : "Wrong flow associated with run. The flow implements a math_function, which is unable to generate predictions. Please select another flow."
},
"219" : {
"description" : "Error reading the XML document. The XML description file could not be verified."
}
}
}
},
"/run/list/limit/{limit}/offset/{offset}" : {
"get" : {
"summary" : "Get runs by limit/offset",
"description" : "Returns an array with all runs matching the given limit and offset.\n",
"parameters" : [ {
"name" : "limit",
"in" : "path",
"description" : "The maximum number of runs to return. Without specifying an offset, it returns the first 'limit' runs.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "offset",
"in" : "path",
"description" : "Optional (although required in this interface). The offset to start from. With /limit/5/offset/10, runs 11..15 will be returned (these are indices, not IDs). Is ignored when no limit is given.",
"required" : true,
"type" : "number",
"format" : "integer"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "100",
"task_id" : "28",
"setup_id" : "12",
"flow_id" : "67",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "101",
"task_id" : "48",
"setup_id" : "6",
"flow_id" : "61",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "102",
"task_id" : "41",
"setup_id" : "3",
"flow_id" : "58",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/run/{ids}" : {
"get" : {
"summary" : "Get runs by id(s)",
"description" : "Returns an array with all runs matching the given run id(s).\n",
"parameters" : [ {
"name" : "ids",
"in" : "path",
"description" : "Comma-separated list of run IDs, e.g. '1,2,3'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "100",
"task_id" : "28",
"setup_id" : "12",
"flow_id" : "67",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "101",
"task_id" : "48",
"setup_id" : "6",
"flow_id" : "61",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "102",
"task_id" : "41",
"setup_id" : "3",
"flow_id" : "58",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/tag/{tag}" : {
"get" : {
"summary" : "Get runs by tag",
"description" : "Returns an array with all runs matching the given tag.\n",
"parameters" : [ {
"name" : "tag",
"in" : "path",
"description" : "The tag on which to filter the results.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs with the given tag",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "100",
"task_id" : "28",
"setup_id" : "12",
"flow_id" : "67",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "101",
"task_id" : "48",
"setup_id" : "6",
"flow_id" : "61",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "102",
"task_id" : "41",
"setup_id" : "3",
"flow_id" : "58",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, tag, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id, tag) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/task/{ids}" : {
"get" : {
"summary" : "Get runs by task(s)",
"description" : "Returns an array with all runs belonging to one of the given task(s).\n",
"parameters" : [ {
"name" : "ids",
"in" : "path",
"description" : "Comma-separated list of task IDs, e.g. '1,2,3'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "142564",
"task_id" : "1",
"setup_id" : "829",
"flow_id" : "362",
"uploader" : "212",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "249273",
"task_id" : "1",
"setup_id" : "829",
"flow_id" : "362",
"uploader" : "348",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "249280",
"task_id" : "1",
"setup_id" : "829",
"flow_id" : "362",
"uploader" : "348",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/uploader/{ids}" : {
"get" : {
"summary" : "Get runs by uploader(s)",
"description" : "Returns an array with all runs uploaded by one of the given user(s).\n",
"parameters" : [ {
"name" : "ids",
"in" : "path",
"description" : "Comma-separated list of user IDs, e.g. '1,2,3'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "45015",
"task_id" : "1",
"setup_id" : "1225",
"flow_id" : "673",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "45016",
"task_id" : "1",
"setup_id" : "1225",
"flow_id" : "673",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "54729",
"task_id" : "1",
"setup_id" : "1468",
"flow_id" : "707",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/flow/{ids}" : {
"get" : {
"summary" : "Get runs by flow(s)",
"description" : "Returns an array with all runs generated by the given flow(s).\n",
"parameters" : [ {
"name" : "ids",
"in" : "path",
"description" : "Comma-separated list of user IDs, e.g. '1,2,3'.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "413",
"task_id" : "1",
"setup_id" : "10",
"flow_id" : "65",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "6253",
"task_id" : "1",
"setup_id" : "10",
"flow_id" : "65",
"uploader" : "17",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "10451",
"task_id" : "1",
"setup_id" : "79",
"flow_id" : "65",
"uploader" : "17",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/list/{filters}" : {
"get" : {
"summary" : "Get runs by limit, id, task, uploader and/or flow",
"description" : "Returns an array with all runs matching any or all of the given filters. You can combine any of the above filters any way you want.\n",
"parameters" : [ {
"name" : "filters",
"in" : "path",
"description" : "Any combination of filters (run,task,uploader and/or flow) and corresponding comma-separated IDs, e.g. 'run/1,2,3/uploader/1' or 'task/1,2,3/flow/1,2'. With or without limit.",
"required" : true,
"type" : "string"
}, {
"name" : "api_key",
"in" : "query",
"description" : "API key to authenticate the user",
"required" : false,
"type" : "string"
} ],
"tags" : [ "run" ],
"responses" : {
"200" : {
"description" : "A list of runs descriptions",
"schema" : {
"$ref" : "#/definitions/RunList"
},
"examples" : {
"application/json" : {
"runs" : {
"run" : [ {
"run_id" : "100",
"task_id" : "28",
"setup_id" : "12",
"flow_id" : "67",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "101",
"task_id" : "48",
"setup_id" : "6",
"flow_id" : "61",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
}, {
"run_id" : "102",
"task_id" : "41",
"setup_id" : "3",
"flow_id" : "58",
"uploader" : "1",
"upload_time" : "2014-04-06 23:30:40",
"error_message" : [ ]
} ]
}
}
}
},
"510" : {
"description" : "Please provide at least task, flow or setup, uploader or run, to filter results, or limit the number of responses. The number of runs is huge. Please limit the result space."
},
"511" : {
"description" : "Input not safe. The input parameters (task_id, setup_id, flow_id, run_id, uploader_id) did not meet the constraints (comma separated list of integers)."
},
"512" : {
"description" : "There where no results. Check whether there are runs under the given constraint."
},
"513" : {
"description" : "Too many results. Given the constraints, there were still too many results. Please add more filters."
}
}
}
},
"/run/tag" : {
"post" : {
"summary" : "Tag a run",
"description" : "Tags a run.",