Create SIENA Job (Expert Mode)

  Creates a new SIENA job passing json data in body and returns json data about the location of the results.
  Expert mode allows the specification of many more detailed parameters that are usually set to fitting default values.

• URL

  https://proteins.plus/api/siena_rest

• Method:

  POST

• URL Params

  None

• Data Params

  Required:
  

• 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: "" }

• 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 parameter value types" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Invalid reduction procedure set" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", error: "Bad Request", message: "Invalid mode" }

  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: "Either ligand or a pocket parameter must be set" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Invalid ligand" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Invalid pocket format" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "siteRadius must be a float or integer within range 3-15 with step size 0.1 if ligand set" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "siteRadius must be empty string if ligand parameter is not set" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "fragment_length must be a float or integer and range between 3 and 15 with step size 1" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "flexibility_sensitivity must be a float or integer and range between 0.0 and 1.0 with step size 0.1" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "fragment_distance must be a float or integer and range between 0 and 10 with step size 1" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "minimalSiteIdentity must be a float or integer and range between 0.3 and 1.0 with step size 0.1" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "minimalSiteCoverage must be a float or integer and range between 0.3 and 1.0 with step size 0.1" }

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "maximum_mutations must be a float or integer and range between 0 and 10 with step size 1" }

  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." }



• Sample Data:

• Sample Call (curl):

 Show SIENA Job

  Returns json data about a single SIENA job.

• URL

  https://proteins.plus/api/siena_rest/:id

• Method:

  GET

• URL Params

  Required:

  id=[string]

• Data Params

  None

• Success Response:

  • Code: 200
    Content: { status_code: 200, result_table: "", pdb_files: "", ligands: ["","",...], alignment: "", parameters: "" }

  OR

  • Code: 202
    Content: { status_code: 202, message: "Job exists and is still in 'processing' state", location: "" }

• Error Response:

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Job loading error" }

  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." }
  
  

• Sample Call (curl):

  curl https://proteins.plus/api/siena_rest/ixenp5kLNHohrRbj56fbt4dd

• Output:

  
  result_table - main result, binding site ensemble with different conformations of the same/closely related binding sites found in the PDB (CSV-table, one PDB-entry per row)
  
  pdb_files - alternative conformations of binding site from the PDB (list of PDB-files)
  
  ligands - ligands at the binding site of the alternative conformations (list of SDF-files, positions match the PDB entries in the pdb_files-list)
  
  alignment - shows positions in the different chains of the found PDB-entries that can be aligned (TXT-file)
  
  parameters - the values of parameters used for this request