ZBH - Center for Bioinformatics

 Create HyPPI Job

  Creates a new HyPPI job passing json data in body and returns json data about the location of the results.

• URL

  https://proteins.plus/api/ppi_rest

• Method:

  POST

• URL Params

  None

• Data Params

  Required:
  

  
              ppi=[hash] - Contains the following parameters:
  
              pdbCode=[string] - Select a structure form the Protein Data Bank (PDB) via its PDB code.
  
              chain1=[array] - Set a set of chains with respect to specified pdbCode.
  
              chain2=[array] - Set a set of chains with respect to specified pdbCode.
  
              alignment=[string] - Set "true" or ""
          

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

  OR

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

  OR

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

  OR

  • Code: 400 BAD REQUEST
    Content: { status_code: 400, error: "Bad Request", message: "Select two different chains" }

  OR

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

  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:

  
              {
                  "ppi": {
                  "pdbCode":"1kzk",
                  "chain1":["A"],
                  "chain2":["B"],
                  "alignment":"true"}
              }
      

  Sample Call (curl):

  
              curl -d '{"ppi": {"pdbCode":"1kzk","chain1":["A"],"chain2":["B"],"alignment":"true"}}' -H "Accept: application/json" -H "Content-Type: application/json" -X POST https://proteins.plus/api/ppi_rest
          

 Show HyPPI Job

  Returns json data about a single HyPPI job.

• URL

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

• Method:

  GET

• URL Params

  Required:

  
            id=[string]
          

• Data Params

  None

• Success Response:

  • Code: 200
    Content: { status_code: 200, permanent: "", transient: "", crystal: "", pdb_chains: ""}

  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/ppi_rest/ixenp5kLNHohrRbj56fbt4dd
              

• Output:

  
  permanent - percentage of permanent protein-protein interaction (only stable in complexed state)
  
  transient - percentage of transient protein-protein interaction (stable in complexed as well as in monomeric form)
  
  crystal - percentage of crystal artifacts of protein-protein interaction (no biological function)
  
  pdb_chains - PDB-file including the selected chains only