InterMine Import Wizard API Specs - working draft
ISA-InterMine Data import wizard prototype spec
Version: 0.1.0
BasePath:/v1
LGPL 2.1
https://github.com/intermine/intermine/blob/dev/LICENSE
Access
[ Jump to Models ]
Table of Contents
Retrieve build status of a given mine (buildStatusGet)
Return type
DataBuildStatus
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
success
Begin build of specified mine (buildTriggerPost)
Return type
DataBuild
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
build triggered successfully
Up
post /mine/nameAvailability
Check if a given username+minename combo is taken (checkNameAvailability)
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xml
Request body
Return type
NameAvailability
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
Success
Up
post /file/properties/detect
Return identified file type (detectFileProperties)
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xmlmultipart/form-data
Request body
Return type
DataFileProperties
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
successfully detected file type
Upload File that has properties mapped (fileSavePost)
Finalise upload for a file that has already had its properties detected and mapped.
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xml
Request body
Responses
200
successfully saved provided File
Up
get /mine/config/{mineId}
Get mine config (getMineConfig)
return configured details (if any) for a given mineconfig id
Path parameters
mineId (required)
Path Parameter — ID of mineconfig to fetch format: int64
Return type
MineConfig
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
success
Up
get /supplementaryDataSources
Get list of possible supplementary data sources for this mine config (getSupplementaryDataSources)
Returns a list of possible external data sources to add to this mine, e.g. GO terms, publications, etc.
Return type
array[SupplementaryDataSource]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
Success
Up
post /mine/dataTool/{mineId}
Set tools to be used for the given mine (mineDataToolMineIdPost)
Path parameters
mineId (required)
Path Parameter — ID of mineconfig to set tools for format: int64
Return type
DataToolResponse
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
success
Up
get /mine/dataTools/{mineId}
Retrieve set of tools suitable for the given mine (mineDataToolsMineIdGet)
Path parameters
mineId (required)
Path Parameter — ID of mineconfig to fetch tools for format: int64
Return type
array[DataTool]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
success
Up
post /file/properties/save
Save file properties to a given InterMine pre-build config (saveFileProperties)
Following on from <code>detectFileProperties</code>, we need to save a set of configs associated with a file. This can be run multiple times, as the user may upload an unknown number of files.
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xml
Request body
Responses
200
successfully saved provided DataFileProperties details
Start new mine build config entry (setMineConfig)
Create a new entry for a set of uploaded files and associated configs to launch a new mine. This can allocate an id which all file uploads will be associated with.
Consumes
This API call consumes the following media types via the request header:
application/jsonapplication/xml
Request body
Return type
Integer
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
New mineconfig instance created
Up
post /supplementaryDataSources
set list of desired supplementary data sources (setSupplementaryDataSources)
Saves a list of possible external data sources to add to this mine, e.g. GO terms, publications, etc.
Return type
SupplementaryDataSourcesResponse
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/jsonapplication/xml
Responses
200
Success
[ Jump to Methods ]
Table of Contents
DataBuildDataBuildStatusDataFileDataFilePropertiesDataFilePropertiesResponseDataToolDataToolResponseMineConfigMineNameNameAvailabilitySupplementaryDataSourceSupplementaryDataSourcesResponse
buildStatus
complete
running
errored
not_yet_started
errorDetails (optional)
name
fileFormat
rowCount
filePreview (optional)
columnsToMap (optional)
organism
fileID
mineID
mappedColumns (optional)
organism (optional)
fileID
mineID
toolId (optional)
toolName (optional)
toolDescription (optional)
toolPreview (optional)
requiredClasses (optional)
ids of tools to use in this mine.
name (optional)
lab (optional)
mineUrl (optional)
privacy (optional)
private
unlisted
public
licence (optional)
humanName
modelName
description
url