spacer
EBIEBI Web Servicesservicesssspsiblast_soap

PSI-BLAST (SOAP)

Description

For more information see:

Clients

Sample clients are provided for a number of programming languages. For details of how to use these clients, download the client and run the program without any arguments.

Language Download Requirements
C# .NET Executable: PsiBlastCliClient.exe; Source: AbstractWsClient.cs, PsiBlastClient.cs, PsiBlastCliClient.cs A .NET runtime environment. If building from source development tools are also required. See the .NET tutorial for details.
Perl psiblast_soaplite.pl SOAP::Lite

WSDL

The WSDL for the PSI-BLAST SOAP service: http://www.ebi.ac.uk/Tools/services/soap/psiblast?wsdl

Operations

getParameters()

Get a list of the parameter names.

Arguments: none

Returns: a list of strings giving the names of the parameters.

getParameterDetails(parameterId)

Get details of a specific parameter.

Arguments:

  • parameterId: identifier/name of the parameter to fetch details of.

Returns: a wsParameterDetails describing the parameter and its values.

run(email, title, params)

Submit a job to the service.

Arguments:

  • email: (required) user e-mail address.
  • title: job title. Default: ””.
  • params: (required) parameters for the tool. These are described by the InputParameters data structure.

Returns: a string containing the job identifier (jobId).

getStatus(jobId)

Get the status of a submitted job.

Arguments:

  • jobId: (required) job identifier.

Returns: a string containing the status.

Values for the status are:

  • RUNNING: job is currently running
  • FINISHED: job has finished
  • ERROR: an error occurred attempting to get the job status
  • FAILURE: the job failed.
  • NOT_FOUND: the job with the specified identifier cannot be found

getResultTypes(jobId)

Get the available result types for a finished job.

Arguments:

  • jobId: (required) job identifier.

Returns: a list of wsResultType data structures describing the available result types.

getResult(jobId, type, parameters)

Get the result of a job of the specified type.

Arguments:

  • jobId: (required) job identifier.
  • type: (required) string specifying the result type to fetch. See getResultTypes(jobId) for details of the available types.
  • parameters: optional list of wsRawOutputParameter used to provide additional parameters for derived result types.

Returns: the result data for the specified type, base64 encoded. Depending on the SOAP library and programming language used the result may be returned in decoded form. For some result types (e.g. images) this will be binary data rather than a text string.

Data Types

InputParameters

The input parameters for the job:

Attribute Type Description
matrix string Scoring matrix to be used in the search.
gapopen int Score for the initiation of a gap.
gapext int Score for each base/residue in a gap.
expthr double E-value threshold for search.
psithr double E-value threshold for inclusion in PSSM.
scores int Maximum number of scores displayed in the output.
alignments int Maximum number of alignments displayed in the output.
alignView int Alignment view.
dropoff int Drop-off score for halting extension of the alignment.
finaldropoff int Drop-off score for halting extension of the final gapped alignment.
filter string Low complexity sequence filter.
seqrange string Range defining the region of the query sequence to use in the search.
sequence string Query sequence. The use of fasta formatted sequence is recommended.
database list List of database names for search.
previousjobid string The identifier for the previous PSI-BLAST iteration.
selectedHits base64 The list of identifiers for the hits to use to build the PSSM.
cpfile base64 Checkpoint file in ASN.1 Binary Format.

More detailed information about each parameter, including valid values can be obtained using the getParameterDetails(parameterId) operation.

wsParameterDetails

Descriptive information about a tool parameter. Returned by getParameterDetails(parameterId).

Attribute Type Description
name string Name of the parameter.
description string Description of the parameter, suitable for use in option help interfaces.
type string Data type of the parameter.
values list of wsParameterValue List of valid values for the option.

wsParameterValue

Description of a tool parameter value. Used in wsParameterDetails.

Attribute Type Description
label string Display name of the value, for use in interfaces.
value string String representation of the value to be passed the the tool parameter.
defaultValue boolean Flag indicating if this value is the default.
properties list of wsProperty List of key/value pairs providing further information.

wsProperty

Properties of a tool parameter value. Used in wsParameterValue.

Attribute Type Description
key string
value string

wsRawOutputParameter

Additional parameters passed when requesting a result. See getResult(jobId, type, parameters).

Attribute Type Description
name string
value list of string

wsResultType

Description of a result type. Returned by getResultTypes(jobId).

Attribute Type Description
identifier string Identifier for the result type. Passed as type to getResult(jobId, type, parameters).
label string Display name for use in user interfaces.
description string Description of the result type, for use in help interfaces.
mediaType string MIME type of the returned data.
fileSuffix string Suggested suffix for file name, if writing data to disk.
 
services/sss/psiblast_soap.txt · Last modified: 2010/03/16 11:44 by hpm
spacer
spacer