API Documentation

$ curl 'http://dapi.lcsb.uni.lu/api/doLogin' -i -X POST \
    -H 'Content-Type: application/x-www-form-urlencoded' \
    -d 'login=user&password=passwd'

POST /api/doLogin HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Host: dapi.lcsb.uni.lu
Content-Length: 26

login=user&password=passwd

HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 56

{"info":"Login successful.","login":"user","token":"48"}

$ curl 'http://dapi.lcsb.uni.lu/api/doLogout' -i -X POST

POST /api/doLogout HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Set-Cookie: DAPI_TOKEN=; Path=/; Max-Age=0; Expires=Thu, 1 Jan 1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 15

{"status":"OK"}

$ curl 'http://dapi.lcsb.uni.lu/isAuthenticated' -i -X GET

$ curl 'http://dapi.lcsb.uni.lu/api/configuration/' -i -X GET

GET /api/configuration/ HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 160

{
  "commitId" : "5eacef75bd22e2b33b223a7898f8c423a4fa0c86",
  "buildTime" : "2025-01-23T07:49:17+0000",
  "buildVersion" : "1.0.0-devel",
  "dirty" : "false"
}

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/test-release/drugs/DB00006' -i -X GET

GET /api/database/DrugBank/releases/test-release/drugs/DB00006 HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1128

{
  "name" : "Bivalirudin",
  "description" : "Bivalirudin is a synthetic 20 residue peptide (thrombin inhibitor) which reversibly inhibits thrombin. Once bound to the active site, thrombin cannot activate fibrinogen into fibrin, the crucial step in the formation of thrombus. It is administered intravenously. Because it can cause blood stagnation, it is important to monitor changes in hematocrit, activated partial thromboplastin time, international normalized ratio and blood pressure.",
  "synonyms" : [ "Bivalirudinum", "Bivalirudin", "Hirulog", "Bivalirudina" ],
  "sourceIdentifier" : "drugbank:DB00006",
  "annotations" : [ ],
  "targets" : [ {
    "name" : "Prothrombin",
    "description" : null,
    "organism" : "taxonomy:9606",
    "sourceIdentifier" : "drugbankv4.target:BE0000048",
    "associatedDisease" : null,
    "identifiers" : [ "uniprot:P00734" ],
    "references" : [ "pubmed:11060732", "pubmed:11929334", "pubmed:11923794", "pubmed:11504570", "pubmed:11752352", "pubmed:11833835" ],
    "types" : [ "inhibitor" ]
  } ],
  "bloodBrainBarrier" : null,
  "approved" : null,
  "brandNames" : [ "Angiox" ]
}

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/test-release/drugs/?size=1' -i -X GET

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/test-release/drugs/?target_identifier=urn:miriam:uniprot:P30968' -i -X GET

$ curl 'http://dapi.lcsb.uni.lu/api/database/CTD/releases/test-release/drugs/?target_identifier=hgnc.symbol:MYC' -i -X GET

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1287

