API 1.1 Change log - genomizer/genomizer-documentation GitHub Wiki

API 1.1 Change Log

A big overhaul has been done to the remains of the API from last year.

LOGIN

POST /login

Request Change:

None.

Response Change:

Added field: ’’role’’

GET /token

Deprecated

DELETE /login

No changes done.

EXPERIMENT

POST /experiment

Request Change:

None.

Response Change:

Response code changed to 200 (from 201)

GET /experiment/

<experimentID

Request Change:

None.

Response Change:

  • Field name changes:

    • ’’fileId’’ --> ’’id’’

    • ’’ExperimentID’’ --> ’’expId’’

    • ’’fileName’’ --> ’’filename’’

  • Removed fields:

    • isPrivate removed

  • New fields:

    • ’’fileSize’’ added

    • ’’path’’ added

    • ’’url’’ added

    • ’’date’’ added

PUT /experiment/

<experimentID

Request Change:

None.

Response Change:

Response code changed to 200 (from 201)

Response code 404 added if experiment dosn’t exist.

DELETE /experiment/

<experimentID

Request Change:

None.

Response Change:

Respons code 404 added if experiment dosn’t exist.

SEARCH

GET /search/?annotation=...

Request Change:

None.

Response Change:

  • New fields:

    • ’’metaData’’ added

    • ’’fileSize’’ added

FILE

POST /file

Request Change:

  • Removed fields:

    • uploader field removed

  • Fields added:

    • ’’checkSumMD5’’ added

Response Change:

GET /file/

<fileid

Request Change:

None.

Response Change:

  • Field name changes:

    • ’’fileId’’ --> ’’id’’

    • ’’ExperimentID’’ --> ’’expId’’

    • ’’fileName’’ --> ’’filename’’

  • Removed fields:

    • isPrivate removed

  • New fields:

    • ’’fileSize’’ added

    • ’’path’’ added

    • ’’url’’ added

    • ’’date’’ added

    • ’’checkSumMD5’’ added

Response code 404 added if file dosn’t exist.

DELETE /file/

<fileid

Request Change:

None.

Response Change:

Response code 404 added if file dosn’t exist.

PUT /file/

<fileid

Request Change:

  • Fields renamed:

    • ’’fileName’’ --> ’’filename’’

  • New fields:

    • ’’checkSumMD5’’ added

Response code 200 from 201

Response code 404 added if file dosn’t exist.

NEW GROUP: FILE CONVERSION

PUT /convertfile

NEW COMMAND! Authorization: token. Request:

  • Fields:

    • ’’fileid’’

    • ’’toformat’’

Response:

  • Fields:

    • ’’id’’

    • ’’path’’

    • ’’url’’

    • ’’type’’

    • ’’filename’’

    • ’’date’’

    • ’’metaData’’

    • ’’author’’

    • ’’uploader’’

    • ’’expId’’

    • ’’grVersion’’

    • ’’filesize’’

    • ’’checkSumMD5’’

  • Response code: 200 OK

USER

Altered to only one command. Moved commands:

  • POST /user

  • DELETE /user/ <username

PUT /user

Authorization: token. Request:

  • Fields:

    • ’’oldPassword’’

    • ’’newPassword’’

    • ’’name’’

    • ’’email’’

Response:

  • Response code: 200 OK

NEW GROUP Admin

POST /admin/user

Authorization: token. Request:

  • Fields:

    • ’’username’’

    • ’’password’’

    • ’’privileges’’

    • ’’name’’

    • ’’email’’

Response:

  • Response code: 200 OK

PUT /admin/user

Authorization: token. Request:

  • Fields:

    • ’’username’’

    • ’’password’’

    • ’’privileges’’

    • ’’name’’

    • ’’email’’

Response:

  • Response code: 200 OK

DELETE /admin/user/

<user

Authorization: token. Request:

Response:

Response code: 200 OK

Response code: 404 Not found (if user dosn’t exist).

PROCESS

GET /process

Request:

Response:

PUT /process/rawtoprofile

Changed example to not crash in Google Chrome. Request:

Response:

Annotation

GET /annotation

Request:

Response:

POST /annotation/field

Request:

Response:

Response code 200 from 201.

PUT /annotation/field

Request:

Response:

Added response code 404 if field dosn’t exist.

DELETE /annotation/field/

<field-name

Request:

Response:

POST /annotation/value

Request:

Response:

Response code 200 from 201.

PUT /annotation/value

Request:

Response:

Response code 200 from 201.

Added 404 if value dosn’t exist.

DELETE /annotation/value/

<field

/ <value

Request:

Response:

Admin Tools

Deprecated entire group.

Genome release handling

GET /genomeRelease

Request:

Response:

POST /genomeRelease

Request:

Response:

Response code 200 from 201.

GET /genomeRelease/

<species

Request:

Response:

Response code 404 added.

DELETE /genomeRelease/

<species

/ <genomeversion

Request:

Response:

Response code 404 added.

GEO

Unchanged.

NEW GROUP File Upload

GET /upload

Authorization: token. Request:

Response:

Response code: 200 OK

Content-Type: (text/html)

POST /upload

Authorization: token. Request:

Response:

Response code: 200 OK

NEW GROUP File Download

POST /download

Authorization: token. Request:

Response:

Response code: 200 OK