Create ActivityFinder Job
Creates a new ActivityFinder job passing json data in body and returns json data about the location of the results.
-
URL
https://proteins.plus/api/activityfinder_rest
-
Method:
POST
-
URL Params
None
-
Data Params
Required:
activityfinder=[hash] - Contains the following parameters: pdbCode=[string] - Select a structure form the Protein Data Bank (PDB) via its PDB code.
-
Success Response:
- Code: 200
Content:{ status_code: 200, location: "", message: "Job already exists" }
OR
- Code: 202
Content:{ status_code: 202, message: "The job will be created in the specified location", location: "" }
OR
- Code: 202
Content:{ status_code: 202, message: "Job exists and is still in 'processing' state", location: "" }
- Code: 200
-
Error Response:
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Parameter values must be strings" }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Invalid number of parameters or incorrect parameter name" }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Invalid pdbCode" }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "No ActivityFinder results available." }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Error while calculating activity values. No ActivityFinder result available." }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Job saving error" }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Job loading error" }
OR
- Code: 429 TOO MANY REQUESTS
Content:{ status_code: 429, error: "Too Many Requests", message: "Throttle limit reached. Retry later." }
- Code: 400 BAD REQUEST
-
Sample Data:
{ "activityfinder": { "pdbCode":"1kzk" } }
Sample Call (curl):
curl -d '{"activityfinder": {"pdbCode":"1kzk"}}' -H "Accept: application/json" -H "Content-Type: application/json" -X POST https://proteins.plus/api/activityfinder_rest
Show ActivityFinder Job
Returns json data about a single ActivityFinder job.
-
URL
https://proteins.plus/api/activityfinder_rest/:id
-
Method:
GET
-
URL Params
Required:
id=[string]
-
Data Params
None
-
Success Response:
- Code: 200
Content:{ status_code: 200, result_table: "" }
OR
- Code: 202
Content:{ status_code: 202, message: "Job exists and is still in 'processing' state", location: "" }
- Code: 200
-
Error Response:
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Job loading error" }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "No ActivityFinder results available." }
OR
- Code: 400 BAD REQUEST
Content:{ status_code: 400, error: "Bad Request", message: "Error while calculating activity values. No ActivityFinder result available." }
OR
- Code: 404 NOT FOUND
Content:{ status_code: 404, error: "Not Found", message: "Invalid ID" }
OR
- Code: 429 TOO MANY REQUESTS
Content:{ status_code: 429, error: "Too Many Requests", message: "Throttle limit reached. Retry later." }
- Code: 400 BAD REQUEST
-
Sample Call (curl):
curl https://proteins.plus/api/activityfinder_rest/ixenp5kLNHohrRbj56fbt4dd
-
Output:
result_table - table with CHEMBL-activity values for the requested protein (CSV-table)