{
  "content" : [ {
    "name" : "Bivalirudin",
    "description" : "Bivalirudin is a synthetic 20 residue peptide (thrombin inhibitor) which reversibly inhibits thrombin. Once bound to the active site, thrombin cannot activate fibrinogen into fibrin, the crucial step in the formation of thrombus. It is administered intravenously. Because it can cause blood stagnation, it is important to monitor changes in hematocrit, activated partial thromboplastin time, international normalized ratio and blood pressure.",
    "synonyms" : [ "Bivalirudinum", "Bivalirudin", "Hirulog", "Bivalirudina" ],
    "sourceIdentifier" : "drugbank:DB00006",
    "annotations" : [ ],
    "targets" : [ {
      "name" : "Prothrombin",
      "description" : null,
      "organism" : "taxonomy:9606",
      "sourceIdentifier" : "drugbankv4.target:BE0000048",
      "associatedDisease" : null,
      "identifiers" : [ "uniprot:P00734" ],
      "references" : [ "pubmed:11060732", "pubmed:11929334", "pubmed:11923794", "pubmed:11504570", "pubmed:11752352", "pubmed:11833835" ],
      "types" : [ "inhibitor" ]
    } ],
    "bloodBrainBarrier" : null,
    "approved" : null,
    "brandNames" : [ "Angiox" ]
  } ],
  "totalPages" : 3,
  "totalElements" : 3,
  "numberOfElements" : 1,
  "size" : 1,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/database/' -i -X GET

GET /api/database/ HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 177

{
  "content" : [ {
    "name" : "DrugBank"
  }, {
    "name" : "CTD"
  } ],
  "totalPages" : 1,
  "totalElements" : 2,
  "numberOfElements" : 2,
  "size" : 20,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/files/' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"filename":"test", "length":127}'

POST /api/files/ HTTP/1.1
Content-Type: application/json
Host: dapi.lcsb.uni.lu
Content-Length: 33

{"filename":"test", "length":127}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 55

{
  "id" : 5,
  "filename" : "test",
  "length" : 127
}

$ curl 'http://dapi.lcsb.uni.lu/api/files/2' -i -X PATCH \
    -d 'file content'

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 54

{
  "id" : 2,
  "filename" : "test",
  "length" : 12
}

$ curl 'http://dapi.lcsb.uni.lu/api/files/6' -i -X DELETE

$ curl 'http://dapi.lcsb.uni.lu/api/files/' -i -X GET

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 196

{
  "content" : [ {
    "id" : 1,
    "filename" : "non-existing-file",
    "length" : 0
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/license/' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"url":"https://creativecommons.org/licenses/by-nc/4.0/legalcode", "name":"Creative Commons Attribution-NonCommercial 4.0 International", "content": "Using Creative Commons Public Licenses\nCreative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses..."}'

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 611

{
  "id" : 5,
  "name" : "Creative Commons Attribution-NonCommercial 4.0 International",
  "content" : "Using Creative Commons Public Licenses\nCreative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses...",
  "url" : "https://creativecommons.org/licenses/by-nc/4.0/legalcode"
}

$ curl 'http://dapi.lcsb.uni.lu/api/license/7' -i -X DELETE

HTTP/1.1 200 OK
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY

$ curl 'http://dapi.lcsb.uni.lu/api/license/' -i -X GET

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 815

{
  "content" : [ {
    "id" : 1,
    "name" : "test-name",
    "content" : "test-content",
    "url" : "http://dapi.lcsb.uni.lu/test"
  }, {
    "id" : 3,
    "name" : "fancy name",
    "content" : "Using Creative Commons Public Licenses\nCreative Commons public licenses provide a standard set of terms and conditions that creators and other rights holders may use to share original works of authorship and other material subject to copyright and certain other rights specified in the public license below. The following considerations are for informational purposes only, are not exhaustive, and do not form part of our licenses...",
    "url" : "https://creativecommons.org/licenses/by-nc/4.0/legalcode"
  } ],
  "totalPages" : 1,
  "totalElements" : 2,
  "numberOfElements" : 2,
  "size" : 20,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"file":14, "license":11}'

POST /api/database/DrugBank/releases/ HTTP/1.1
Content-Type: application/json
Host: dapi.lcsb.uni.lu
Content-Length: 25

{"file":14, "license":11}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 161

{
  "id" : 6,
  "name" : "5.1",
  "license" : {
    "id" : 11,
    "name" : "n",
    "content" : "",
    "url" : "u"
  },
  "timestamp" : "12-08-2019 00:00:00"
}

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/5.1:acceptLicense' -i -X POST

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/5.1' -i -X DELETE

$ curl 'http://dapi.lcsb.uni.lu/api/database/DrugBank/releases/' -i -X GET

GET /api/database/DrugBank/releases/ HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 546

{
  "content" : [ {
    "id" : 1,
    "name" : "test-release",
    "license" : {
      "id" : 1,
      "name" : "test-name",
      "content" : "test-content",
      "url" : "http://dapi.lcsb.uni.lu/test"
    },
    "timestamp" : "23-01-2025 07:49:40"
  }, {
    "id" : 9,
    "name" : "5.1",
    "license" : {
      "id" : 14,
      "name" : "name",
      "content" : "",
      "url" : "url"
    },
    "timestamp" : "12-08-2019 00:00:00"
  } ],
  "totalPages" : 1,
  "totalElements" : 2,
  "numberOfElements" : 2,
  "size" : 20,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/users/xyz' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"login":"xyz","password":"passwd","email":"piotr.gawron@uni.lu"}'

POST /api/users/xyz HTTP/1.1
Content-Type: application/json
Host: dapi.lcsb.uni.lu
Content-Length: 65

{"login":"xyz","password":"passwd","email":"piotr.gawron@uni.lu"}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 185

{
  "id" : 24,
  "name" : null,
  "email" : "piotr.gawron@uni.lu",
  "deleted" : false,
  "login" : "xyz",
  "enabled" : false,
  "privileges" : [ ],
  "acceptedReleaseLicenses" : [ ]
}

$ curl 'http://dapi.lcsb.uni.lu/registrationConfirm?token=bc04773f-d823-4a1d-8efb-00ffde281d42' -i -X GET

GET /registrationConfirm?token=bc04773f-d823-4a1d-8efb-00ffde281d42 HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 184

{
  "id" : 20,
  "name" : null,
  "email" : "piotr.gawron@uni.lu",
  "deleted" : false,
  "login" : "xyz",
  "enabled" : true,
  "privileges" : [ ],
  "acceptedReleaseLicenses" : [ ]
}

$ curl 'http://dapi.lcsb.uni.lu/api/users/user' -i -X GET

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 168

{
  "id" : 29,
  "name" : null,
  "email" : null,
  "deleted" : false,
  "login" : "user",
  "enabled" : true,
  "privileges" : [ ],
  "acceptedReleaseLicenses" : [ ]
}

$ curl 'http://dapi.lcsb.uni.lu/api/users/' -i -X GET

GET /api/users/ HTTP/1.1
Host: dapi.lcsb.uni.lu

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 368

{
  "content" : [ {
    "id" : 17,
    "name" : null,
    "email" : null,
    "deleted" : false,
    "login" : "admin",
    "enabled" : true,
    "privileges" : [ {
      "type" : "IS_ADMIN",
      "objectId" : null
    } ],
    "acceptedReleaseLicenses" : [ ]
  } ],
  "totalPages" : 1,
  "totalElements" : 1,
  "numberOfElements" : 1,
  "size" : 20,
  "number" : 0
}

$ curl 'http://dapi.lcsb.uni.lu/api/users/user:grantPrivilege' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"type":"IS_ADMIN","objectId":null}'

POST /api/users/user:grantPrivilege HTTP/1.1
Content-Type: application/json
Host: dapi.lcsb.uni.lu
Content-Length: 35

{"type":"IS_ADMIN","objectId":null}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 221

{
  "id" : 30,
  "name" : null,
  "email" : null,
  "deleted" : false,
  "login" : "user",
  "enabled" : true,
  "privileges" : [ {
    "type" : "IS_ADMIN",
    "objectId" : null
  } ],
  "acceptedReleaseLicenses" : [ ]
}

$ curl 'http://dapi.lcsb.uni.lu/api/users/user:revokePrivilege' -i -X POST \
    -H 'Content-Type: application/json' \
    -d '{"type":"IS_ADMIN","objectId":null}'

POST /api/users/user:revokePrivilege HTTP/1.1
Content-Type: application/json
Host: dapi.lcsb.uni.lu
Content-Length: 35

{"type":"IS_ADMIN","objectId":null}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 215

{
  "id" : 28,
  "name" : null,
  "email" : null,
  "deleted" : false,
  "login" : "user",
  "enabled" : true,
  "privileges" : [ {
    "type" : "READ",
    "objectId" : 13
  } ],
  "acceptedReleaseLicenses" : [ ]
}