blpapi.Operation

class blpapi.Operation(handle, sessions)

Defines an operation which can be performed by a Service.

Operation objects are obtained from a Service object. They provide read-only access to the schema of the Operations Request and the schema of the possible response.

description()

Return type: str
Returns: A human readable description of this Operation.

getResponseDefinitionAt(position)

Parameters: position (int) – Index of the response type
Return type: SchemaElementDefinition
Returns: Object which defines the schema for the response that this Operation delivers.
Raises: Exception – If position >= numResponseDefinitions().

name()

Return type: str
Returns: The name of this Operation.

numResponseDefinitions()

Return type: int
Returns: The number of the response types that can be returned by this Operation.

requestDefinition()

Return type: Optional[SchemaElementDefinition]
Returns: Object which defines the schema for this Operation.

responseDefinitions()

Return type: Iterator[SchemaElementDefinition]
Returns: Iterator over response types that can be returned by this Operation.

Response type is defined by SchemaElementDefinition.