REST API

The items in this list document the REST API calls which can be made against the server, this includes both the Body and the Responses for the various GET, POST, and PUT calls.

The entries are organized such that the API is presented first, separated by objects. The last group of entries are common models which are parts of the API Bodies and Responses (like Metadata), but occur many times in the normal calls.

KV Store

class qcportal.models.rest_models.KVStoreGETBody[source]
class qcportal.models.rest_models.KVStoreGETResponse[source]

Molecule

class qcportal.models.rest_models.MoleculeGETBody[source]
class qcportal.models.rest_models.MoleculeGETResponse[source]
class qcportal.models.rest_models.MoleculePOSTBody[source]
class qcportal.models.rest_models.MoleculePOSTResponse[source]

Keywords

class qcportal.models.rest_models.KeywordGETBody[source]
class qcportal.models.rest_models.KeywordGETResponse[source]
class qcportal.models.rest_models.KeywordPOSTBody[source]
class qcportal.models.rest_models.KeywordPOSTResponse[source]

Collections

class qcportal.models.rest_models.CollectionGETBody[source]
class qcportal.models.rest_models.CollectionGETResponse[source]
class qcportal.models.rest_models.CollectionPOSTBody[source]
class qcportal.models.rest_models.CollectionPOSTResponse[source]

Result

class qcportal.models.rest_models.ResultGETBody[source]
class qcportal.models.rest_models.ResultGETResponse[source]

Procedures

class qcportal.models.rest_models.ProcedureGETBody[source]
class qcportal.models.rest_models.ProcedureGETResponse[source]

Task Queue

class qcportal.models.rest_models.TaskQueueGETBody[source]
class qcportal.models.rest_models.TaskQueueGETResponse[source]
class qcportal.models.rest_models.TaskQueuePOSTBody[source]
class qcportal.models.rest_models.TaskQueuePOSTResponse[source]
class qcportal.models.rest_models.TaskQueuePUTBody[source]
class qcportal.models.rest_models.TaskQueuePUTResponse[source]

Service Queue

class qcportal.models.rest_models.ServiceQueueGETBody[source]
class qcportal.models.rest_models.ServiceQueueGETResponse[source]
class qcportal.models.rest_models.ServiceQueuePOSTBody[source]
class qcportal.models.rest_models.ServiceQueuePOSTResponse[source]
class qcportal.models.rest_models.ServiceQueuePUTBody[source]
class qcportal.models.rest_models.ServiceQueuePUTResponse[source]

Queue Manager

class qcportal.models.rest_models.QueueManagerGETBody[source]
class qcportal.models.rest_models.QueueManagerGETResponse[source]
class qcportal.models.rest_models.QueueManagerPOSTBody[source]
class qcportal.models.rest_models.QueueManagerPOSTResponse[source]
class qcportal.models.rest_models.QueueManagerPUTBody[source]
class qcportal.models.rest_models.QueueManagerPUTResponse[source]

Common REST Components

These are NOT complete Body or Responses to the REST API, but common fragments which make up things like the Metadata or the Data fields.

class qcportal.models.rest_models.EmptyMeta[source]

There is no metadata accepted, so an empty metadata is sent for completion.

class qcportal.models.rest_models.ResponseMeta[source]

Standard Fractal Server response metadata

class qcportal.models.rest_models.ResponseGETMeta[source]

Standard Fractal Server response metadata for GET/fetch type requests.

class qcportal.models.rest_models.ResponsePOSTMeta[source]

Standard Fractal Server response metadata for POST/add type requests.

class qcportal.models.rest_models.QueryMeta[source]

Standard Fractal Server metadata for Database queries containing pagination information

class qcportal.models.rest_models.QueryMetaProjection[source]

Fractal Server metadata for Database queries containing pagination information and query projection parameters

class qcportal.models.rest_models.QueueManagerMeta[source]

Validation and identification Meta information for the Queue Manager’s communication with the Fractal Server.