Foundation API Reference¶

Services Reference¶

BrowseService¶

class BrowseService(mi_session)¶

The Browse service provides read-only operation for a Granta MI Server.

GetDatabases()¶

List the databases available on the Granta MI Server.

Returns: GetDatabasesResponse object

GetTables(_req)¶

List the tables contained in a particular Granta MI Database.

Parameters: _req – GetTables object
Returns: GetTablesResponse object

GetRootNode(_req)¶

Returns information about the root node of a particular Table in a Granta MI Database. This can be passed to GetChildNodes operation to find the contents of the rest of the node-tree of the Table.

Parameters: _req – GetRootNode object
Returns: GetRootNodeResponse object

GetChildNodes(_req)¶

Returns information about the child nodes of the given node in the node-tree of a Granta MI Table.

Parameters: _req – GetChildNodes object
Returns: GetChildNodesResponse object

GetSubsets(_req)¶

List the Subsets for a Granta MI Database or for one Table in a Database.

Parameters: _req – GetSubsetsRequest object
Returns: GetSubsetsResponse object

GetAssociatedRecords(_req)¶

Returns all the Records, in a single target Table, that are associated with each of a given set of source Records, via Tabular Data links. These links can be in the forward or reverse direction. Note that, if there is more than one Tabular Attribute linking the source and target Tables, the Associated Records are the union of all those linked by each of the Tabular Attributes.

Parameters: _req – GetAssociatedRecordsRequest object
Returns: GetAssociatedRecordsResponse object

GetAttributeDetails(_req)¶

Returns detailed meta-information about given Attribute(s) in a Granta MI Database. Does not retrieve values of the Data; for that, use the DataExport service.

Parameters: _req – GetAttributeDetailsRequest object
Returns: GetAttributeDetailsResponse object

GetTreeRecords(_req)¶

Returns name, record type, and some tree information for the given record(s). Does not retrieve the tree children; for that, use the GetChildRecords operation.

Parameters: _req – GetTreeRecordsRequest object
Returns: GetTreeRecordsResponse object

GetRecordAttributes(_req)¶

Returns information about which Attributes have Data, for given Record(s). Includes information about when Data was created and retired, in a Version-Controlled Table. Does not retrieve values of the Data; for that, use the DataExport or EngineeringData services.

Parameters: _req – GetRecordAttributesRequest object
Returns: GetRecordAttributesResponse object

GetUnitSystems(_req)¶

Returns information about the unit systems known to a Granta MI Database

Parameters: _req – GetUnitSystems object
Returns: GetUnitSystemsResponse object

GetRecordVersions(_req)¶

Returns version information about the records specified in the request object.

Parameters: _req – GetRecordVersionsRequest object
Returns: GetRecordVersionsResponse object

GetRecordLinkGroups(_req)¶

Gets details of Record Link Groups in a Granta MI Database.

Parameters: _req – GetRecordLinkGroups object
Returns: GetRecordLinkGroupsResponse object

GetLinkedRecords(_req)¶

Returns the linked records for specified records, for one or more record link groups.

Parameters: _req – GetLinkedRecordsRequest object
Returns: GetLinkedRecordsResponse object

GetAttributeParameters(_req)¶

Gets detailed information about the Parameters that are declared to be usable with given Attribute(s) in a Granta MI Database. Can only be used with Functional Attributes or Multi-Valued Attributes.

Parameters: _req – GetAttributeParametersRequest object
Returns: GetAttributeParametersResponse object

GetParameterDetails(_req)¶

Returns detailed information about the given Parameter(s) in a Granta MI Database.

Parameters: _req – GetParameterDetailsRequest object
Returns: GetParameterDetailsResponse object

GetMetaAttributes(_req)¶

Returns the Meta-Attributes of one or more parent Attributes in a Table of a Granta MI Database.

Parameters: _req – GetMetaAttributesRequest object
Returns: GetMetaAttributesResponse object

GetDatabaseParameters(_req)¶

List the parameter(s) in a Granta MI Database.

Parameters: _req – GetDatabaseParameters object
Returns: GetDatabaseParametersResponse object

GetIntegrationProfiles(_req)¶

List the profiles available on a Granta MI Database.

Parameters: _req – GetIntegrationProfiles object
Returns: GetIntegrationProfilesResponse object

GetLayouts(_req)¶

List the Layouts for an MI Database or for one Table in a Database.

Parameters: _req – GetLayouts object
Returns: GetLayoutsResponse object

ResolveReferences(_req)¶

Checks whether the specified Granta MI entities exist in the database and, if so, whether the current user has read permissions or write permissions for it.

Parameters: _req – ResolveReferencesRequest object
Returns: ResolveReferencesResponse object

GetUnitConversions(_req)¶

Gets all the unit conversions available for a specified unit or unit system.

Parameters: _req – GetUnitConversionsRequest object
Returns: GetUnitConversionsResponse object

SearchService¶

class SearchService(mi_session)¶

The Search service finds Records, within Granta MI Databases, matching specified criteria.

SimpleTextSearch(_req)¶

Searches for records matching simple text criteria.

Parameters: _req – SimpleTextSearch object
Returns: SimpleTextSearchResponse object

CriteriaSearch(_req)¶

Searches for records matching attribute-based criteria.

Parameters: _req – CriteriaSearch object
Returns: SimpleTextSearchResponse object

RecordNameSearch(_req)¶

Searches for Records with a given exact Record name.

Parameters: _req – RecordNameSearchRequest object
Returns: SimpleTextSearchResponse object

DataImportService¶

class DataImportService(mi_session)¶

The DataImport service writes data to attributes of records in Granta MI Databases.

SetRecordAttributes(_req)¶

Sets the data values for the given attribute(s) and record(s) in a Granta MI Database. This method will create any records or folders which do not already exist in the database (however, new folders should be created with ‘EnsureRecordFolderPaths’ instead). Note: This operation can accept an arbitrary number of attributes and records to be imported, but in practice there is a fairly low limit to the amount of data that can be imported in a single operation. Client code should perform large imports in small chunks.

Parameters: _req – SetRecordAttributesRequest object
Returns: SetRecordAttributesResponse object

ModifyRecordLinks(_req)¶

Adds or removes static Links between record(s) in a Granta MI Database.

Parameters: _req – ModifyRecordLinksRequest object
Returns: ModifyRecordLinksResponse object

GetUploadAddresses(_req)¶

Returns an address to which a datum can be uploaded, for each combination of given sets of records and attributes in a Granta MI database. Each address will be an HTTP or HTTPS URL. The upload service only supports a subset of all available Granta MI attribute types, but this operation will give an address for an attribute of any type.

Parameters: _req – GetUploadAddressesRequest object
Returns: GetUploadAddressesResponse object

EnsureRecordFolderPaths(_req)¶

Checks whether given hierarchies of folders exist, creating them if not. Each hierarchy is specified as a sequence of tree names; where the folder needs to be created, this name is also used as the full name of the created folder. New folders will be assigned to their parents’ subsets; existing folders are not assigned or removed from any subsets. If a colour is specified, new folders will be of that colour; existing folders’ colours are never changed. Note: this operation can accept an arbitrary number of Record Folder paths to be ensured, but in practice there is a limit to the amount of changes that can be done in a single operation.

Parameters: _req – EnsureRecordFolderPathsRequest object
Returns: EnsureRecordFolderPathsResponse object

DeleteOrWithdrawIfLatestRecordVersion(_req)¶

Deletes or withdraws the latest version of the specified record(s). In a version-controlled table, the latest version of a record can be seen by Write users in Edit mode of MI Viewer. This operation will revert (or delete) unreleased record versions, withdraw released versions, and skip withdrawn versions. In a non-version-controlled table, records will only have one version. This operation will delete specified records of this type. Note: this operation will only act on the latest record version. In the case where the specified record corresponds to a record version that is an earlier version, the operation will return a fault.

Parameters: _req – DeleteOrWithdrawIfLatestRecordVersionRequest object
Returns: DeleteOrWithdrawIfLatestRecordVersionResponse object

DataExportService¶

class DataExportService(mi_session)¶

The DataExport service retrieves and returns data from attributes of records in Granta MI Databases.

GetRecordAttributesByRef(_req)¶

Retrieves the data values for the given attribute(s) and record(s) in a Granta MI Database.

Parameters: _req – GetRecordAttributesByRefRequest object
Returns: GetRecordAttributesByRefResponse object

EngineeringDataService¶

class EngineeringDataService(mi_session)¶

The EngineeringData service provides custom data export operations for a Granta MI Server.

GetAvailableExporters(_req)¶

Returns the FEA Exporter configurations known to the MI Server, optionally filtering for their applicability to particular situations.

Parameters: _req – GetAvailableExportersRequest object
Returns: GetAvailableExportersResponse object

ExportRecordData(_req)¶

Performs an FEA Export and returns the result as the response.

Parameters: _req – ExportRecordDataRequest object
Returns: ExportRecordDataResponse object

GetExporterParameters(_req)¶

Returns information about the MI Parameter Values that will need to be chosen, to run the specified Exporter on the specified Record(s).

Parameters: _req – GetExporterParametersRequest object
Returns: GetExporterParametersResponse object

ExportersForRecords(_req)¶

Returns the FEA Exporter configurations, known to the MI Server, filtering for their applicability to given Record(s) and optionally to particular situations.

Parameters: _req – ExportersForRecordsRequest object
Returns: ExportersForRecordsResponse object

Objects Reference¶

AssociatedRecords¶

class AssociatedRecords(associatedRecords=None, sourceRecord=None, _isOwner=True)¶

Bases: object

AssociatedRecords. Object containing a source RecordReference object and an array of associated RecordReference objects.

Parameters

associatedRecords – type list of RecordReference objects
sourceRecord – type RecordReference

property associatedRecords¶: Property associatedRecords is a RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property sourceRecord¶: Property sourceRecord is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

AttributeAddress¶

class AttributeAddress(URL=None, attributeID=None, attributeName=None, attributeStandardName=None, _isOwner=True)¶

Bases: object

AttributeAddress. The upload URL of an attribute and an attribute identifier. The attribute is identified by the identity, name, and where available, standard name.

Parameters

URL – type str
attributeID – type int
attributeName – type str
attributeStandardName – type str

property attributeID¶: Property attributeID is of type int.

property attributeName¶: Property attributeName is of type str.

property attributeStandardName¶: Property attributeStandardName is of type str.

property URL¶: Property URL is of type str.

property c_obj¶: Pointer to the underlying C-object

AttributeCategory¶

class AttributeCategory(categoryAttributeDetails=None, name=None, order=None, recordLinkGroupDetails=None, _isOwner=True)¶

Bases: object

AttributeCategory. Gives the details of contents of a category in a layout. Does not include Tabular Data Association Chains.

Parameters

categoryAttributeDetails – type list of CategoryAttributeDetail objects
name – type str
order – type int
recordLinkGroupDetails – type list of RecordLinkGroupDetail objects

property categoryAttributeDetails¶: Property categoryAttributeDetails is a list of CategoryAttributeDetail objects. Warning: Do not attempt to edit or append to the returned value.

property recordLinkGroupDetails¶: Property recordLinkGroupDetails is a list of RecordLinkGroupDetail objects. Warning: Do not attempt to edit or append to the returned value.

property name¶: Property name is of type str.

property order¶: Property order is of type int.

AddCategoryAttributeDetail(_categoryAttributeDetail)¶

Appends _categoryAttributeDetail to categoryAttributeDetails property on AttributeCategory C-object.

Parameters: _categoryAttributeDetail – object of type CategoryAttributeDetail.

AddRecordLinkGroupDetail(_recordLinkGroupDetail)¶

Appends _recordLinkGroupDetail to recordLinkGroupDetails property on AttributeCategory C-object.

Parameters: _recordLinkGroupDetail – object of type RecordLinkGroupDetail.

property c_obj¶: Pointer to the underlying C-object

AttributeDetail¶

class AttributeDetail(identity=None, about=None, name=None, axisName=None, attribute=None, revisionInfo=None, chartable=None, isMeta=None, defaultThreshold=None, discreteValues=None, databaseUnit=None, isSearchable=None, isMultiValued=None, type=None, order=None, tabular=None, isUnique=None, minMax=None, _isOwner=True)¶

Bases: object

AttributeDetail. Detailed meta-information about an attribute in a Granta MI database. Does not include values of the attribute. For requests, the name, and type are required.

Parameters

identity – type int
about – type NamedAttribute
name – type str
axisName – type str
attribute – type AttributeReference
revisionInfo – type RevisionInfo
chartable – type bool
isMeta – type bool
defaultThreshold – type str
discreteValues – type list of str objects
databaseUnit – type str
isSearchable – type bool
isMultiValued – type bool
type – type str
order – type int
tabular – type TabularDetail
isUnique – type bool
minMax – type MinMax

property about¶: Property about is of type NamedAttribute. Only populated if ‘isMeta’ is True.

property attribute¶: Property attribute is of type AttributeReference.

property axisName¶: Property axisName is of type str.

property chartable¶: Property chartable is of type bool.

property databaseUnit¶: Property databaseUnit is of type str.

property defaultThreshold¶: Property defaultThreshold is of type str.

property discreteValues¶: Property discreteValues is a str objects. Warning: Do not attempt to edit or append to the returned value.

property identity¶: Property identity is of type int.

property isMeta¶: Property isMeta is of type bool. If this is True, the ‘about’ property may have additional information about the related parent attribute.

property isMultiValued¶: Property isMultiValued is of type bool.

property isSearchable¶: Property isSearchable is of type bool.

property isUnique¶: Property isUnique is of type bool.

property minMax¶: Property minMax is of type MinMax.

property name¶: Property name is of type str.

property order¶: Property order is of type int.

property revisionInfo¶: Property revisionInfo is of type RevisionInfo.

property tabular¶: Property tabular is of type TabularDetail.

property type¶: Property type is of type str.

property c_obj¶: Pointer to the underlying C-object

AttributeExporterParameters¶

class AttributeExporterParameters(attribute=None, dataPresence=None, parameters=None, graphDomains=None, _isOwner=True)¶

Bases: object

AttributeExporterParameters. A type to contain an attribute along with associated parameters and domains. All Parameters are declared on the MI parameterised Attribute, even if not used in some combination of Exporter and Record. It also contains the possible domains in which the fixed Parameter values must be chosen.

Parameters

attribute – type NamedAttribute
dataPresence – type int
parameters – type list of ExporterParameter objects
graphDomains – type list of GraphDomain objects

class DataPresence¶

Bases: object

Unknown = 0¶

Present = 1¶

NotApplicable = 2¶

Missing = 3¶

DataIncompatibleWithConfiguration = 4¶

property graphDomains¶: Property graphDomains is a list of GraphDomain objects. Each graph domain contains information on the possible values that the corresponding parameter (by list index) can take. Warning: Do not attempt to edit or append to the returned value.

property parameters¶: Property parameters is a list of ExporterParameter objects. This is a list of parameters that parameterize the attribute in question. Warning: Do not attempt to edit or append to the returned value.

property attribute¶: Property attribute is of type NamedAttribute.

property dataPresence¶: Property dataPresence is of type int. See AttributeExporterParameters.DataPresence for supported values.

AddGraphDomain(_graphDomain)¶

Appends _graphDomain to graphDomains property on AttributeExporterParameters C-object.

Parameters: _graphDomain – object of type GraphDomain.

AddParameter(_exporterParameter)¶

Appends _exporterParameter to parameters property on AttributeExporterParameters C-object.

Parameters: _exporterParameter – object of type ExporterParameter.

property c_obj¶: Pointer to the underlying C-object

AttributeMetaAttributes¶

class AttributeMetaAttributes(metaAttributes=None, parentAttribute=None, _isOwner=True)¶

Bases: object

AttributeMetaAttributes. Lists the Meta-Attributes of a particular Attribute in a Granta MI Database Table.

Parameters

metaAttributes – type list of NamedAttribute objects
parentAttribute – type AttributeReference

property metaAttributes¶: Property metaAttributes is a NamedAttribute objects. Warning: Do not attempt to edit or append to the returned value.

property parentAttribute¶: Property parentAttribute is of type AttributeReference.

property c_obj¶: Pointer to the underlying C-object

AttributeReference¶

class AttributeReference(pseudoAttribute=None, isStandardName=None, name=None, partialTableReference=None, DBKey=None, attributeID=None, _isOwner=True)¶

Bases: object

AttributeReference. Identification of a particular attribute in a Granta MI database. For requests, a DBKey is required and either the attribute ID or the attribute name. If the name is not a standard name, then a PartialTableReference is also required.

Parameters

pseudoAttribute – type int
isStandardName – type bool
name – type str
partialTableReference – type PartialTableReference
DBKey – type str
attributeID – type int

class MIPseudoAttributeReference¶

Bases: object

name = 0¶

shortName = 1¶

subsets = 2¶

releasedDate = 3¶

modifiedDate = 4¶

recordType = 5¶

recordHistoryIdentity = 6¶

recordColor = 7¶

recordVersionNumber = 12¶

tableName = 13¶

writable = 16¶

parentName = 17¶

parentShortName = 18¶

parentRecordHistoryIdentity = 19¶

createdDate = 21¶

creator = 22¶

lastModifier = 23¶

property attributeID¶: Property attributeID is of type int.

property DBKey¶: Property DBKey is of type str.

property isStandardName¶: Property isStandardName is of type bool.

property name¶: Property name is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference.

property pseudoAttribute¶: Property pseudoAttribute is of type int. See AttributeReference.MIPseudoAttributeReference for supported values.

property c_obj¶: Pointer to the underlying C-object

AttributeValue¶

class AttributeValue(tabularDataType=None, discreteDataValue=None, rangeDataType=None, hyperlinkDataValue=None, attributeStandardName=None, dataType=None, shortTextDataType=None, longTextDataType=None, attributeName=None, floatFunctionalGriddedDataType=None, logicalDataValue=None, integerDataValue=None, floatFunctionalSeriesDataType=None, attributeID=None, fileDataType=None, dateDataType=None, pointDataType=None, pictureDataType=None, subsetsDataType=None, _isOwner=True)¶

Bases: object

AttributeValue. Type representing the value of a piece of data for a particular attribute. Access supported data types, and the attribute identity by Name, ID, or Standard Name.

Parameters

tabularDataType – type TabularDataType
discreteDataValue – type DiscreteDataType
rangeDataType – type RangeDataType
hyperlinkDataValue – type HyperlinkDataType
attributeStandardName – type str
dataType – type str
shortTextDataType – type ShortTextDataType
longTextDataType – type LongTextDataType
attributeName – type str
floatFunctionalGriddedDataType – type FloatFunctionalGriddedDataType
logicalDataValue – type LogicalDataType
integerDataValue – type IntegerDataType
floatFunctionalSeriesDataType – type FloatFunctionalSeriesDataType
attributeID – type int
fileDataType – type FileDataType
dateDataType – type DateDataType
pointDataType – type PointDataType
pictureDataType – type PictureDataType
subsetsDataType – type SubsetsDataType

property attributeID¶: Property attributeID is of type int.

property attributeName¶: Property attributeName is of type str.

property attributeStandardName¶: Property attributeStandardName is of type str.

property dataType¶: Property dataType is of type str.

property dateDataType¶: Property dateDataType is of type DateDataType.

property discreteDataValue¶: Property discreteDataValue is of type DiscreteDataType.

property fileDataType¶: Property fileDataType is of type FileDataType.

property floatFunctionalGriddedDataType¶: Property floatFunctionalGriddedDataType is of type FloatFunctionalGriddedDataType.

property floatFunctionalSeriesDataType¶: Property floatFunctionalSeriesDataType is of type FloatFunctionalSeriesDataType.

property hyperlinkDataValue¶: Property hyperlinkDataValue is of type HyperlinkDataType.

property integerDataValue¶: Property integerDataValue is of type IntegerDataType.

property logicalDataValue¶: Property logicalDataValue is of type LogicalDataType.

property longTextDataType¶: Property longTextDataType is of type LongTextDataType.

property pictureDataType¶: Property pictureDataType is of type PictureDataType.

property pointDataType¶: Property pointDataType is of type PointDataType.

property rangeDataType¶: Property rangeDataType is of type RangeDataType.

property shortTextDataType¶: Property shortTextDataType is of type ShortTextDataType.

property subsetsDataType¶: Property subsetsDataType is of type SubsetsDataType.

property tabularDataType¶: Property tabularDataType is of type TabularDataType.

property c_obj¶: Pointer to the underlying C-object

BetweenDateTimesSearchValue¶

class BetweenDateTimesSearchValue(lowEnd=None, highEnd=None, tabularColumn=None, _isOwner=True)¶

Bases: object

BetweenDateTimesSearchValue. Search criterion to search for data between two times. This criterion type is specific to DateTime Attributes. Both a LowEnd and a HighEnd value are required. The date format is in XSD’s dateTime data type (YYYY-MM-DDThh:mm:ss).

Parameters

lowEnd – type str
highEnd – type str
tabularColumn – type str

property highEnd¶: Property highEnd is of type str.

property lowEnd¶: Property lowEnd is of type str.

property tabularColumn¶: Property tabularColumn is of type str.

property c_obj¶: Pointer to the underlying C-object

BetweenSearchValue¶

class BetweenSearchValue(lowEnd=None, highEnd=None, tabularColumn=None, _isOwner=True)¶

Bases: object

BetweenSearchValue. Search criterion to search for data between two values. Only Point, Range, and Integer attributes are supported by this search criteria. Both a LowEnd and a HighEnd value are required.

Parameters

lowEnd – type LowEndSearchValue
highEnd – type HighEndSearchValue
tabularColumn – type str

property highEnd¶: Property highEnd is of type HighEndSearchValue.

property lowEnd¶: Property lowEnd is of type LowEndSearchValue.

property tabularColumn¶: Property tabularColumn is of type str.

property c_obj¶: Pointer to the underlying C-object

BinaryDataSettings¶

class BinaryDataSettings(binaryDataRepresentation=None, maxImageSize=None, _isOwner=True)¶

Bases: object

BinaryDataSettings. Settings for exporting file and picture data.

Parameters

binaryDataRepresentation – type int
maxImageSize – type RasterSize

property binaryDataRepresentation¶: Property binaryDataRepresentation is of type int. See GRANTA_Constants.BinaryDataRepresentation for supported values.

property maxImageSize¶: Property maxImageSize is of type RasterSize.

property c_obj¶: Pointer to the underlying C-object

BrowseService¶

class BrowseService(mi_session)¶

Bases: GRANTA_MIScriptingToolkit.Service.Service

The Browse service provides read-only operation for a Granta MI Server.

GetDatabases()¶

List the databases available on the Granta MI Server.

Returns: GetDatabasesResponse object

GetTables(_req)¶

List the tables contained in a particular Granta MI Database.

Parameters: _req – GetTables object
Returns: GetTablesResponse object

GetRootNode(_req)¶

Returns information about the root node of a particular Table in a Granta MI Database. This can be passed to GetChildNodes operation to find the contents of the rest of the node-tree of the Table.

Parameters: _req – GetRootNode object
Returns: GetRootNodeResponse object

GetChildNodes(_req)¶

Returns information about the child nodes of the given node in the node-tree of a Granta MI Table.

Parameters: _req – GetChildNodes object
Returns: GetChildNodesResponse object

GetSubsets(_req)¶

List the Subsets for a Granta MI Database or for one Table in a Database.

Parameters: _req – GetSubsetsRequest object
Returns: GetSubsetsResponse object

GetAssociatedRecords(_req)¶

Returns all the Records, in a single target Table, that are associated with each of a given set of source Records, via Tabular Data links. These links can be in the forward or reverse direction. Note that, if there is more than one Tabular Attribute linking the source and target Tables, the Associated Records are the union of all those linked by each of the Tabular Attributes.

Parameters: _req – GetAssociatedRecordsRequest object
Returns: GetAssociatedRecordsResponse object

GetAttributeDetails(_req)¶

Returns detailed meta-information about given Attribute(s) in a Granta MI Database. Does not retrieve values of the Data; for that, use the DataExport service.

Parameters: _req – GetAttributeDetailsRequest object
Returns: GetAttributeDetailsResponse object

GetTreeRecords(_req)¶

Returns name, record type, and some tree information for the given record(s). Does not retrieve the tree children; for that, use the GetChildRecords operation.

Parameters: _req – GetTreeRecordsRequest object
Returns: GetTreeRecordsResponse object

GetRecordAttributes(_req)¶

Returns information about which Attributes have Data, for given Record(s). Includes information about when Data was created and retired, in a Version-Controlled Table. Does not retrieve values of the Data; for that, use the DataExport or EngineeringData services.

Parameters: _req – GetRecordAttributesRequest object
Returns: GetRecordAttributesResponse object

GetUnitSystems(_req)¶

Returns information about the unit systems known to a Granta MI Database

Parameters: _req – GetUnitSystems object
Returns: GetUnitSystemsResponse object

GetRecordVersions(_req)¶

Returns version information about the records specified in the request object.

Parameters: _req – GetRecordVersionsRequest object
Returns: GetRecordVersionsResponse object

GetRecordLinkGroups(_req)¶

Gets details of Record Link Groups in a Granta MI Database.

Parameters: _req – GetRecordLinkGroups object
Returns: GetRecordLinkGroupsResponse object

GetLinkedRecords(_req)¶

Returns the linked records for specified records, for one or more record link groups.

Parameters: _req – GetLinkedRecordsRequest object
Returns: GetLinkedRecordsResponse object

GetAttributeParameters(_req)¶

Gets detailed information about the Parameters that are declared to be usable with given Attribute(s) in a Granta MI Database. Can only be used with Functional Attributes or Multi-Valued Attributes.

Parameters: _req – GetAttributeParametersRequest object
Returns: GetAttributeParametersResponse object

GetParameterDetails(_req)¶

Returns detailed information about the given Parameter(s) in a Granta MI Database.

Parameters: _req – GetParameterDetailsRequest object
Returns: GetParameterDetailsResponse object

GetMetaAttributes(_req)¶

Returns the Meta-Attributes of one or more parent Attributes in a Table of a Granta MI Database.

Parameters: _req – GetMetaAttributesRequest object
Returns: GetMetaAttributesResponse object

GetDatabaseParameters(_req)¶

List the parameter(s) in a Granta MI Database.

Parameters: _req – GetDatabaseParameters object
Returns: GetDatabaseParametersResponse object

GetIntegrationProfiles(_req)¶

List the profiles available on a Granta MI Database.

Parameters: _req – GetIntegrationProfiles object
Returns: GetIntegrationProfilesResponse object

GetLayouts(_req)¶

List the Layouts for an MI Database or for one Table in a Database.

Parameters: _req – GetLayouts object
Returns: GetLayoutsResponse object

ResolveReferences(_req)¶

Checks whether the specified Granta MI entities exist in the database and, if so, whether the current user has read permissions or write permissions for it.

Parameters: _req – ResolveReferencesRequest object
Returns: ResolveReferencesResponse object

GetUnitConversions(_req)¶

Gets all the unit conversions available for a specified unit or unit system.

Parameters: _req – GetUnitConversionsRequest object
Returns: GetUnitConversionsResponse object

CategoryAttributeDetail¶

class CategoryAttributeDetail(attribute=None, axisName=None, chartable=None, databaseUnit=None, defaultThreshold=None, discreteValues=None, helpInfo=None, identity=None, isMeta=None, isMultiValued=None, isReadOnly=None, isRequired=None, isSearchable=None, name=None, order=None, revisionInfo=None, type=None, about=None, _isOwner=True)¶

Bases: object

CategoryAttributeDetail. Gives the attribute details with a client read only and is required flag.

Parameters

attribute – type AttributeReference
axisName – type str
chartable – type bool
databaseUnit – type str
defaultThreshold – type str
discreteValues – type list of str objects
helpInfo – type HelpInfo
identity – type int
isMeta – type bool
isMultiValued – type bool
isReadOnly – type bool
isRequired – type bool
isSearchable – type bool
name – type str
order – type int
revisionInfo – type RevisionInfo
type – type str
about – type NamedAttribute

property about¶: Property about is of type NamedAttribute.

property attribute¶: Property attribute is of type AttributeReference.

property axisName¶: Property axisName is of type str.

property chartable¶: Property chartable is of type bool.

property databaseUnit¶: Property databaseUnit is of type str.

property defaultThreshold¶: Property defaultThreshold is of type str.

property discreteValues¶: Property discreteValues is a str objects. Warning: Do not attempt to edit or append to the returned value.

property helpInfo¶: Property helpInfo is of type HelpInfo.

property identity¶: Property identity is of type int.

property isMeta¶: Property isMeta is of type bool.

property isMultiValued¶: Property isMultiValued is of type bool.

property isReadOnly¶: Property isReadOnly is of type bool.

property isRequired¶: Property isRequired is of type bool.

property isSearchable¶: Property isSearchable is of type bool.

property name¶: Property name is of type str.

property order¶: Property order is of type int.

property revisionInfo¶: Property revisionInfo is of type RevisionInfo.

property type¶: Property type is of type str.

property c_obj¶: Pointer to the underlying C-object

Constraint¶

class Constraint(parameterValue=None, parameter=None, label=None, _isOwner=True)¶

Bases: object

Constraint. A constraint on functional data. For requests, both parameter and parameter value are required.

Parameters

parameterValue – type ParameterValue
parameter – type ParameterReference
label – type str

property label¶: Property label is of type str.

property parameter¶: Property parameter is of type ParameterReference.

property parameterValue¶: Property parameterValue is of type ParameterValue.

property c_obj¶: Pointer to the underlying C-object

Constraints¶

class Constraints(constraints=None, _isOwner=True)¶

Bases: object

Constraints. A container of constraints.

Parameters: constraints – type list of Constraint objects

property constraints¶: Property constraints is a list of Constraint objects. Warning: Do not attempt to edit or append to the returned value.

AddConstraint(_constraint)¶

Appends _constraint to constraints property on Constraints C-object.

Parameters: _constraint – object of type Constraint.

property c_obj¶: Pointer to the underlying C-object

ContainsAllSearchValue¶

class ContainsAllSearchValue(values=None, tabularColumn=None, _isOwner=True)¶

Bases: object

ContainsAllSearchValue. Search criterion to search for discrete data types that contain all of the specified search values. If the discrete values of the data include further values, it still passes. This criterion type is specific to discrete attributes.

Parameters

values – type list of str objects
tabularColumn – type str

property values¶: Property values is of type list of str.

property tabularColumn¶: Property tabularColumn is of type str.

AddValue(value)¶

Appends value to values property on ContainsAllSearchValue C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

ContainsAnySearchValue¶

class ContainsAnySearchValue(values=None, tabularColumn=None, _isOwner=True)¶

Bases: object

ContainsAnySearchValue. Search criterion to search for discrete data types that contain any of the specified search values. This criterion type is specific to discrete attributes.

Parameters

values – type list of str objects
tabularColumn – type str

property values¶: Property values is of type list of str.

property tabularColumn¶: Property tabularColumn is of type str.

AddValue(value)¶

Appends value to values property on ContainsAnySearchValue C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

ContainsSearchValue¶

class ContainsSearchValue(value=None, tabularColumn=None, _isOwner=True)¶

Bases: object

ContainsSearchValue. Search criterion to search for data that contains the specified search text value. Search criterion applies to text, logical, and discrete attributes. For logicals, specify ‘true’ or ‘false’ as the text.

Parameters

value – type str
tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

CriteriaSearch¶

class CriteriaSearch(recordFilter=None, searchFilter=None, DBKey=None, searchMode=None, populateGUIDs=None, searchCriteria=None, parameterValues=None, significantFigures=None, _isOwner=True)¶

Bases: object

CriteriaSearch. The input for the CriteriaSearch operation. Both the DBKey and recordSearchCriterion are required. If no subsets are specified, only the default subset will be searched.

Parameters

recordFilter – type RecordFilter
searchFilter – type int
DBKey – type str
searchMode – type int
populateGUIDs – type bool
searchCriteria – type list of RecordSearchCriterion objects
parameterValues – type list of UnittedParameterValue objects
significantFigures – type int

property parameterValues¶: Property parameterValues is a list of UnittedParameterValue objects. Warning: Do not attempt to edit or append to the returned value.

property searchCriteria¶: Property searchCriteria is a list of RecordSearchCriterion objects. Warning: Do not attempt to edit or append to the returned value.

property DBKey¶: Property DBKey is of type str.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordFilter¶: Property recordFilter is of type RecordFilter.

property searchFilter¶: Property searchFilter is of type int. See GRANTA_Constants.TablesFilter for supported values.

property searchMode¶: Property searchMode is of type int. See GRANTA_Constants.SearchMode for supported values.

property significantFigures¶: Property significantFigures is of type int.

AddParameterValue(_unittedParameterValue)¶

Appends _unittedParameterValue to parameterValues property on CriteriaSearch C-object.

Parameters: _unittedParameterValue – object of type UnittedParameterValue.

AddSearchCriteria(_recordSearchCriterion)¶

Appends _recordSearchCriterion to searchCriteria property on CriteriaSearch C-object.

Parameters: _recordSearchCriterion – object of type RecordSearchCriterion.

property c_obj¶: Pointer to the underlying C-object

DataExportService¶

class DataExportService(mi_session)¶

Bases: GRANTA_MIScriptingToolkit.Service.Service

The DataExport service retrieves and returns data from attributes of records in Granta MI Databases.

GetRecordAttributesByRef(_req)¶

Retrieves the data values for the given attribute(s) and record(s) in a Granta MI Database.

Parameters: _req – GetRecordAttributesByRefRequest object
Returns: GetRecordAttributesByRefResponse object

DataImportService¶

class DataImportService(mi_session)¶

Bases: GRANTA_MIScriptingToolkit.Service.Service

The DataImport service writes data to attributes of records in Granta MI Databases.

SetRecordAttributes(_req)¶

Sets the data values for the given attribute(s) and record(s) in a Granta MI Database. This method will create any records or folders which do not already exist in the database (however, new folders should be created with ‘EnsureRecordFolderPaths’ instead). Note: This operation can accept an arbitrary number of attributes and records to be imported, but in practice there is a fairly low limit to the amount of data that can be imported in a single operation. Client code should perform large imports in small chunks.

Parameters: _req – SetRecordAttributesRequest object
Returns: SetRecordAttributesResponse object

ModifyRecordLinks(_req)¶

Adds or removes static Links between record(s) in a Granta MI Database.

Parameters: _req – ModifyRecordLinksRequest object
Returns: ModifyRecordLinksResponse object

GetUploadAddresses(_req)¶

Returns an address to which a datum can be uploaded, for each combination of given sets of records and attributes in a Granta MI database. Each address will be an HTTP or HTTPS URL. The upload service only supports a subset of all available Granta MI attribute types, but this operation will give an address for an attribute of any type.

Parameters: _req – GetUploadAddressesRequest object
Returns: GetUploadAddressesResponse object

EnsureRecordFolderPaths(_req)¶

Checks whether given hierarchies of folders exist, creating them if not. Each hierarchy is specified as a sequence of tree names; where the folder needs to be created, this name is also used as the full name of the created folder. New folders will be assigned to their parents’ subsets; existing folders are not assigned or removed from any subsets. If a colour is specified, new folders will be of that colour; existing folders’ colours are never changed. Note: this operation can accept an arbitrary number of Record Folder paths to be ensured, but in practice there is a limit to the amount of changes that can be done in a single operation.

Parameters: _req – EnsureRecordFolderPathsRequest object
Returns: EnsureRecordFolderPathsResponse object

DeleteOrWithdrawIfLatestRecordVersion(_req)¶

Deletes or withdraws the latest version of the specified record(s). In a version-controlled table, the latest version of a record can be seen by Write users in Edit mode of MI Viewer. This operation will revert (or delete) unreleased record versions, withdraw released versions, and skip withdrawn versions. In a non-version-controlled table, records will only have one version. This operation will delete specified records of this type. Note: this operation will only act on the latest record version. In the case where the specified record corresponds to a record version that is an earlier version, the operation will return a fault.

Parameters: _req – DeleteOrWithdrawIfLatestRecordVersionRequest object
Returns: DeleteOrWithdrawIfLatestRecordVersionResponse object

DatabaseDetail¶

class DatabaseDetail(DBKey=None, author=None, company=None, volumeName=None, _isOwner=True)¶

Bases: object

DatabaseDetail. Detailed meta-information about a Granta MI database.

Parameters

DBKey – type str
author – type str
company – type str
volumeName – type str

property author¶: Property author is of type str.

property company¶: Property company is of type str.

property DBKey¶: Property DBKey is of type str.

property volumeName¶: Property volumeName is of type str.

property c_obj¶: Pointer to the underlying C-object

DateDataType¶

class DateDataType(value=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

DateDataType. Container of date data. The format is YYYY-MM-DD.

Parameters

value – type str
isApplicable – type bool

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

DeleteOrWithdrawIfLatestRecordVersionRequest¶

class DeleteOrWithdrawIfLatestRecordVersionRequest(deleteOrWithdrawRecords=None, _isOwner=True)¶

Bases: object

DeleteOrWithdrawIfLatestRecordVersionRequest. DeleteOrWithdrawIfLatestRecordVersionRequest. Input for the DeleteOrWithdrawIfLatestRecordVersion operation, containing the DeleteOrWithdrawRecord objects.

Parameters: deleteOrWithdrawRecords – type list of DeleteOrWithdrawRecord objects

property deleteOrWithdrawRecords¶: Property deleteOrWithdrawRecords is a list of DeleteOrWithdrawRecord objects. Warning: Do not attempt to edit or append to the returned value.

AddDeleteOrWithdrawRecord(_deleteOrWithdrawRecord)¶

Appends _deleteOrWithdrawRecord to deleteOrWithdrawRecords property on DeleteOrWithdrawIfLatestRecordVersionRequest C-object.

Parameters: _deleteOrWithdrawRecord – object of type DeleteOrWithdrawRecord.

property c_obj¶: Pointer to the underlying C-object

DeleteOrWithdrawIfLatestRecordVersionResponse¶

class DeleteOrWithdrawIfLatestRecordVersionResponse(c_obj)¶

Bases: object

DeleteOrWithdrawIfLatestRecordVersionResponse. DeleteOrWithdrawIfLatestRecordVersionResponse. Output of the DeleteOrWithdrawIfLatestRecordVersion operation.

Parameters: c_obj – ctypes.POINTER to a DeleteOrWithdrawIfLatestRecordVersionResponse object.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

DeleteOrWithdrawRecord¶

class DeleteOrWithdrawRecord(recordReference=None, _isOwner=True)¶

Bases: object

DeleteOrWithdrawRecord. Record to be deleted or withdrawn. Contains a RecordReference.

Parameters: recordReference – type RecordReference

property recordReference¶: Property recordReference is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

DiscreteDataType¶

class DiscreteDataType(discreteValues=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

DiscreteDataType. Container of discrete data.

Parameters

discreteValues – type list of DiscreteValue objects
isApplicable – type bool

property discreteValues¶: Property discreteValues is a list of DiscreteValue objects. Warning: Do not attempt to edit or append to the returned value.

property isApplicable¶: Property isApplicable is of type bool.

AddDiscreteValue(_discreteValue)¶

Appends _discreteValue to discreteValues property on DiscreteDataType C-object.

Parameters: _discreteValue – object of type DiscreteValue.

property c_obj¶: Pointer to the underlying C-object

DiscreteValue¶

class DiscreteValue(order=None, value=None, _isOwner=True)¶

Bases: object

DiscreteValue. The value of a discrete data type. Contains an order and a value.

Parameters

order – type int
value – type str

property order¶: Property order is of type int.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

DoesNotContainSearchValue¶

class DoesNotContainSearchValue(value=None, tabularColumn=None, _isOwner=True)¶

Bases: object

DoesNotContainSearchValue. Search criterion to search for discrete data types that contain none of the specified search values. This criterion type is specific to discrete attributes.

Parameters

value – type str
tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

DoesNotExistSearchValue¶

class DoesNotExistSearchValue(tabularColumn=None, _isOwner=True)¶

Bases: object

DoesNotExistSearchValue. Search criterion to search for attributes with no data. All attribute types supported.

Parameters: tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property c_obj¶: Pointer to the underlying C-object

EngineeringDataService¶

class EngineeringDataService(mi_session)¶

Bases: GRANTA_MIScriptingToolkit.Service.Service

The EngineeringData service provides custom data export operations for a Granta MI Server.

GetAvailableExporters(_req)¶

Returns the FEA Exporter configurations known to the MI Server, optionally filtering for their applicability to particular situations.

Parameters: _req – GetAvailableExportersRequest object
Returns: GetAvailableExportersResponse object

ExportRecordData(_req)¶

Performs an FEA Export and returns the result as the response.

Parameters: _req – ExportRecordDataRequest object
Returns: ExportRecordDataResponse object

GetExporterParameters(_req)¶

Returns information about the MI Parameter Values that will need to be chosen, to run the specified Exporter on the specified Record(s).

Parameters: _req – GetExporterParametersRequest object
Returns: GetExporterParametersResponse object

ExportersForRecords(_req)¶

Returns the FEA Exporter configurations, known to the MI Server, filtering for their applicability to given Record(s) and optionally to particular situations.

Parameters: _req – ExportersForRecordsRequest object
Returns: ExportersForRecordsResponse object

EnsureRecordFolderPathsRequest¶

class EnsureRecordFolderPathsRequest(folderPaths=None, importErrorMode=None, _isOwner=True)¶

Bases: object

EnsureRecordFolderPathsRequest. Input for the EnsureRecordFolderPaths operation, containing the folder paths to check and the import error mode.

Parameters

folderPaths – type list of RecordFolderPath objects
importErrorMode – type str

property folderPaths¶: Property folderPaths is a list of RecordFolderPath objects. Warning: Do not attempt to edit or append to the returned value.

property importErrorMode¶: Property importErrorMode is of type str.

AddFolderPath(_recordFolderPath)¶

Appends _recordFolderPath to folderPaths property on EnsureRecordFolderPathsRequest C-object.

Parameters: _recordFolderPath – object of type RecordFolderPath.

property c_obj¶: Pointer to the underlying C-object

EnsureRecordFolderPathsResponse¶

class EnsureRecordFolderPathsResponse(c_obj)¶

Bases: object

EnsureRecordFolderPathsResponse. Output of the EnsureRecordFolderPaths operation.

Parameters: c_obj – ctypes.POINTER to a EnsureRecordFolderPathsResponse object.

property pathLeaves¶: Property pathLeaves is a list of PathLeaf objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

ExactlySearchValue¶

class ExactlySearchValue(value=None, tabularColumn=None, _isOwner=True)¶

Bases: object

ExactlySearchValue. Search criterion to search for integer values which exactly match the specifed search value. Applies to integer attributes only.

Parameters

value – type int
tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property value¶: Property value is of type int.

property c_obj¶: Pointer to the underlying C-object

ExistsSearchValue¶

class ExistsSearchValue(tabularColumn=None, _isOwner=True)¶

Bases: object

ExistsSearchValue. Search criterion to search for attributes which contain data. All attribute types supported.

Parameters: tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property c_obj¶: Pointer to the underlying C-object

ExportRecordDataRequest¶

class ExportRecordDataRequest(sigFigs=None, exporterKey=None, stopBeforeId=None, parameterValues=None, stopBeforeIndex=None, attributeReferences=None, filter=None, records=None, unitConversionContext=None, _isOwner=True)¶

Bases: object

ExportRecordDataRequest. Input for the ExportRecordData operation. For this request to be valid, you must set the references and the exporter key. StopBeforeIndex is 0-indexed

Parameters

sigFigs – type int
exporterKey – type str
stopBeforeId – type str
parameterValues – type list of UnittedParameterValue objects
stopBeforeIndex – type int
attributeReferences – type list of AttributeReference objects
filter – type RecordFilter
records – type list of RecordReference objects
unitConversionContext – type UnitConversionContext

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. If this property is not specified, the attributes from the exporter configuration are used. If this element is included and non-empty, the attributes specified are used. Warning: Do not attempt to edit or append to the returned value.

property parameterValues¶: Property parameterValues is a list of UnittedParameterValue objects. Parameter values to use for any parameterised Data in the export. Each Parameter can only have one value for all parameterised Attributes in an export. Note that the true Parameter names (or Standard Names) in the MI Database must be used; aliases defined in the exporter configuration will not be understood. Warning: Do not attempt to edit or append to the returned value.

property records¶: Property records is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property exporterKey¶: Property exporterKey is of type str.

property filter¶: Property filter is of type RecordFilter. If specified, this filters the records that can be included when traversing record links within Tabular Data. This filter is NOT applied to the explicit list of records passed to this operation.

property sigFigs¶: Property sigFigs is of type int.

property stopBeforeId¶: Property stopBeforeId is of type str. Stops the export process before the step specified by the identifier (for example, after the initial XML is generated but before conversion into the specified CAE format). Contact your MI Administrator if you require this feature.

property stopBeforeIndex¶: Property stopBeforeIndex is of type int. Stops the export process before the step specified by the index (for example, after the initial XML is generated but before conversion into the specified CAE format). Contact your MI Administrator if you require this feature.

property unitConversionContext¶: Property unitConversionContext is of type UnitConversionContext.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on ExportRecordDataRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

AddParameterValues(_unittedParameterValue)¶

Appends _unittedParameterValue to parameterValues property on ExportRecordDataRequest C-object.

Parameters: _unittedParameterValue – object of type UnittedParameterValue.

AddRecord(_recordReference)¶

Appends _recordReference to records property on ExportRecordDataRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

ExportRecordDataResponse¶

class ExportRecordDataResponse(c_obj)¶

Bases: object

ExportRecordDataResponse. Output for the ExportRecordData operation.

Parameters: c_obj – ctypes.POINTER to a ExportRecordDataResponse object.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property text¶: Property text is of type str.

property c_obj¶: Pointer to the underlying C-object

ExportedAttribute¶

class ExportedAttribute(DBKey=None, attributeID=None, isStandardName=None, name=None, partialTableReference=None, preferredXAxisParameter=None, pseudoAttribute=None, specificUnitConversionContext=None, _isOwner=True)¶

Bases: object

ExportedAttribute. A type that allows identification of a particular attribute in a Granta MI, and also specifies how that Attribute should be exported.

Parameters

DBKey – type str
attributeID – type int
isStandardName – type bool
name – type str
partialTableReference – type PartialTableReference
preferredXAxisParameter – type ParameterReference
pseudoAttribute – type int
specificUnitConversionContext – type SpecificUnitConversionContext

property attributeID¶: Property attributeID is of type int.

property DBKey¶: Property DBKey is of type str.

property isStandardName¶: Property isStandardName is of type bool.

property name¶: Property name is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference.

property preferredXAxisParameter¶: Property preferredXAxisParameter is of type ParameterReference.

property specificUnitConversionContext¶: Property specificUnitConversionContext is of type SpecificUnitConversionContext.

property pseudoAttribute¶: Property pseudoAttribute is of type int.

property c_obj¶: Pointer to the underlying C-object

Exporter¶

class Exporter(name=None, package=None, validatedOk=None, version=None, transforms=None, key=None, model=None, description=None, absoluteUnitsOptional=None, unitSystems=None, useAbsoluteUnits=None, outputFile=None, _isOwner=True)¶

Bases: object

Exporter. Details of a particular FEA Exporter configuration, typically obtained from an Exporter Configuration File (EXP file) on the MI Server.

Parameters

name – type str
package – type str
validatedOk – type bool
version – type int
transforms – type list of ExporterTransform objects
key – type str
model – type str
description – type str
absoluteUnitsOptional – type bool
unitSystems – type list of str objects
useAbsoluteUnits – type bool
outputFile – type ExporterOutputFile

property absoluteUnitsOptional¶: Property absoluteUnitsOptional is of type bool.

property description¶: Property description is of type str.

property key¶: Property key is of type str. The key that uniquely identifies this Exporter. This value is generated by the MI Server at runtime and may change between runs.

property model¶: Property model is of type str.

property name¶: Property name is of type str.

property transforms¶: Property transforms is a list of ExporterTransform objects. Warning: Do not attempt to edit or append to the returned value.

property unitSystems¶: Property unitSystems is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property outputFile¶: Property outputFile is of type ExporterOutputFile.

property package¶: Property package is of type str.

property useAbsoluteUnits¶: Property useAbsoluteUnits is of type bool.

property validatedOk¶: Property validatedOk is of type bool.

property version¶: Property version is of type int.

property c_obj¶: Pointer to the underlying C-object

ExporterParameter¶

class ExporterParameter(usage=None, parameterReference=None, Id=None, unit=None, name=None, _isOwner=True)¶

Bases: object

ExporterParameter. Information about a Parameter of Functional Data.

Parameters

usage – type int
parameterReference – type ParameterReference
Id – type str
unit – type UnitInformation
name – type str

class Usage¶

Bases: object

Unknown = 0¶

free = 1¶

fixed = 2¶

unused = 3¶

property Id¶: Property Id is of type str.

property name¶: Property name is of type str.

property parameterReference¶: Property parameterReference is of type ParameterReference.

property unit¶: Property unit is of type UnitInformation.

property usage¶: Property usage is of type int. See ExporterParameter.Usage for supported values.

property c_obj¶: Pointer to the underlying C-object

ExporterPopulation¶

class ExporterPopulation(description=None, package=None, validatedOk=None, name=None, version=None, transforms=None, key=None, model=None, populationState=None, _isOwner=True)¶

Bases: object

ExporterPopulation. Details of a particular FEA Exporter configuration, typically obtained from an Exporter Configuration File (EXP file) on the MI Server.

Parameters

description – type str
package – type str
validatedOk – type bool
name – type str
version – type int
transforms – type list of ExporterTransform objects
key – type str
model – type str
populationState – type int

class PopulationState¶

Bases: object

Unknown = 0¶

FullyPopulated = 1¶

PartiallyPopulated = 2¶

property description¶: Property description is of type str.

property key¶: Property key is of type str.

property model¶: Property model is of type str.

property name¶: Property name is of type str.

property transforms¶: Property transforms is a list of ExporterTransform objects. Warning: Do not attempt to edit or append to the returned value.

property package¶: Property package is of type str.

property populationState¶: Property populationState is of type int. See ExporterPopulation.PopulationState for supported values.

property validatedOk¶: Property validatedOk is of type bool.

property version¶: Property version is of type int.

property c_obj¶: Pointer to the underlying C-object

ExporterTransform¶

class ExporterTransform(type=None, Id=None, _isOwner=True)¶

Bases: object

ExporterTransform. Contains a type and an ID for an Exporter Transform

Parameters

type – type int
Id – type str

class Type¶

Bases: object

Unknown = 0¶

XSLT = 1¶

property Id¶: Property Id is of type str.

property type¶: Property type is of type int. See ExporterTransform.Type for supported values.

property c_obj¶: Pointer to the underlying C-object

ExportersForRecord¶

class ExportersForRecord(record=None, exporters=None, _isOwner=True)¶

Bases: object

ExportersForRecord. A type to contain a record and its associated exporters.

Parameters

record – type RecordReference
exporters – type list of ExporterPopulation objects

property exporters¶: Property exporters is a ExporterPopulation objects. Warning: Do not attempt to edit or append to the returned value.

property record¶: Property record is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

ExportersForRecordsRequest¶

class ExportersForRecordsRequest(specificAttributeExportersOnly=None, package=None, packageAndModelRequired=None, versionPolicy=None, records=None, model=None, applicabilityTag=None, _isOwner=True)¶

Bases: object

ExportersForRecordsRequest. Input for the ExportersForRecords operation.

Parameters

specificAttributeExportersOnly – type bool
package – type str
packageAndModelRequired – type bool
versionPolicy – type int
records – type list of RecordReference objects
model – type str
applicabilityTag – type str

property records¶: Property records is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property applicabilityTag¶: Property applicabilityTag is of type str.

property model¶: Property model is of type str.

property package¶: Property package is of type str.

property packageAndModelRequired¶: Property packageAndModelRequired is of type bool.

property specificAttributeExportersOnly¶: Property specificAttributeExportersOnly is of type bool.

property versionPolicy¶: Property versionPolicy is of type int. See GRANTA_Constants.VersionPolicy for supported values.

AddRecord(_recordReference)¶

Appends _recordReference to records property on ExportersForRecordsRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

ExportersForRecordsResponse¶

class ExportersForRecordsResponse(c_obj)¶

Bases: object

ExportersForRecordsResponse. Output from the ExportersForRecords operation. Contains a list of records and supported exporters.

Parameters: c_obj – ctypes.POINTER to a ExportersForRecordsResponse object.

property records¶: Property records is a list of ExportersForRecord objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

FileDataType¶

class FileDataType(URL=None, contentType=None, data=None, description=None, fileName=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

FileDataType. A type representing a piece of File data in a Granta MI database. The URL can be used to data export a file from a Granta MI database. For importing a file into a Granta MI database, the values of ‘fileName’, file ‘contentType’ and file ‘data’ must be sepcified, where ‘fileName’ is the name you want the file to appear as in Granta MI, the ‘contentType’ data is the MIME content type of the binary data, and ‘data’ is the contents of the file you wish to import to Granta MI.

Parameters

URL – type str
contentType – type str
data – type str
description – type str
fileName – type str
isApplicable – type bool

ModifyBinaryData(binaryData)¶

Modify the byte string data of the file.

Parameters: len - (*) –

ReadBinaryData()¶: Return a byte string representation of this file.

property contentType¶: Property contentType is of type str.

property data¶: Property data is of type str.

property description¶: Property description is of type str.

property fileName¶: Property fileName is of type str.

property isApplicable¶: Property isApplicable is of type bool.

property URL¶: Property URL is of type str.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalGraph¶

class FloatFunctionalGraph(series=None, hideGraph=None, logarithmicYAxis=None, _isOwner=True)¶

Bases: object

FloatFunctionalGraph. A type to contain a collection of series which contain the data functional data.

Parameters

series – type list of Series objects
hideGraph – type bool
logarithmicYAxis – type bool

property series¶: Property series is a list of Series objects. Warning: Do not attempt to edit or append to the returned value.

property hideGraph¶: Property hideGraph is of type bool.

property logarithmicYAxis¶: Property logarithmicYAxis is of type bool.

AddSeries(_series)¶

Appends _series to series property on FloatFunctionalGraph C-object.

Parameters: _series – object of type Series.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalGriddedDataType¶

class FloatFunctionalGriddedDataType(decoration=None, defaultXAxisParameter=None, values=None, parameters=None, unitInformation=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

FloatFunctionalGriddedDataType. A type to contain the values of float-valued functional gridded data. For requests, Values and Parameters are required.

Parameters

decoration – type int
defaultXAxisParameter – type ParameterInformation
values – type FloatFunctionalValues
parameters – type Parameters
unitInformation – type UnitInformation
isApplicable – type bool

property decoration¶: Property decoration is of type int. See GRANTA_Constants.GraphDecoration for supported values.

property defaultXAxisParameter¶: Property defaultXAxisParameter is of type ParameterInformation.

property isApplicable¶: Property isApplicable is of type bool.

property parameters¶: Property parameters is of type Parameters.

property unitInformation¶: Property unitInformation is of type UnitInformation.

property values¶: Property values is of type FloatFunctionalValues.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalPointValue¶

class FloatFunctionalPointValue(estimated=None, value=None, constraints=None, _isOwner=True)¶

Bases: object

FloatFunctionalPointValue. A single grid point in Gridded Float-Valued Functional Data, where the Y-axis value is a point

Parameters

estimated – type bool
value – type float
constraints – type Constraints

property constraints¶: Property constraints is of type Constraints.

property estimated¶: Property estimated is of type bool.

property value¶: Property value is of type float.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalRangeValue¶

class FloatFunctionalRangeValue(lowValue=None, estimated=None, highValue=None, constraints=None, _isOwner=True)¶

Bases: object

FloatFunctionalRangeValue. A single grid point in Gridded Float-Valued Functional Data, where the Y-axis value is a range.

Parameters

lowValue – type float
estimated – type bool
highValue – type float
constraints – type Constraints

property constraints¶: Property constraints is of type Constraints.

property estimated¶: Property estimated is of type bool.

property highValue¶: Property highValue is of type float.

property lowValue¶: Property lowValue is of type float.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalSeriesDataType¶

class FloatFunctionalSeriesDataType(graph=None, parameters=None, unitInformation=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

FloatFunctionalSeriesDataType. A type to contain the values of float-valued functional series data. For requests Graph, and Parameters are required.

Parameters

graph – type FloatFunctionalSeriesGraph
parameters – type Parameters
unitInformation – type UnitInformation
isApplicable – type bool

property graph¶: Property graph is of type FloatFunctionalSeriesGraph.

property isApplicable¶: Property isApplicable is of type bool.

property parameters¶: Property parameters is of type Parameters.

property unitInformation¶: Property unitInformation is of type UnitInformation.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalSeriesGraph¶

class FloatFunctionalSeriesGraph(series=None, XAxisParameter=None, hideGraph=None, logarithmicYAxis=None, _isOwner=True)¶

Bases: object

FloatFunctionalSeriesGraph. A type a collection of series which contain the data functional data and parameter information for the graph x-axis. For requests an XAxisParameter is required.

Parameters

series – type list of Series objects
XAxisParameter – type ParameterInformation
hideGraph – type bool
logarithmicYAxis – type bool

property series¶: Property series is a list of Series objects. Warning: Do not attempt to edit or append to the returned value.

property hideGraph¶: Property hideGraph is of type bool.

property logarithmicYAxis¶: Property logarithmicYAxis is of type bool.

property XAxisParameter¶: Property XAxisParameter is of type ParameterInformation.

AddSeries(_series)¶

Appends _series to series property on FloatFunctionalSeriesGraph C-object.

Parameters: _series – object of type Series.

property c_obj¶: Pointer to the underlying C-object

FloatFunctionalValues¶

class FloatFunctionalValues(valueType=None, rangeValues=None, pointValues=None, _isOwner=True)¶

Bases: object

FloatFunctionalValues. A collection of FloatFunctionalPointValue and FloatFunctionalRangeValue objects.

Parameters

valueType – type str
rangeValues – type list of FloatFunctionalRangeValue objects
pointValues – type list of FloatFunctionalPointValue objects

property pointValues¶: Property pointValues is a list of FloatFunctionalPointValue objects. Warning: Do not attempt to edit or append to the returned value.

property rangeValues¶: Property rangeValues is a list of FloatFunctionalRangeValue objects. Warning: Do not attempt to edit or append to the returned value.

property valueType¶: Property valueType is of type str.

AddPointValue(_floatFunctionalPointValue)¶

Appends _floatFunctionalPointValue to pointValues property on FloatFunctionalValues C-object.

Parameters: _floatFunctionalPointValue – object of type FloatFunctionalPointValue.

AddRangeValue(_floatFunctionalRangeValue)¶

Appends _floatFunctionalRangeValue to rangeValues property on FloatFunctionalValues C-object.

Parameters: _floatFunctionalRangeValue – object of type FloatFunctionalRangeValue.

property c_obj¶: Pointer to the underlying C-object

FunctionalDataSettings¶

class FunctionalDataSettings(convertGridToSeries=None, maxSeries=None, _isOwner=True)¶

Bases: object

FunctionalDataSettings. Settings affecting the export of Functional Data. If convertGridToSeries is true, gridded Functional Data will be converted to series data, allowing you to avoid the need to deal with the gridded data format.

Parameters

convertGridToSeries – type bool
maxSeries – type int

property convertGridToSeries¶: Property convertGridToSeries is of type bool.

property maxSeries¶: Property maxSeries is of type int.

property c_obj¶: Pointer to the underlying C-object

GRANTA_Constants¶

class GRANTA_Constants¶

Bases: object

class BinaryDataRepresentation¶

Bases: object

Inline = 0¶

URL = 1¶

class VersionPolicy¶

Bases: object

NoPolicy = 0¶

IncludeAll = 1¶

LatestVersionPerName = 2¶

class GraphDecoration¶

Bases: object

Lines = 0¶

Markers = 1¶

LinesAndMarkers = 2¶

class ImportTypes¶

Bases: object

Create = 'Create'¶

Update = 'Update'¶

Copy = 'Copy'¶

class SearchMode¶

Bases: object

Normal = 0¶

ReadOnly = 1¶

Unspecified = 2¶

class TablesFilter¶

Bases: object

NoFilter = 0¶

MaterialsTablesOnly = 1¶

ProcessesTablesOnly = 2¶

SubstancesTablesOnly = 3¶

LegislationsTablesOnly = 4¶

TransportTypesTablesOnly = 5¶

RegionsTablesOnly = 6¶

EndOfLifeOptionsTablesOnly = 7¶

EnergyConversionOptionsTablesOnly = 8¶

CoatingsTablesOnly = 9¶

PartsTablesOnly = 10¶

InHouseTablesOnly = 11¶

SequenceSpecificationsTablesOnly = 12¶

ElementsTablesOnly = 13¶

UniverseTablesOnly = 14¶

ProducersTablesOnly = 15¶

ShapeTablesOnly = 16¶

ReferenceTablesOnly = 17¶

MobileUseTypesTablesOnly = 18¶

class ParameterTypes¶

Bases: object

Numeric = 'Numeric'¶

Discrete = 'Discrete'¶

class ImportErrorMode¶

Bases: object

Fault = 'FaultAndRollbackOnAnyError'¶

Continue = 'LogAndContinueWherePossible'¶

class RecordLinkGroupTypes¶

Bases: object

Static = 'static'¶

Dynamic = 'dynamic'¶

CrossDatabase = 'crossDatabase'¶

class RecordLinkCheckMode¶

Bases: object

Forward = 'CheckOnlyForwardLinks'¶

ForwardAndReverse = 'CheckForwardAndReverseLinks'¶

class MinMaxType¶

Bases: object

MMNone = 0¶

MMApproximate = 1¶

MMTrue = 2¶

POINT_TYPE_STRING = 'POIN'¶

RANGE_TYPE_STRING = 'RNGE'¶

FLOAT_FUNCTIONAL_TYPE_STRING = 'FUNC'¶

INTEGER_TYPE_STRING = 'INPT'¶

LOGICAL_TYPE_STRING = 'LOGI'¶

DISCRETE_TYPE_STRING = 'DISC'¶

SHORT_TEXT_TYPE_STRING = 'STXT'¶

LONG_TEXT_TYPE_STRING = 'LTXT'¶

HYPERLINK_TYPE_STRING = 'HLNK'¶

FLOAT_FUNCTIONAL_SERIES_TYPE_STRING = 'FLOAT_FUNCTIONAL_SERIES'¶

FLOAT_FUNCTIONAL_GRIDDED_TYPE_STRING = 'FLOAT_FUNCTIONAL_GRIDDED'¶

POINT_XYDATA_TYPE_STRING = 'XYPoint'¶

RANGE_XYDATA_TYPE_STRING = 'XYRange'¶

GRANTA_Exceptions¶

exception GRANTA_Exception(expr, msg)¶

Bases: Exception

Exception raised when there are errors in input.

Parameters

expr – input expression in which the error occurred
msg – explanation of the error

exception GRANTA_ServiceLayerError(slResponse, operation)¶

Bases: Exception

Exception raised when the Granta MI Service Layer returns an error.

Parameters

slResponse – type ServiceLayerResponse, request data causing this error
operation – a string that identifies the operation from which this exception originated

Variables

responseXML (str) – the XML from the response from Granta MI
message (str) – error string extracted from responseXML
responseCode (responseCode) – HTTP response code associated with this error
data (str) – request data causing this error

GRANTA_Logging¶

class GRANTA_Logging¶

Bases: object

Implements some basic logging functionality. Tracked events are printed to the console.: For comprehensive logging capabilities, use the Python ‘logging’ module.

propagate = True¶

info(message)¶

debug(message)¶

warning(message)¶

error(message)¶

GRANTA_MISession¶

class GRANTA_MISession(url, username=None, password=None, domain=None, verbosity='ERROR', autoLogon=False, receiveTimeout=300000, authorization=None)¶

Bases: object

The base object for the GRANTA_MIScripting toolkit. This creates a connection to a Granta MI Server via a Granta MI Service Layer.

Parameters username, password, domain, and autoLogon are optional - use either SetCredentials or UseAutoLogon to specify the desired authentication method if these are omitted.

Parameters

url – URL of your Granta MI Service Layer installation
username – Your Granta MI username (for Basic authentication)
password – Your Granta MI password (for Basic authentication)
domain – Your Granta MI user domain (for Basic authentication)
verbosity – Logging verbosity; accepted values are “ERROR”, “WARNING”, or “DEBUG”
autoLogon – If set to True, this object will authenticate as the current Windows user
receiveTimeout – Time in milliseconds to wait for a response before timing out
authorization – OIDC object (for OpenID Connect authentication)

TestConnection()¶: Raises a GRANTA_Exception if connection cannot be made - eg bad credentials or unreachable Granta MI Service Layer URL

property browseService¶: Property browseService is of type BrowseService

property searchService¶: Property searchService is of type SearchService

property dataExportService¶: Property dataExportService is of type DataExportService

property dataImportService¶: Property dataImportService is of type DataImportService

property engineeringDataService¶: Property engineeringDataServiceis of type EngineeringDataService

GetAssociatedRecordsRequest¶

class GetAssociatedRecordsRequest(attributeReferences=None, linkDirection=None, populateGUIDs=None, recordFilter=None, recordReferences=None, tableReference=None, _isOwner=True)¶

Bases: object

GetAssociatedRecordsRequest. Input for the GetAssociatedRecords operation.

Parameters

attributeReferences – type list of AttributeReference objects
linkDirection – type int
populateGUIDs – type bool
recordFilter – type RecordFilter
recordReferences – type list of RecordReference objects
tableReference – type TableReference

class AssociationLinkDirection¶

Bases: object

NONE = 0¶

Both = 1¶

Forward = 2¶

Reverse = 3¶

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property recordReferences¶: Property recordReferences is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property linkDirection¶: Property linkDirection is of type int.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordFilter¶: Property recordFilter is of type RecordFilter.

property tableReference¶: Property tableReference is of type TableReference.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetAssociatedRecordsRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

AddRecordReference(_recordReference)¶

Appends _recordReference to recordReferences property on GetAssociatedRecordsRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetAssociatedRecordsResponse¶

class GetAssociatedRecordsResponse(c_obj)¶

Bases: object

GetAssociatedRecordsResponse. Output from the GetAssociatedRecords operation. An array of AssociatedRecords objects.

Parameters: c_obj – ctypes.POINTER to a GetAssociatedRecordsResponse object.

property associatedRecords¶: Property associatedRecords is a list of AssociatedRecords objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddAssociatedRecords(_associatedRecords)¶

Appends _associatedRecords to associatedRecords property on GetAssociatedRecordsResponse C-object.

Parameters: _associatedRecords – object of type AssociatedRecords.

property c_obj¶: Pointer to the underlying C-object

GetAttributeDetailsRequest¶

class GetAttributeDetailsRequest(attributeReferences=None, minMaxCalculation=None, _isOwner=True)¶

Bases: object

GetAttributeDetailsRequest. Input for the GetAttributeDetails operation. For requests at least one AttributeReference is required.

Parameters

attributeReferences – type list of AttributeReference objects
minMaxCalculation – type int

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property minMaxCalculation¶: Property minMaxCalculation is of type int.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetAttributeDetailsRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

property c_obj¶: Pointer to the underlying C-object

GetAttributeDetailsResponse¶

class GetAttributeDetailsResponse(c_obj)¶

Bases: object

GetAttributeDetailsResponse. Output from the GetAttributeDetails operation. Includes an array of AttributeDetail objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetAttributeDetailsResponse object.

property attributeDetails¶: Property attributeDetails is a list of AttributeDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddAttributeDetails(_attributeDetail)¶

Appends _attributeDetail to attributeDetails property on GetAttributeDetailsResponse C-object.

Parameters: _attributeDetail – object of type AttributeDetail.

property c_obj¶: Pointer to the underlying C-object

GetAttributeParametersRequest¶

class GetAttributeParametersRequest(attributeReferences=None, _isOwner=True)¶

Bases: object

GetAttributeParametersRequest. Input for the GetAttributeParameters operation. For requests, at least one AttributeReference is required.

Parameters: attributeReferences – type list of AttributeReference objects

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetAttributeParametersRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

property c_obj¶: Pointer to the underlying C-object

GetAttributeParametersResponse¶

class GetAttributeParametersResponse(c_obj)¶

Bases: object

GetAttributeParametersResponse. Output from the GetAttributeParameters operation. Includes an array of ParameterDetail objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetAttributeParametersResponse object.

property attributeParameters¶: Property attributeParameters is a ParameterDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetAvailableExportersRequest¶

class GetAvailableExportersRequest(package=None, partialTableReference=None, DBKey=None, versionPolicy=None, applicabilityTag=None, model=None, matchDB=None, _isOwner=True)¶

Bases: object

GetAvailableExportersRequest. Input for the GetAvailableExporters operation.

Parameters

package – type str
partialTableReference – type PartialTableReference
DBKey – type str
versionPolicy – type int
applicabilityTag – type str
model – type str
matchDB – type bool

property applicabilityTag¶: Property applicabilityTag is of type str.

property DBKey¶: Property DBKey is of type str.

property matchDB¶: Property matchDB is of type bool. If true, we check that the exporter config Table element is in a Database element for the right dbKey.

property model¶: Property model is of type str.

property package¶: Property package is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference.

property versionPolicy¶: Property versionPolicy is of type int. See GRANTA_Constants.VersionPolicy for supported values.

property c_obj¶: Pointer to the underlying C-object

GetAvailableExportersResponse¶

class GetAvailableExportersResponse(c_obj)¶

Bases: object

GetAvailableExportersResponse. Output from the GetAvailableExporters operation. Contains a list of exporters.

Parameters: c_obj – ctypes.POINTER to a GetAvailableExportersResponse object.

property exporters¶: Property exporters is a Exporter objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetChildNodes¶

class GetChildNodes(recordFilter=None, recurse=None, populateGUIDs=None, parent=None, recurseMaxDepth=None, _isOwner=True)¶

Bases: object

GetChildNodes. Input for the GetChildNodes operation. A RecordReference for the record you wish to find the children of is required.

Parameters

recordFilter – type RecordFilter
recurse – type bool
populateGUIDs – type bool
parent – type RecordReference
recurseMaxDepth – type int

property parent¶: Property parent is of type RecordReference.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordFilter¶: Property recordFilter is of type RecordFilter.

property recurse¶: Property recurse is of type bool.

property recurseMaxDepth¶: Property recurseMaxDepth is of type int.

property c_obj¶: Pointer to the underlying C-object

GetChildNodesResponse¶

class GetChildNodesResponse(c_obj)¶

Bases: object

GetChildNodesResponse. Response for the GetChildNodes operation. Includes an array of TreeRecord objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetChildNodesResponse object.

property treeRecords¶: Property treeRecords is a list of TreeRecord objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddTreeRecord(_treeRecord)¶

Appends _treeRecord to treeRecords property on GetChildNodesResponse C-object.

Parameters: _treeRecord – object of type TreeRecord.

property c_obj¶: Pointer to the underlying C-object

GetDatabaseParameters¶

class GetDatabaseParameters(DBKey=None, requireStandardNames=None, useStandardNamesWherePossible=None, _isOwner=True)¶

Bases: object

GetDatabaseParameters. Input for the GetDatabaseParameters operation. Requires a DBKey to be set. The parameters requireStandardNames and useStandardNamesWherePossible both default to false.

Parameters

DBKey – type str
requireStandardNames – type bool
useStandardNamesWherePossible – type bool

property DBKey¶: Property DBKey is of type str.

property requireStandardNames¶: Property requireStandardNames is of type bool.

property useStandardNamesWherePossible¶: Property useStandardNamesWherePossible is of type bool.

property c_obj¶: Pointer to the underlying C-object

GetDatabaseParametersResponse¶

class GetDatabaseParametersResponse(c_obj)¶

Bases: object

GetDatabaseParametersResponse. Output from the GetDatabaseParametersResponse operation. Includes an array of ParameterDetail objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetDatabaseParametersResponse object.

property parameterDetails¶: Property parameterDetails is a list of ParameterDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddParameterDetail(_parameterDetail)¶

Appends _parameterDetail to parameterDetails property on GetDatabaseParametersResponse C-object.

Parameters: _parameterDetail – object of type ParameterDetail.

property c_obj¶: Pointer to the underlying C-object

GetDatabasesResponse¶

class GetDatabasesResponse(c_obj)¶

Bases: object

GetDatabasesResponse. Output from the GetDatabases operation. Includes an array of MIDatabase objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetDatabasesResponse object.

property databases¶: Property databases is a list of MIDatabase objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddDatabase(_MIDatabase)¶

Appends _MIDatabase to databases property on GetDatabasesResponse C-object.

Parameters: _MIDatabase – object of type MIDatabase.

property c_obj¶: Pointer to the underlying C-object

GetExporterParametersRequest¶

class GetExporterParametersRequest(records=None, exporterKey=None, populateGUIDs=None, unitConversionContext=None, _isOwner=True)¶

Bases: object

GetExporterParametersRequest. Input for the GetExporterParameters operation.

Parameters

records – type list of RecordReference objects
exporterKey – type str
populateGUIDs – type bool
unitConversionContext – type UnitConversionContext

property records¶: Property records is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property exporterKey¶: Property exporterKey is of type str.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property unitConversionContext¶: Property unitConversionContext is of type UnitConversionContext.

AddRecord(_recordReference)¶

Appends _recordReference to records property on GetExporterParametersRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetExporterParametersResponse¶

class GetExporterParametersResponse(c_obj)¶

Bases: object

GetExporterParametersResponse. Output from the GetExporterParameters operation. Contains a list of records and details for exporting their attributes.

Parameters: c_obj – ctypes.POINTER to a GetExporterParametersResponse object.

property records¶: Property records is a list of RecordExporterParameters objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetIntegrationProfiles¶

class GetIntegrationProfiles(databases=None, depth=None, _isOwner=True)¶

Bases: object

GetIntegrationProfiles. Input for the GetIntegrationProfiles operation.

Parameters

databases – type list of str objects
depth – type int

class Depth¶

Bases: object

Profiles = 0¶

Databases = 1¶

Tables = 2¶

property databases¶: Property databases is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property depth¶: Property depth is of type int.

AddDatabase(value)¶

Appends value to databases property on GetIntegrationProfiles C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

GetIntegrationProfilesResponse¶

class GetIntegrationProfilesResponse(c_obj)¶

Bases: object

GetIntegrationProfilesResponse. Output from GetIntegrationProfiles operation. Includes an array of IntegrationProfileDetail objects and a ServiceLayerResponse

Parameters: c_obj – ctypes.POINTER to a GetIntegrationProfilesResponse object.

property profileDetails¶: Property profileDetails is a list of IntegrationProfileDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetLayouts¶

class GetLayouts(layouts=None, table=None, applicabilityTag=None, minMaxCalculation=None, _isOwner=True)¶

Bases: object

GetLayouts. Input for the GetLayouts operation. Includes a table reference or list of layouts to retrieve.

Parameters

layouts – type list of LayoutReference objects
table – type TableReference
applicabilityTag – type str
minMaxCalculation – type int

property layouts¶: Property layouts is a list of LayoutReference objects. Warning: Do not attempt to edit or append to the returned value.

property table¶: Property table is of type TableReference.

property applicabilityTag¶: Property applicabilityTag is of type str.

property minMaxCalculation¶: Property minMaxCalculation is of type int.

AddLayout(_layoutReference)¶

Appends _layoutReference to layouts property on GetLayouts C-object.

Parameters: _layoutReference – object of type LayoutReference.

property c_obj¶: Pointer to the underlying C-object

GetLayoutsResponse¶

class GetLayoutsResponse(c_obj)¶

Bases: object

GetLayoutsResponse. Output from the GetLayouts operation. Includes a list of layouts retrieved.

Parameters: c_obj – ctypes.POINTER to a GetLayoutsResponse object.

property layoutDetails¶: Property layoutDetails is a list of LayoutDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddLayoutDetail(_layoutDetail)¶

Appends _layoutDetail to layoutDetails property on GetLayoutsResponse C-object.

Parameters: _layoutDetail – object of type LayoutDetail.

property c_obj¶: Pointer to the underlying C-object

GetLinkedRecordsRequest¶

class GetLinkedRecordsRequest(recordReferences=None, recordLinkGroups=None, populateGUIDs=None, recordFilter=None, directLinksOnly=None, _isOwner=True)¶

Bases: object

GetLinkedRecordsRequest. Input for the GetLinkedRecords operation.

Parameters

recordReferences – type list of RecordReference objects
recordLinkGroups – type list of RecordLinkGroupReference objects
populateGUIDs – type bool
recordFilter – type RecordFilter
directLinksOnly – type bool

property recordLinkGroups¶: Property recordLinkGroups is a list of RecordLinkGroupReference objects. Warning: Do not attempt to edit or append to the returned value.

property recordReferences¶: Property recordReferences is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property directLinksOnly¶: Property directLinksOnly is of type bool.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordFilter¶: Property recordFilter is of type RecordFilter.

AddRecordLinkGroup(_recordLinkGroupReference)¶

Appends _recordLinkGroupReference to recordLinkGroups property on GetLinkedRecordsRequest C-object.

Parameters: _recordLinkGroupReference – object of type RecordLinkGroupReference.

AddRecordReference(_recordReference)¶

Appends _recordReference to recordReferences property on GetLinkedRecordsRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetLinkedRecordsResponse¶

class GetLinkedRecordsResponse(c_obj)¶

Bases: object

GetLinkedRecordsResponse. Output from the GetLinkedRecords operation. Includes an array of SourceRecord objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetLinkedRecordsResponse object.

property sourceRecords¶: Property sourceRecords is a list of SourceRecord objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetMetaAttributesRequest¶

class GetMetaAttributesRequest(attributeReferences=None, _isOwner=True)¶

Bases: object

GetMetaAttributesRequest. Input for the GetMetaAttributesRequest operation.

Parameters: attributeReferences – type list of AttributeReference objects

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetMetaAttributesRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

property c_obj¶: Pointer to the underlying C-object

GetMetaAttributesResponse¶

class GetMetaAttributesResponse(c_obj)¶

Bases: object

GetMetaAttributesResponse. Output from the GetMetaAttributes operation. Includes an array of AttributeMetaAttributes objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetMetaAttributesResponse object.

property attributes¶: Property attributes is a AttributeMetaAttributes objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetParameterDetailsRequest¶

class GetParameterDetailsRequest(attribute=None, parameterReferences=None, recordReference=None, _isOwner=True)¶

Bases: object

GetParameterDetailsRequest. Input for the GetParameterDetails operation.

Parameters

attribute – type AttributeReference
parameterReferences – type list of ParameterReference objects
recordReference – type RecordReference

property parameterReferences¶: Property parameterReferences is a list of ParameterReference objects. Warning: Do not attempt to edit or append to the returned value.

property attribute¶: Property attribute is of type AttributeReference.

property recordReference¶: Property recordReference is of type RecordReference.

AddParameterReference(_parameterReference)¶

Appends _parameterReference to parameterReferences property on GetParameterDetailsRequest C-object.

Parameters: _parameterReference – object of type ParameterReference.

property c_obj¶: Pointer to the underlying C-object

GetParameterDetailsResponse¶

class GetParameterDetailsResponse(c_obj)¶

Bases: object

GetParameterDetailsResponse. Output from the GetParameterDetails operation. Includes an array of ParameterDetail objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetParameterDetailsResponse object.

property attributeParameters¶: Property attributeParameters is a ParameterDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetRecordAttributesByRefRequest¶

class GetRecordAttributesByRefRequest(recordFilter=None, useFallback=None, attributeReferences=None, populateGUIDs=None, unitConversionContext=None, recordReferences=None, exportedAttributes=None, functionalDataSettings=None, binaryData=None, directLinksOnly=None, _isOwner=True)¶

Bases: object

GetRecordAttributesByRefRequest. Input for the GetRecordAttributesByRef operation. For requests, at least one RecordReference and at least one AttributeReference is required.

Parameters

recordFilter – type RecordFilter
useFallback – type bool
attributeReferences – type list of AttributeReference objects
populateGUIDs – type bool
unitConversionContext – type UnitConversionContext
recordReferences – type list of RecordReference objects
exportedAttributes – type list of ExportedAttribute objects
functionalDataSettings – type FunctionalDataSettings
binaryData – type BinaryDataSettings
directLinksOnly – type bool

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property exportedAttributes¶: Property exportedAttributes is a list of ExportedAttribute objects. Warning: Do not attempt to edit or append to the returned value.

property recordReferences¶: Property recordReferences is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property directLinksOnly¶: Property directLinksOnly is of type bool.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordFilter¶: Property recordFilter is of type RecordFilter.

property unitConversionContext¶: Property unitConversionContext is of type UnitConversionContext.

property useFallback¶: Property useFallback is of type bool.

property binaryData¶: Property binaryData is of type BinaryDataSettings.

property functionalDataSettings¶: Property functionalDataSettings is of type FunctionalDataSettings.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetRecordAttributesByRefRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

AddExportedAttribute(_exportedAttribute)¶

Appends _exportedAttribute to exportedAttributes property on GetRecordAttributesByRefRequest C-object.

Parameters: _exportedAttribute – object of type ExportedAttribute.

AddRecordReference(_recordReference)¶

Appends _recordReference to recordReferences property on GetRecordAttributesByRefRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetRecordAttributesByRefResponse¶

class GetRecordAttributesByRefResponse(c_obj)¶

Bases: object

GetRecordAttributesByRefResponse. Output from the GetRecordAttributesByRef operation. Includes an array of RecordData objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetRecordAttributesByRefResponse object.

property recordData¶: Property recordData is a list of RecordData objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddRecordData(_recordData)¶

Appends _recordData to recordData property on GetRecordAttributesByRefResponse C-object.

Parameters: _recordData – object of type RecordData.

property c_obj¶: Pointer to the underlying C-object

GetRecordAttributesRequest¶

class GetRecordAttributesRequest(includeMeta=None, recordReferences=None, includeEmpty=None, includeParamDetails=None, minMaxCalculation=None, _isOwner=True)¶

Bases: object

GetRecordAttributesRequest. Input for the GetRecordAttribute operation.

Parameters

includeMeta – type bool
recordReferences – type list of RecordReference objects
includeEmpty – type bool
includeParamDetails – type bool
minMaxCalculation – type int

property recordReferences¶: Property recordReferences is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property includeEmpty¶: Property includeEmpty is of type bool.

property includeMeta¶: Property includeMeta is of type bool.

property includeParamDetails¶: Property includeParamDetails is of type bool.

property minMaxCalculation¶: Property minMaxCalculation is of type int.

AddRecordReference(_recordReference)¶

Appends _recordReference to recordReferences property on GetRecordAttributesRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetRecordAttributesResponse¶

class GetRecordAttributesResponse(c_obj)¶

Bases: object

GetRecordAttributesResponse. Output from the GetRecordAttributes operation. Includes an array of RecordAttribute objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetRecordAttributesResponse object.

property recordAttributes¶: Property recordAttributes is a list of RecordAttribute objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddRecordAttribute(_recordAttribute)¶

Appends _recordAttribute to recordAttributes property on GetRecordAttributesResponse C-object.

Parameters: _recordAttribute – object of type RecordAttribute.

property c_obj¶: Pointer to the underlying C-object

GetRecordLinkGroups¶

class GetRecordLinkGroups(standardNamesOnly=None, recordLinkGroups=None, DBKey=None, _isOwner=True)¶

Bases: object

GetRecordLinkGroups. Returns details of Record Link Groups in a Granta MI Database.

Parameters

standardNamesOnly – type bool
recordLinkGroups – type list of RecordLinkGroupReference objects
DBKey – type str

property recordLinkGroups¶: Property recordLinkGroups is a list of RecordLinkGroupReference objects. Warning: Do not attempt to edit or append to the returned value.

property DBKey¶: Property DBKey is of type str. When this is provided, details of all Record Link Groups in the specified Granta MI Database will be returned.

property standardNamesOnly¶: Property standardNamesOnly is of type bool.

AddRecordLinkGroup(_recordLinkGroupReference)¶

Appends _recordLinkGroupReference to recordLinkGroups property on GetRecordLinkGroups C-object.

Parameters: _recordLinkGroupReference – object of type RecordLinkGroupReference.

property c_obj¶: Pointer to the underlying C-object

GetRecordLinkGroupsResponse¶

class GetRecordLinkGroupsResponse(c_obj)¶

Bases: object

GetRecordLinkGroupsResponse. Output from the GetRecordLinkGroups operation.

Parameters: c_obj – ctypes.POINTER to a GetRecordLinkGroupsResponse object.

property recordLinkGroups¶: Property recordLinkGroups is a list of RecordLinkGroupDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetRecordVersionsRequest¶

class GetRecordVersionsRequest(records=None, versions=None, _isOwner=True)¶

Bases: object

GetRecordVersionsRequest. Input for the GetRecordVersions operation.

Parameters

records – type list of RecordReference objects
versions – type int

class VersionSelector¶

Bases: object

LatestRead = 0¶

Latest = 1¶

AllReleased = 2¶

All = 3¶

property records¶: Property records is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property versions¶: Property versions is of type int. See GetRecordVersionsRequest.VersionSelector for supported values.

AddRecord(_recordReference)¶

Appends _recordReference to records property on GetRecordVersionsRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetRecordVersionsResponse¶

class GetRecordVersionsResponse(c_obj)¶

Bases: object

GetRecordVersionsResponse. Output from the GetRecordVersions operation. Contains a list of version states.

Parameters: c_obj – ctypes.POINTER to a GetRecordVersionsResponse object.

property recordStates¶: Property recordStates is a list of RecordVersionState objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetRootNode¶

class GetRootNode(table=None, _isOwner=True)¶

Bases: object

GetRootNode. Input to the GetRootNode operation. Requires a TableReference .

Parameters: table – type TableReference

property table¶: Property table is of type TableReference.

property c_obj¶: Pointer to the underlying C-object

GetRootNodeResponse¶

class GetRootNodeResponse(c_obj)¶

Bases: object

GetRootNodeResponse. Output from the GetRootNode operation. Includes a TreeRecord object and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetRootNodeResponse object.

property rootNode¶: Property rootNode is of type TreeRecord.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetSubsetsRequest¶

class GetSubsetsRequest(table=None, subsetReferences=None, _isOwner=True)¶

Bases: object

GetSubsetsRequest. Input to the GetSubsets operation. Requires a TableReference .

Parameters

table – type TableReference
subsetReferences – type list of SubsetReference objects

property subsetReferences¶: Property subsetReferences is of type list of SubsetReference.

property table¶: Property table is of type TableReference.

AddSubsetReference(_subsetReference)¶

Appends _subsetReference to subsetReferences property on GetSubsetsRequest C-object.

Parameters: _subsetReference – object of type SubsetReference.

property c_obj¶: Pointer to the underlying C-object

GetSubsetsResponse¶

class GetSubsetsResponse(c_obj)¶

Bases: object

GetSubsetsResponse. Output from the GetSubsets operation. Includes an array of SubsetDetails objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetSubsetsResponse object.

property subsetDetails¶: Property subsetDetails is a list of SubsetDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetTables¶

class GetTables(tableFilter=None, attributeSelectors=None, DBKey=None, _isOwner=True)¶

Bases: object

GetTables. Input to the GetTables operation. Requires a DBKey to be set.

Parameters

tableFilter – type int
attributeSelectors – type list of int objects
DBKey – type str

class AttributeSelector¶

Bases: object

NONE = 0¶

NonMetaAttributes = 1¶

MetaAttributes = 2¶

StandardAttributes = 3¶

property attributeSelectors¶: Property attributeSelectors is a list of int objects. See GetTables.AttributeSelector for supported values. Warning: Do not attempt to edit or append to the returned value.

property DBKey¶: Property DBKey is of type str.

property tableFilter¶: Property tableFilter is of type int. See GRANTA_Constants.TablesFilter for supported values.

AddAttributeSelector(value)¶

Appends value to attributeSelectors property on GetTables C-object.

Parameters: value – object of type int.

property c_obj¶: Pointer to the underlying C-object

GetTablesResponse¶

class GetTablesResponse(c_obj)¶

Bases: object

GetTablesResponse. Output from the GetTables operation. Includes an array of TableDetail objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetTablesResponse object.

property tableDetails¶: Property tableDetails is a list of TableDetail objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddTableDetail(_tableDetail)¶

Appends _tableDetail to tableDetails property on GetTablesResponse C-object.

Parameters: _tableDetail – object of type TableDetail.

property c_obj¶: Pointer to the underlying C-object

GetTreeRecordsRequest¶

class GetTreeRecordsRequest(records=None, _isOwner=True)¶

Bases: object

GetTreeRecordsRequest. Input to the GetTreeRecords operation. Requires at least one RecordReference

Parameters: records – type list of RecordReference objects

property records¶: Property records is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

AddRecord(_recordReference)¶

Appends _recordReference to records property on GetTreeRecordsRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetTreeRecordsResponse¶

class GetTreeRecordsResponse(c_obj)¶

Bases: object

GetTreeRecordsResponse. Output to the GetTreeRecords operation. Includes an array of TreeRecord objects and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a GetTreeRecordsResponse object.

property treeRecords¶: Property treeRecords is a list of TreeRecord objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddTreeRecord(_treeRecord)¶

Appends _treeRecord to treeRecords property on GetTreeRecordsResponse C-object.

Parameters: _treeRecord – object of type TreeRecord.

property c_obj¶: Pointer to the underlying C-object

GetUnitConversionsRequest¶

class GetUnitConversionsRequest(DBKey=None, sourceCurrency=None, targetCurrency=None, unitConversionContexts=None, unitSymbols=None, _isOwner=True)¶

Bases: object

GetUnitConversionsRequest. Input for the GetUnitConversions operation.

Parameters

DBKey – type str
sourceCurrency – type str
targetCurrency – type str
unitConversionContexts – type list of UnitConversionContext objects
unitSymbols – type list of str objects

property unitConversionContexts¶: Property unitConversionContexts is a list of UnitConversionContext objects. Warning: Do not attempt to edit or append to the returned value.

property unitSymbols¶: Property unitSymbols is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property DBKey¶: Property DBKey is of type str.

property sourceCurrency¶: Property sourceCurrency is of type str.

property targetCurrency¶: Property targetCurrency is of type str.

AddUnitConversionContext(_unitConversionContext)¶

Appends _unitConversionContext to unitConversionContexts property on GetUnitConversionsRequest C-object.

Parameters: _unitConversionContext – object of type UnitConversionContext.

AddUnitSymbol(value)¶

Appends value to unitSymbols property on GetUnitConversionsRequest C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

GetUnitConversionsResponse¶

class GetUnitConversionsResponse(c_obj)¶

Bases: object

GetUnitConversionsResponse. Output from the GetUnitConversions operation.

Parameters: c_obj – ctypes.POINTER to a GetUnitConversionsResponse object.

property DBKey¶: Property DBKey is of type str.

property sourceUnits¶: Property sourceUnits is a list of SourceUnitConversionSet objects. Warning: Do not attempt to edit or append to the returned value.

property unitConversionContexts¶: Property unitConversionContexts is a list of UnitConversionContextConversionSet objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetUnitSystems¶

class GetUnitSystems(excludeCurrencies=None, DBKey=None, _isOwner=True)¶

Bases: object

GetUnitSystems. A type for requesting the unit systems on a particular Granta MI database. A DBKey must be specified.

Parameters

excludeCurrencies – type bool
DBKey – type str

property DBKey¶: Property DBKey is of type str.

property excludeCurrencies¶: Property excludeCurrencies is of type bool.

property c_obj¶: Pointer to the underlying C-object

GetUnitSystemsResponse¶

class GetUnitSystemsResponse(c_obj)¶

Bases: object

GetUnitSystemsResponse. The ouput of a GetUnitSystems requests. Contains an array of unit systems for the specified database.

Parameters: c_obj – ctypes.POINTER to a GetUnitSystemsResponse object.

property DBKey¶: Property DBKey is of type str.

property unitSystems¶: Property unitSystems is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GetUploadAddressesRequest¶

class GetUploadAddressesRequest(recordReferences=None, attributeReferences=None, _isOwner=True)¶

Bases: object

GetUploadAddressesRequest. Input to the GetUploadAddresses operation. Contains a list of records and attributes to get the upload URL addresses of.

Parameters

recordReferences – type list of RecordReference objects
attributeReferences – type list of AttributeReference objects

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property recordReferences¶: Property recordReferences is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

AddAttributeReference(_attributeReference)¶

Appends _attributeReference to attributeReferences property on GetUploadAddressesRequest C-object.

Parameters: _attributeReference – object of type AttributeReference.

AddRecordReference(_recordReference)¶

Appends _recordReference to recordReferences property on GetUploadAddressesRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

GetUploadAddressesResponse¶

class GetUploadAddressesResponse(c_obj)¶

Bases: object

GetUploadAddressesResponse. Output from the GetUploadAddresses operation. Contains a list of RecordWithAttributeAddresses objects for each record in the GetUploadAddressesRequest.

Parameters: c_obj – ctypes.POINTER to a GetUploadAddressesResponse object.

property recordsWithAttributeAddresses¶: Property recordsWithAttributeAddresses is a list of RecordWithAttributeAddresses objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

GraphDomain¶

class GraphDomain(parameterDomains=None, _isOwner=True)¶

Bases: object

GraphDomain. A type to contain choices of fixed parameter values. A value must be chosen for each parameter, within the given constraints.

Parameters: parameterDomains – type list of ParameterDomain objects

property parameterDomains¶: Property parameterDomains is a list of ParameterDomain objects. Warning: Do not attempt to edit or append to the returned value.

property c_obj¶: Pointer to the underlying C-object

GreaterThanSearchValue¶

class GreaterThanSearchValue(unit=None, value=None, tabularColumn=None, _isOwner=True)¶

Bases: object

GreaterThanSearchValue. Search criterion to search for data greater than a specified value. Criterion passes if data value is above a given value. Point, range, and integer attributes are supported.

Parameters

unit – type str
value – type float
tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property unit¶: Property unit is of type str.

property value¶: Property value is of type float.

property c_obj¶: Pointer to the underlying C-object

HelpInfo¶

class HelpInfo(databaseHelp=None, helpURI=None, _isOwner=True)¶

Bases: object

HelpInfo. Type describing how to obtain detailed Help information for an entity in a Granta MI database.

Parameters

databaseHelp – type bool
helpURI – type str

property databaseHelp¶: Property databaseHelp is of type bool.

property helpURI¶: Property helpURI is of type str.

property c_obj¶: Pointer to the underlying C-object

HighEndSearchValue¶

class HighEndSearchValue(unit=None, value=None, _isOwner=True)¶

Bases: object

HighEndSearchValue. Upper limit for the BetweenSearchValue search criterion. Requires a double value and an optional unit.

Parameters

unit – type str
value – type float

property unit¶: Property unit is of type str.

property value¶: Property value is of type float.

property c_obj¶: Pointer to the underlying C-object

HyperlinkDataType¶

class HyperlinkDataType(value=None, description=None, hyperlinkDisplay=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

HyperlinkDataType. A type to contain a HyperLink string value.

Parameters

value – type str
description – type str
hyperlinkDisplay – type int
isApplicable – type bool

class HyperlinkDisplay¶

Bases: object

New = 0¶

Top = 1¶

Content = 2¶

property description¶: Property description is of type str.

property hyperlinkDisplay¶: Property hyperlinkDisplay is of type int.

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

IDataValue¶

class IDataValue¶

Bases: object

Base class for data values in Granta MI.

You should not interact directly with this class.

ImportAttributeValue¶

class ImportAttributeValue(rangeDataValue=None, discreteDataValue=None, hyperlinkDataValue=None, fileDataValue=None, floatFunctionalGriddedDataType=None, shortTextDataValue=None, integerDataValue=None, pointDataValue=None, logicalDataValue=None, longTextDataValue=None, dateDataValue=None, floatFunctionalSeriesDataType=None, attributeReference=None, tabularDataValue=None, pictureDataValue=None, _isOwner=True)¶

Bases: object

ImportAttributeValue. An AttributeValue to import to a Granta MI database. Requires a AttributeReference and an attribute value for the data type you wish to upload. Supports: PointDataType, RangeDataType, FloatFunctionalSeriesDataType, FloatFunctionalGriddedDataType, ShortTextDataType, LongTextDataType, DiscreteDataType, IntegerDataType, LogicalDataType, HyperlinkDataType, and FileDataType.

Parameters

rangeDataValue – type RangeDataType
discreteDataValue – type DiscreteDataType
hyperlinkDataValue – type HyperlinkDataType
fileDataValue – type FileDataType
floatFunctionalGriddedDataType – type FloatFunctionalGriddedDataType
shortTextDataValue – type ShortTextDataType
integerDataValue – type IntegerDataType
pointDataValue – type PointDataType
logicalDataValue – type LogicalDataType
longTextDataValue – type LongTextDataType
dateDataValue – type DateDataType
floatFunctionalSeriesDataType – type FloatFunctionalSeriesDataType
attributeReference – type AttributeReference
tabularDataValue – type TabularDataType
pictureDataValue – type PictureDataType

property attributeReference¶: Property attributeReference is of type AttributeReference.

property dateDataValue¶: Property dateDataValue is of type DateDataType.

property discreteDataValue¶: Property discreteDataValue is of type DiscreteDataType.

property fileDataValue¶: Property fileDataValue is of type FileDataType.

property floatFunctionalGriddedDataType¶: Property floatFunctionalGriddedDataType is of type FloatFunctionalGriddedDataType.

property floatFunctionalSeriesDataType¶: Property floatFunctionalSeriesDataType is of type FloatFunctionalSeriesDataType.

property hyperlinkDataValue¶: Property hyperlinkDataValue is of type HyperlinkDataType.

property integerDataValue¶: Property integerDataValue is of type IntegerDataType.

property logicalDataValue¶: Property logicalDataValue is of type LogicalDataType.

property longTextDataValue¶: Property longTextDataValue is of type LongTextDataType.

property pictureDataValue¶: Property pictureDataValue is of type PictureDataType.

property pointDataValue¶: Property pointDataValue is of type PointDataType.

property rangeDataValue¶: Property rangeDataValue is of type RangeDataType.

property shortTextDataValue¶: Property shortTextDataValue is of type ShortTextDataType.

property tabularDataValue¶: Property tabularDataValue is of type TabularDataType.

property c_obj¶: Pointer to the underlying C-object

ImportRecord¶

class ImportRecord(recordName=None, importAttributeValues=None, isFolder=None, importRecordMode=None, releaseRecord=None, subsetReferences=None, copyDestinationParent=None, existingRecord=None, updateSubsetsMode=None, _isOwner=True)¶

Bases: object

ImportRecord. A record for importing to the Granta MI database. The ‘importRecordMode’ property specifies whether a record should be created, copied, or updated. The accepted values are ‘Create’, ‘Update’, and ‘Copy’. If importRecordMode is ‘Create’, set ‘existingRecord’ to the parent record under which the new record is to be created. If importRecordMode is ‘Update’, set ‘existingRecord’, to the target record to be changed. If importRecordMode is ‘Copy’, set ‘existingRecord’ to be the source data for the operation, and use ‘copyDestinationParent’ to specify where the record copy should appear. For versioned databases, set releaseRecord to specify whether the new or updated record should be released. Use ‘subsetReferences’ to define the Subsets the imported record belongs to (subsets will not be inherited from the parent). ‘isFolder’ will have no effect if ‘importRecordMode’ is set to ‘Update’.

Parameters

recordName – type str
importAttributeValues – type list of ImportAttributeValue objects
isFolder – type bool
importRecordMode – type str
releaseRecord – type bool
subsetReferences – type list of SubsetReference objects
copyDestinationParent – type RecordReference
existingRecord – type RecordReference
updateSubsetsMode – type int

property importAttributeValues¶: Property importAttributeValues is a list of ImportAttributeValue objects. Warning: Do not attempt to edit or append to the returned value.

property subsetReferences¶: Property subsetReferences is a list of SubsetReference objects. Warning: Do not attempt to edit or append to the returned value.

property recordName¶: Property recordName is of type str.

property copyDestinationParent¶: Property copyDestinationParent is of type RecordReference.

property existingRecord¶: Property existingRecord is of type RecordReference.

property importRecordMode¶: Property importRecordMode is of type str. See GRANTA_Constants.ImportTypes for supported values.

property isFolder¶: Property isFolder is of type bool.

property releaseRecord¶: Property releaseRecord is of type bool.

property updateSubsetsMode¶: Property updateSubsetsMode is of type int.

AddImportAttributeValue(_importAttributeValue)¶

Appends _importAttributeValue to importAttributeValues property on ImportRecord C-object.

Parameters: _importAttributeValue – object of type ImportAttributeValue.

AddSubsetReference(_subsetReference)¶

Appends _subsetReference to subsetReferences property on ImportRecord C-object.

Parameters: _subsetReference – object of type SubsetReference.

property c_obj¶: Pointer to the underlying C-object

IntegerDataType¶

class IntegerDataType(value=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

IntegerDataType. A type to contain an integer data type.

Parameters

value – type int
isApplicable – type bool

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type int.

property c_obj¶: Pointer to the underlying C-object

IntegrationDatabase¶

class IntegrationDatabase(DBKey=None, author=None, company=None, volumeName=None, integrationTables=None, _isOwner=True)¶

Bases: object

IntegrationDatabase. Represents a database within an Integration Profile.

Parameters

DBKey – type str
author – type str
company – type str
volumeName – type str
integrationTables – type list of TableDetail objects

property author¶: Property author is of type str.

property company¶: Property company is of type str.

property DBKey¶: Property DBKey is of type str.

property integrationTables¶: Property integrationTables is a TableDetail objects. Warning: Do not attempt to edit or append to the returned value.

property volumeName¶: Property volumeName is of type str.

property c_obj¶: Pointer to the underlying C-object

IntegrationProfileDetail¶

class IntegrationProfileDetail(description=None, groupName=None, integrationDatabases=None, name=None, profile=None, _isOwner=True)¶

Bases: object

IntegrationProfileDetail. Detailed information about an Integration Profile.

Parameters

description – type RichText
groupName – type str
integrationDatabases – type list of IntegrationDatabase objects
name – type str
profile – type IntegrationProfileReference

property description¶: Property description is of type RichText.

property groupName¶: Property groupName is of type str.

property integrationDatabases¶: Property integrationDatabases is a IntegrationDatabase objects. Warning: Do not attempt to edit or append to the returned value.

property name¶: Property name is of type str.

property profile¶: Property profile is of type IntegrationProfileReference.

property c_obj¶: Pointer to the underlying C-object

IntegrationProfileReference¶

class IntegrationProfileReference(key=None, _isOwner=True)¶

Bases: object

IntegrationProfileReference. Contains the key for an Integration Profile.

Parameters: key – type str

property key¶: Property key is of type str.

property c_obj¶: Pointer to the underlying C-object

LayoutDetail¶

class LayoutDetail(attributeCategories=None, layout=None, name=None, table=None, _isOwner=True)¶

Bases: object

LayoutDetail. Detailed meta-information about a Layout in a Granta MI database.

Parameters

attributeCategories – type list of AttributeCategory objects
layout – type LayoutReference
name – type str
table – type TableReference

property attributeCategories¶: Property attributeCategories is a list of AttributeCategory objects. Warning: Do not attempt to edit or append to the returned value.

property layout¶: Property layout is of type LayoutReference.

property name¶: Property name is of type str.

property table¶: Property table is of type TableReference.

AddAttributeCategory(_attributeCategory)¶

Appends _attributeCategory to attributeCategories property on LayoutDetail C-object.

Parameters: _attributeCategory – object of type AttributeCategory.

property c_obj¶: Pointer to the underlying C-object

LayoutReference¶

class LayoutReference(DBKey=None, layoutIdentity=None, name=None, partialTableReference=None, _isOwner=True)¶

Bases: object

LayoutReference. A type that allows identification of a particular Layout in a Granta MI database.

Parameters

DBKey – type str
layoutIdentity – type int
name – type str
partialTableReference – type PartialTableReference

property DBKey¶: Property DBKey is of type str.

property layoutIdentity¶: Property layoutIdentity is of type int.

property name¶: Property name is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference.

property c_obj¶: Pointer to the underlying C-object

LessThanSearchValue¶

class LessThanSearchValue(unit=None, value=None, tabularColumn=None, _isOwner=True)¶

Bases: object

LessThanSearchValue. Search criterion to search for data less than a specified value. Criterion passes if data value is less than a given value. Point, range, and integer attributes are supported.

Parameters

unit – type str
value – type float
tabularColumn – type str

property tabularColumn¶: Property tabularColumn is of type str.

property unit¶: Property unit is of type str.

property value¶: Property value is of type float.

property c_obj¶: Pointer to the underlying C-object

LinkAllCombinations¶

class LinkAllCombinations(sourceRecords=None, nodeName=None, targetRecords=None, _isOwner=True)¶

Bases: object

LinkAllCombinations. For each given source record, add links to all the given target records. Silently skip any links that already exist.

Parameters

sourceRecords – type list of RecordReference objects
nodeName – type str
targetRecords – type list of RecordReference objects

property sourceRecords¶: Property sourceRecords is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property targetRecords¶: Property targetRecords is of type list of RecordReference.

property nodeName¶: Property nodeName is of type str.

AddSourceRecord(_recordReference)¶

Appends _recordReference to sourceRecords property on LinkAllCombinations C-object.

Parameters: _recordReference – object of type RecordReference.

AddTargetRecord(_recordReference)¶

Appends _recordReference to targetRecords property on LinkAllCombinations C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

LinkRecords¶

class LinkRecords(sourceRecords=None, nodeName=None, _isOwner=True)¶

Bases: object

LinkRecords. For each given source record, add links to the target records specified for that source record. Silently skip any links that already exist.

Parameters

sourceRecords – type list of NotatedTargetedSourceRecord objects
nodeName – type str

property sourceRecords¶: Property sourceRecords is of type list of NotatedTargetedSourceRecord.

property nodeName¶: Property nodeName is of type str.

AddSourceRecord(_notatedTargetedSourceRecord)¶

Appends _notatedTargetedSourceRecord to sourceRecords property on LinkRecords C-object.

Parameters: _notatedTargetedSourceRecord – object of type NotatedTargetedSourceRecord.

property c_obj¶: Pointer to the underlying C-object

LinkedRecordsDataType¶

class LinkedRecordsDataType(typeString=None, recordLinkGroups=None, nodeName=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

LinkedRecordsDataType. A type representing a list of linked Records.

Parameters

typeString – type str
recordLinkGroups – type list of RecordLinkGroup objects
nodeName – type str

property nodeName¶: Property nodeName is of type str.

property recordLinkGroups¶: Property recordLinkGroups is a list of RecordLinkGroup objects. Warning: Do not attempt to edit or append to the returned value.

property typeString¶: Property typeString is of type str.

property c_obj¶: Pointer to the underlying C-object

ListDataType¶

class ListDataType(items=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

ListDataType. A list of values within a Cell in Tabular Data.

Parameters: items – type list of ListItem objects

property items¶: Property items is a ListItem objects. Warning: Do not attempt to edit or append to the returned value.

property c_obj¶: Pointer to the underlying C-object

ListItem¶

class ListItem(rangeDataValue=None, shortTextDataValue=None, hyperlinkDataValue=None, fileDataValue=None, discreteDataValue=None, dataType=None, logicalDataValue=None, integerDataValue=None, pointDataValue=None, longTextDataValue=None, dateDataValue=None, pictureDataValue=None, sourceRecordHistoryId=None, _isOwner=True)¶

Bases: object

ListItem. An item in a List data value.

Parameters

rangeDataValue – type RangeDataType
shortTextDataValue – type ShortTextDataType
hyperlinkDataValue – type HyperlinkDataType
fileDataValue – type FileDataType
discreteDataValue – type DiscreteDataType
dataType – type str
logicalDataValue – type LogicalDataType
integerDataValue – type IntegerDataType
pointDataValue – type PointDataType
longTextDataValue – type LongTextDataType
dateDataValue – type DateDataType
pictureDataValue – type PictureDataType
sourceRecordHistoryId – type int

property dataType¶: Property dataType is of type str.

property dateDataValue¶: Property dateDataValue is of type DateDataType.

property discreteDataValue¶: Property discreteDataValue is of type DiscreteDataType.

property fileDataValue¶: Property fileDataValue is of type FileDataType.

property hyperlinkDataValue¶: Property hyperlinkDataValue is of type HyperlinkDataType.

property integerDataValue¶: Property integerDataValue is of type IntegerDataType.

property logicalDataValue¶: Property logicalDataValue is of type LogicalDataType.

property longTextDataValue¶: Property longTextDataValue is of type LongTextDataType.

property pictureDataValue¶: Property pictureDataValue is of type PictureDataType.

property pointDataValue¶: Property pointDataValue is of type PointDataType.

property rangeDataValue¶: Property rangeDataValue is of type RangeDataType.

property shortTextDataValue¶: Property shortTextDataValue is of type ShortTextDataType.

property sourceRecordHistoryId¶: Property sourceRecordHistoryId is of type int.

property c_obj¶: Pointer to the underlying C-object

LogicalDataType¶

class LogicalDataType(value=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

LogicalDataType. A type to contain a logical data type.

Parameters

value – type bool
isApplicable – type bool

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type bool.

property c_obj¶: Pointer to the underlying C-object

LongTextDataType¶

class LongTextDataType(value=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

LongTextDataType. A type to contain a long text data type.

Parameters

value – type str
isApplicable – type bool

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

LookupValue¶

class LookupValue(attributeReference=None, attributeValue=None, _isOwner=True)¶

Bases: object

LookupValue. Object containing an AttributeValue and AttributeReference object that uniquely identify a record in a table.

Parameters

attributeReference – type AttributeReference
attributeValue – type str

property attributeReference¶: Property attributeReference is of type AttributeReference.

property attributeValue¶: Property attributeValue is of type str.

property c_obj¶: Pointer to the underlying C-object

LowEndSearchValue¶

class LowEndSearchValue(unit=None, value=None, _isOwner=True)¶

Bases: object

LowEndSearchValue. Lower limit for the BetweenSearchValue search criterion.

Parameters

unit – type str
value – type float

property unit¶: Property unit is of type str.

property value¶: Property value is of type float.

property c_obj¶: Pointer to the underlying C-object

MIDatabase¶

class MIDatabase(name=None, DBKey=None, _isOwner=True)¶

Bases: object

MIDatabase. Data regarding a Granta MI database. Contains a DBKey and a volume name.

Parameters

name – type str
DBKey – type str

property DBKey¶: Property DBKey is of type str.

property name¶: Property name is of type str.

property c_obj¶: Pointer to the underlying C-object

MIEntityReference¶

class MIEntityReference¶

Bases: object

A base type for types that identify entities in a Granta MI database. The details of how entities are identified differ between concrete sub-types.

You should not interact directly with this class.

GetDBKey()¶

WithDBKey(value)¶

MIEntityResolution¶

class MIEntityResolution(canWrite=None, entityReference=None, resolved=None, _isOwner=True)¶

Bases: object

MIEntityResolution. Represents whether the entity referred to by the reference property can actually be resolved to an MI entity, and if that entity can be resolved whether or not it is writable.

Parameters

canWrite – type int
entityReference – type RecordReference
resolved – type bool

class CanWrite¶

Bases: object

Yes = 0¶

No = 1¶

NotSupported = 2¶

property canWrite¶: Property canWrite is of type int.

property entityReference¶: Property entityReference is of type RecordReference.

property resolved¶: Property resolved is of type bool.

property c_obj¶: Pointer to the underlying C-object

MIParameterValue¶

class MIParameterValue(revisionInfo=None, value=None, valueName=None, _isOwner=True)¶

Bases: object

MIParameterValue. A named value of a Parameter in a Granta MI Database.

Parameters

revisionInfo – type RevisionInfo
value – type float
valueName – type str

property revisionInfo¶: Property revisionInfo is of type RevisionInfo.

property value¶: Property value is of type float.

property valueName¶: Property valueName is of type str.

property c_obj¶: Pointer to the underlying C-object

MISession¶

class MISession(url='', verbosity=1)¶

Bases: object

A connection to a Granta MI Server. Don’t create this class directly, instead see GRANTA_MISession

Parameters: url - url of your Granta MI Service Layer installation (*) –

ConnectionIsValid()¶: Returns a tuple of (bool, string). The first element is whether or not requests can succeed, and the second is a description of the outcome of the test.

TestConnection()¶: Raises an exception if a request to the Granta MI Service Layer does not respond or responds with an error.

UseAutoLogon()¶: If called, this session will use the Windows credentials of the current user to authenticate to the Granta MI Service Layer.

SetCredentials(domain, username, password)¶

Parameters

username - your Granta MI username (*) –
password - your Granta MI password (*) –
domain - your Granta MI user domain (*) –

SetAuthorization(auth)¶

Parameters: auth - MI Auth object to do the authorization (*) –

SetReceiveTimeout(timeout)¶

Sets time in milliseconds to wait for a response before timing out.

Parameters: timeout - timeout in milliseconds (*) –

property actAsReadUser¶: Property name is of type bool. If set to True, this session will perform operations as if it were a read user, even if the session authenticated as a higher privileged role.

MinMax¶

class MinMax(maxValue=None, minValue=None, units=None, _isOwner=True)¶

Bases: object

MinMax. The minimum and maximum data values for a specified numerical attribute, calculated from all records you have read permissions for in a database.

Parameters

maxValue – type MinMaxValue
minValue – type MinMaxValue
units – type str

property maxValue¶: Property maxValue is of type MinMaxValue.

property minValue¶: Property minValue is of type MinMaxValue.

property units¶: Property units is of type str.

property c_obj¶: Pointer to the underlying C-object

MinMaxValue¶

class MinMaxValue(dateTime=None, double=None, integer=None, type=None, _isOwner=True)¶

Bases: object

MinMaxValue. A type that represents the minimum or maximum data value for a numerical attribute in a database.

Parameters

dateTime – type str
double – type float
integer – type int
type – type int

class Type¶

Bases: object

ERROR = -1¶

DateType = 0¶

DoubleType = 1¶

IntegerType = 2¶

NotANumber = 3¶

property dateTime¶: Property dateTime is of type str.

property double¶: Property double is of type float.

property integer¶: Property integer is of type int.

property type¶: Property type is of type int.

property c_obj¶: Pointer to the underlying C-object

ModifyRecordLinksRequest¶

class ModifyRecordLinksRequest(recordLinkModifications=None, recordLinkCheckMode=None, importErrorMode=None, recordLinkGroupReference=None, _isOwner=True)¶

Bases: object

ModifyRecordLinksRequest. Input to the ModifyRecordLinks operation. Requires a RecordLinkGroupReference to the record link group you wish to modify and a RecordLinkModifications object, which contains the modifications you wish to make to the record link group. The ‘importErrorMode’ property defines how to handle errors which occur during linking and can take the following values: ‘FaultAndRollbackOnAnyError’, which stops the linking request when an error occurs and attempts to roll back to the state before the request was issued; or ‘LogAndContinueWherePossible’, which will log non-fatal errors and attempt to continue with the linking request. The ‘recordLinkCheckMode’ property defines how to check the status of existing links and takes the following values: ‘CheckOnlyForwardLinks’, which checks for link only in the forward direction and is quicker than checking both directions; or ‘CheckForwardAndReverseLinks’, which is slower but safer as it checks for both forward and backward links.

Parameters

recordLinkModifications – type RecordLinkModifications
recordLinkCheckMode – type str
importErrorMode – type str
recordLinkGroupReference – type RecordLinkGroupReference

property importErrorMode¶: Property importErrorMode is of type str. See GRANTA_Constants.ImportErrorMode for supported values.

property recordLinkCheckMode¶: Property recordLinkCheckMode is of type str. See GRANTA_Constants.RecordLinkCheckMode for supported values.

property recordLinkGroupReference¶: Property recordLinkGroupReference is of type RecordLinkGroupReference.

property recordLinkModifications¶: Property recordLinkModifications is of type RecordLinkModifications.

property c_obj¶: Pointer to the underlying C-object

ModifyRecordLinksResponse¶

class ModifyRecordLinksResponse(c_obj)¶

Bases: object

ModifyRecordLinksResponse. The response from a ModifyRecordLinks request.

Parameters: c_obj – ctypes.POINTER to a ModifyRecordLinksResponse object.

property recordLinkChanges¶: Property recordLinkChanges is of type RecordLinkChanges.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

NamedAttribute¶

class NamedAttribute(attribute=None, about=None, name=None, isMeta=None, _isOwner=True)¶

Bases: object

NamedAttribute. Name information about an Attribute in a Granta MI database.

Parameters

attribute – type AttributeReference
about – type NamedAttribute
name – type str
isMeta – type bool

property about¶: Property about is of type NamedAttribute. Only populated if ‘isMeta’ is True.

property attribute¶: Property attribute is of type AttributeReference.

property isMeta¶: Property isMeta is of type bool. If this is True, the ‘about’ property may have additional information about the related parent attribute.

property name¶: Property name is of type str.

property c_obj¶: Pointer to the underlying C-object

NamedLayout¶

class NamedLayout(layout=None, name=None, _isOwner=True)¶

Bases: object

NamedLayout. A layout in a Granta MI database.

Parameters

layout – type LayoutReference
name – type str

property layout¶: Property layout is of type LayoutReference.

property name¶: Property name is of type str.

property c_obj¶: Pointer to the underlying C-object

NamedRecord¶

class NamedRecord(recordReference=None, shortName=None, longName=None, _isOwner=True)¶

Bases: object

NamedRecord. A RecordReference with the short and long name of the record.

Parameters

recordReference – type RecordReference
shortName – type str
longName – type str

property longName¶: Property longName is of type str.

property recordReference¶: Property recordReference is of type RecordReference.

property shortName¶: Property shortName is of type str.

property c_obj¶: Pointer to the underlying C-object

NamedSubset¶

class NamedSubset(subset=None, name=None, _isOwner=True)¶

Bases: object

NamedSubset. A SubsetReference with the subset name.

Parameters

subset – type SubsetReference
name – type str

property name¶: Property name is of type str.

property subset¶: Property subset is of type SubsetReference.

property c_obj¶: Pointer to the underlying C-object

NamedTargetedSourceRecord¶

class NamedTargetedSourceRecord(record=None, targetRecords=None, _isOwner=True)¶

Bases: object

NamedTargetedSourceRecord. A named record used for modifying record links.

Parameters

record – type NamedRecord
targetRecords – type list of NamedRecord objects

property targetRecords¶: Property targetRecords is a list of NamedRecord objects. Warning: Do not attempt to edit or append to the returned value.

property record¶: Property record is of type NamedRecord.

AddTargetRecords(_namedRecord)¶

Appends _namedRecord to targetRecords property on NamedTargetedSourceRecord C-object.

Parameters: _namedRecord – object of type NamedRecord.

property c_obj¶: Pointer to the underlying C-object

NotatedTargetRecord¶

class NotatedTargetRecord(record=None, notes=None, reverseNotes=None, _isOwner=True)¶

Bases: object

NotatedTargetRecord. A RecordReference of the record you wish to link to and notes on the record link. Requires a RecordReference. Notes on the link and the reverse link are optional.

Parameters

record – type RecordReference
notes – type str
reverseNotes – type str

property notes¶: Property notes is of type str.

property record¶: Property record is of type RecordReference.

property reverseNotes¶: Property reverseNotes is of type str.

property c_obj¶: Pointer to the underlying C-object

NotatedTargetedSourceRecord¶

class NotatedTargetedSourceRecord(sourceRecord=None, targetRecords=None, _isOwner=True)¶

Bases: object

NotatedTargetedSourceRecord. A NamedRecord to link from and container of NamedRecord of the records to link to. Requires a source NamedRecord. Can set zero to many target NamedRecord objects you wish to link to.

Parameters

sourceRecord – type RecordReference
targetRecords – type list of NotatedTargetRecord objects

property targetRecords¶: Property targetRecords is a list of NotatedTargetRecord objects. Warning: Do not attempt to edit or append to the returned value.

property sourceRecord¶: Property sourceRecord is of type RecordReference.

AddTargetRecord(_notatedTargetRecord)¶

Appends _notatedTargetRecord to targetRecords property on NotatedTargetedSourceRecord C-object.

Parameters: _notatedTargetRecord – object of type NotatedTargetRecord.

property c_obj¶: Pointer to the underlying C-object

OIDC¶

class OIDC(accessToken=None, refreshToken=None, authorizeTimeout=None)¶

Bases: object

An object to allow authorization using OpenID Connect. Contact Ansys Granta Technical Support for information on supported identity providers, and for configuration and setup documentation.

Pass to a GRANTA_MIScriptingToolkit.GRANTA_MISession and call Authorize() for a login page.

Parameters

accessToken – Valid access token for the URL of your MI Service Layer installation
refreshToken – Valid refresh token for the URL of your MI Service Layer installation
authorizeTimeout – Number of milliseconds to wait for a response after calling Authorize()

Authorize()¶: Authorize a Granta MI session with an OpenID Connect provider.

CheckAuthentication()¶: Checks whether your access and refresh tokens are valid, and returns the result.

TestAuthentication()¶: Checks whether your access and refresh tokens are valid, and displays an error message if the tokens are invalid.

property authorizeTimeout¶: Property authorizeTimeout is the time in milliseconds to wait for a response from the external browser when Authorize() is called.

property accessToken¶: Property accessToken is of type str.

property refreshToken¶: Property refreshToken is of type str.

ParameterDetail¶

class ParameterDetail(parameterType=None, appliesToAttribute=None, name=None, appliesToRecord=None, parameterValues=None, defaultValue=None, revisionInfo=None, interpolationType=None, parameterReference=None, order=None, unit=None, scaleType=None, _isOwner=True)¶

Bases: object

ParameterDetail. Detailed information about a Parameter in a Granta MI Database.

Parameters

parameterType – type int
appliesToAttribute – type AttributeReference
name – type str
appliesToRecord – type RecordReference
parameterValues – type list of MIParameterValue objects
defaultValue – type MIParameterValue
revisionInfo – type RevisionInfo
interpolationType – type int
parameterReference – type ParameterReference
order – type int
unit – type UnitInformation
scaleType – type int

class Interpolation¶

Bases: object

NONE = 0¶

Linear = 1¶

CubicSpline = 2¶

class ScaleType¶

Bases: object

NotSet = 0¶

Linear = 1¶

Log = 2¶

class ParameterType¶

Bases: object

NumericUnrestricted = 0¶

NumericRestricted = 1¶

Discrete = 2¶

property appliesToAttribute¶: Property appliesToAttribute is of type AttributeReference.

property appliesToRecord¶: Property appliesToRecord is of type RecordReference.

property defaultValue¶: Property defaultValue is of type MIParameterValue.

property interpolationType¶: Property interpolationType is of type int. See ParameterDetail.Interpolation for supported values.

property name¶: Property name is of type str.

property parameterValues¶: Property parameterValues is a list of MIParameterValue objects. Warning: Do not attempt to edit or append to the returned value.

property order¶: Property order is of type int.

property parameterReference¶: Property parameterReference is of type ParameterReference.

property parameterType¶: Property parameterType is of type int. See ParameterDetail.ParameterType for supported values.

property revisionInfo¶: Property revisionInfo is of type RevisionInfo.

property scaleType¶: Property scaleType is of type int. See ParameterDetail.ScaleType for supported values.

property unit¶: Property unit is of type UnitInformation.

property c_obj¶: Pointer to the underlying C-object

ParameterDomain¶

class ParameterDomain(exporterParameterId=None, interpolable=None, values=None, _isOwner=True)¶

Bases: object

ParameterDomain. A type to contain a list of parameter values.

Parameters

exporterParameterId – type str
interpolable – type bool
values – type list of ParameterValue objects

property exporterParameterId¶: Property exporterParameterId is of type str.

property interpolable¶: Property interpolable is of type bool.

property values¶: Property values is a list of ParameterValue objects. Warning: Do not attempt to edit or append to the returned value.

property c_obj¶: Pointer to the underlying C-object

ParameterInformation¶

class ParameterInformation(parameterReference=None, name=None, unit=None, _isOwner=True)¶

Bases: object

ParameterInformation. Information for a parameter in a Granta MI database. Contains the name and unit information for a parameter and a ParameterReference to the parameter.

Parameters

parameterReference – type ParameterReference
name – type str
unit – type UnitInformation

property name¶: Property name is of type str.

property parameterReference¶: Property parameterReference is of type ParameterReference.

property unit¶: Property unit is of type UnitInformation.

property c_obj¶: Pointer to the underlying C-object

ParameterReference¶

class ParameterReference(name=None, DBKey=None, ID=None, _isOwner=True)¶

Bases: object

ParameterReference. Identification of a particular parameter in a Granta MI database . For requests a DBKey is required, and either the parameter ID or the parameter name.

Parameters

name – type str
DBKey – type str
ID – type int

property DBKey¶: Property DBKey is of type str.

property ID¶: Property ID is of type int.

property name¶: Property name is of type str.

property c_obj¶: Pointer to the underlying C-object

ParameterReferenceAndValue¶

class ParameterReferenceAndValue(parameterValue=None, parameter=None, _isOwner=True)¶

Bases: object

ParameterReferenceAndValue. Contains a ParameterReference and a ParameterValue.

Parameters

parameterValue – type ParameterValue
parameter – type ParameterReference

property parameter¶: Property parameter is of type ParameterReference.

property parameterValue¶: Property parameterValue is of type ParameterValue.

property c_obj¶: Pointer to the underlying C-object

ParameterReferencesAndValues¶

class ParameterReferencesAndValues(parameterWithValues=None, _isOwner=True)¶

Bases: object

ParameterReferencesAndValues. A collection of ParameterReferenceAndValue objects.

Parameters: parameterWithValues – type list of ParameterReferenceAndValue objects

property parameterWithValues¶: Property parameterWithValues is a list of ParameterReferenceAndValue objects. Warning: Do not attempt to edit or append to the returned value.

AddParameterWithValue(_parameterReferenceAndValue)¶

Appends _parameterReferenceAndValue to parameterWithValues property on ParameterReferencesAndValues C-object.

Parameters: _parameterReferenceAndValue – object of type ParameterReferenceAndValue.

property c_obj¶: Pointer to the underlying C-object

ParameterValue¶

class ParameterValue(numericValue=None, type=None, discreteValue=None, _isOwner=True)¶

Bases: object

ParameterValue. A value of a Parameter in Functional data.

Parameters

numericValue – type float
type – type str
discreteValue – type str

property discreteValue¶: Property discreteValue is of type str.

property numericValue¶: Property numericValue is of type float.

property type¶: Property type is of type str. See GRANTA_Constants.ParameterTypes for supported values. There is no need to set this property manually.

property c_obj¶: Pointer to the underlying C-object

Parameters¶

class Parameters(parameters=None, _isOwner=True)¶

Bases: object

Parameters. A collection of ParameterInformation objects.

Parameters: parameters – type list of ParameterInformation objects

property parameters¶: Property parameters is a list of ParameterInformation objects. Warning: Do not attempt to edit or append to the returned value.

AddParameter(_parameterInformation)¶

Appends _parameterInformation to parameters property on Parameters C-object.

Parameters: _parameterInformation – object of type ParameterInformation.

property c_obj¶: Pointer to the underlying C-object

PartialTableReference¶

class PartialTableReference(tableName=None, tableGUID=None, tableID=None, _isOwner=True)¶

Bases: object

PartialTableReference. A reference to a Granta MI table. Usually, just one of the several optional fields should be provided; where more than one is provided, the highest priority one is used, where the descending priority order is: tableIdentity, tableGUID, tableName.

Parameters

tableName – type str
tableGUID – type str
tableID – type int

property tableGUID¶: Property tableGUID is of type str.

property tableID¶: Property tableID is of type int.

property tableName¶: Property tableName is of type str.

property c_obj¶: Pointer to the underlying C-object

PathLeaf¶

class PathLeaf(longName=None, recordReference=None, shortName=None, _isOwner=True)¶

Bases: object

PathLeaf. The folder furthest from the root record folder, for each path checked or created.

Parameters

longName – type str
recordReference – type RecordReference
shortName – type str

property longName¶: Property longName is of type str.

property recordReference¶: Property recordReference is of type RecordReference.

property shortName¶: Property shortName is of type str.

property c_obj¶: Pointer to the underlying C-object

PictureDataType¶

class PictureDataType(URL=None, contentType=None, data=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

PictureDataType. A type representing a piece of Picture data in a Granta MI Database. To get a byte-array representing the binary data, call ReadBinaryData(). To set the binary data (as part of a data import), use ModifyBinaryData().

Parameters

URL – type str
contentType – type str
data – type str
isApplicable – type bool

ModifyBinaryData(binaryData)¶: len -

ReadBinaryData()¶

property contentType¶: Property contentType is of type str.

property data¶: Property data is of type str.

property isApplicable¶: Property isApplicable is of type bool.

property URL¶: Property URL is of type str.

property c_obj¶: Pointer to the underlying C-object

PointDataType¶

class PointDataType(unitSymbol=None, points=None, parameters=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

PointDataType. A type to contain an array of float data types.

Parameters

unitSymbol – type str
points – type list of PointValueWithParameters objects
parameters – type Parameters
isApplicable – type bool

property points¶: Property points is a list of PointValueWithParameters objects. Warning: Do not attempt to edit or append to the returned value.

property isApplicable¶: Property isApplicable is of type bool.

property parameters¶: Property parameters is of type Parameters.

property unitSymbol¶: Property unitSymbol is of type str.

AddPoint(_pointValueWithParameters)¶

Appends _pointValueWithParameters to points property on PointDataType C-object.

Parameters: _pointValueWithParameters – object of type PointValueWithParameters.

property c_obj¶: Pointer to the underlying C-object

PointValueWithParameters¶

class PointValueWithParameters(valueParameters=None, value=None, _isOwner=True)¶

Bases: object

PointValueWithParameters. A numeric value with associated ParameterReferencesAndValues object.

Parameters

valueParameters – type ParameterReferencesAndValues
value – type float

property value¶: Property value is of type float.

property valueParameters¶: Property valueParameters is of type ParameterReferencesAndValues.

property c_obj¶: Pointer to the underlying C-object

RangeDataType¶

class RangeDataType(hasLow=None, high=None, unitSymbol=None, hasHigh=None, low=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

RangeDataType. Type for values of range data. Both LowValue and HighValue must be populated.

Parameters

hasLow – type bool
high – type float
unitSymbol – type str
hasHigh – type bool
low – type float
isApplicable – type bool

property hasHigh¶: Property hasHigh is of type bool.

property hasLow¶: Property hasLow is of type bool.

property high¶: Property high is of type float.

property isApplicable¶: Property isApplicable is of type bool.

property low¶: Property low is of type float.

property unitSymbol¶: Property unitSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

RasterSize¶

class RasterSize(heightPixels=None, widthPixels=None, _isOwner=True)¶

Bases: object

RasterSize. Gives the size in pixels of picture data.

Parameters

heightPixels – type int
widthPixels – type int

property heightPixels¶: Property heightPixels is of type int.

property widthPixels¶: Property widthPixels is of type int.

property c_obj¶: Pointer to the underlying C-object

RecordAttribute¶

class RecordAttribute(dataVersionNumber=None, attribute=None, dataCreatedRecordVersion=None, recordReference=None, hasData=None, dataRetiredRecordVersion=None, parameterDetails=None, dataRevisionInfo=None, _isOwner=True)¶

Bases: object

RecordAttribute. Meta-information about the data of a particular attribute of a particular Record in a Granta MI database Does NOT include values of the data (see AttributeValue type).

Parameters

dataVersionNumber – type int
attribute – type NamedAttribute
dataCreatedRecordVersion – type int
recordReference – type RecordReference
hasData – type bool
dataRetiredRecordVersion – type int
parameterDetails – type list of ParameterDetail objects
dataRevisionInfo – type RevisionInfo

property attribute¶: Property attribute is of type NamedAttribute.

property dataCreatedRecordVersion¶: Property dataCreatedRecordVersion is of type int.

property dataRetiredRecordVersion¶: Property dataRetiredRecordVersion is of type int.

property dataRevisionInfo¶: Property dataRevisionInfo is of type RevisionInfo.

property dataVersionNumber¶: Property dataVersionNumber is of type int.

property hasData¶: Property hasData is of type bool.

property parameterDetails¶: Property parameterDetails is a list of ParameterDetail objects. Warning: Do not attempt to edit or append to the returned value.

property recordReference¶: Property recordReference is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

RecordData¶

class RecordData(recordReference=None, attributeValues=None, _isOwner=True)¶

Bases: object

RecordData. The values of data for attribute(s) of a particular record.

Parameters

recordReference – type RecordReference
attributeValues – type list of AttributeValue objects

property attributeValues¶: Property attributeValues is a AttributeValue objects. Warning: Do not attempt to edit or append to the returned value.

property recordReference¶: Property recordReference is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

RecordExporterParameters¶

class RecordExporterParameters(record=None, attributes=None, _isOwner=True)¶

Bases: object

RecordExporterParameters. A type to contain a record and its associated attribute exporter parameters.

Parameters

record – type RecordReference
attributes – type list of AttributeExporterParameters objects

property attributes¶: Property attributes is a AttributeExporterParameters objects. Warning: Do not attempt to edit or append to the returned value.

property record¶: Property record is of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

RecordFilter¶

class RecordFilter(profile=None, subsets=None, _isOwner=True)¶

Bases: object

RecordFilter. A type allowing lists of Records to be filtered, e.g., by membership of Subset(s). You should specify either a profile or a subset reference, but not both. You can pass in a list containing an uninitialized SubsetReference to effectively disable the subset filter. Note that subsets are not inherited; newly-created records will not be filtered until they are added to a Subset.

Parameters

profile – type str
subsets – type list of SubsetReference objects

property subsets¶: Property subsets is of type list of SubsetReference.

property profile¶: Property profile is of type str.

AddSubset(_subsetReference)¶

Appends _subsetReference to subsets property on RecordFilter C-object.

Parameters: _subsetReference – object of type SubsetReference.

property c_obj¶: Pointer to the underlying C-object

RecordFolderPath¶

class RecordFolderPath(color=None, recordReference=None, treeNames=None, _isOwner=True)¶

Bases: object

RecordFolderPath. The path to a Granta MI record folder. Contains the record folder at which the path starts as parent, the tree names, and the color.

Parameters

color – type str
recordReference – type RecordReference
treeNames – type list of str objects

property treeNames¶: Property treeNames is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property color¶: Property color is of type str.

property recordReference¶: Property recordReference is of type RecordReference.

AddTreeName(value)¶

Appends value to treeNames property on RecordFolderPath C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

RecordLinkChanges¶

class RecordLinkChanges(unlinked=None, linked=None, _isOwner=True)¶

Bases: object

RecordLinkChanges. A set of changes to be made to record link groups

Parameters

unlinked – type list of NamedTargetedSourceRecord objects
linked – type list of NamedTargetedSourceRecord objects

property linked¶: Property linked is a NamedTargetedSourceRecord objects. Warning: Do not attempt to edit or append to the returned value.

property unlinked¶: Property unlinked is a list of NamedTargetedSourceRecord objects. Warning: Do not attempt to edit or append to the returned value.

property c_obj¶: Pointer to the underlying C-object

RecordLinkGroup¶

class RecordLinkGroup(standardNames=None, tableFilters=None, name=None, linkedRecords=None, _isOwner=True)¶

Bases: object

RecordLinkGroup. A type representing a group of linked records.

Parameters

standardNames – type list of str objects
tableFilters – type list of int objects
name – type str
linkedRecords – type list of NamedRecord objects

property linkedRecords¶: Property linkedRecords is a NamedRecord objects. Warning: Do not attempt to edit or append to the returned value.

property name¶: Property name is of type str.

property standardNames¶: Property standardNames is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property tableFilters¶: Property tableFilters is a list of int objects. See GRANTA_Constants.TablesFilter for supported values. Warning: Do not attempt to edit or append to the returned value.

property c_obj¶: Pointer to the underlying C-object

RecordLinkGroupDetail¶

class RecordLinkGroupDetail(name=None, reference=None, standardNames=None, reverseReference=None, linkGroupType=None, fromTable=None, toTable=None, reverseName=None, _isOwner=True)¶

Bases: object

RecordLinkGroupDetail. Detailed information about a Record Link Group in a Granta MI Database.

Parameters

name – type str
reference – type RecordLinkGroupReference
standardNames – type list of str objects
reverseReference – type RecordLinkGroupReference
linkGroupType – type str
fromTable – type TableReference
toTable – type TableReference
reverseName – type str

property fromTable¶: Property fromTable is of type TableReference.

property linkGroupType¶: Property linkGroupType is of type str. See GRANTA_Constants.RecordLinkGroupTypes for supported values.

property name¶: Property name is of type str.

property standardNames¶: Property standardNames is a list of str objects. Warning: Do not attempt to edit or append to the returned value.

property reference¶: Property reference is of type RecordLinkGroupReference.

property reverseName¶: Property reverseName is of type str.

property reverseReference¶: Property reverseReference is of type RecordLinkGroupReference.

property toTable¶: Property toTable is of type TableReference.

property c_obj¶: Pointer to the underlying C-object

RecordLinkGroupReference¶

class RecordLinkGroupReference(isStandardName=None, name=None, partialTableReference=None, DBKey=None, recordLinkGroupIdentity=None, recordLinkGroupType=None, _isOwner=True)¶

Bases: object

RecordLinkGroupReference. A type that allows identification of a particular record link group in a Granta MI database. This may be done by specifying the identity of the group, or its name and a partial table reference.

Parameters

isStandardName – type bool
name – type str
partialTableReference – type PartialTableReference
DBKey – type str
recordLinkGroupIdentity – type int
recordLinkGroupType – type str

property DBKey¶: Property DBKey is of type str.

property isStandardName¶: Property isStandardName is of type bool.

property name¶: Property name is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference.

property recordLinkGroupIdentity¶: Property recordLinkGroupIdentity is of type int.

property recordLinkGroupType¶: Property recordLinkGroupType is of type str. See GRANTA_Constants.RecordLinkGroupTypes for supported values.

property c_obj¶: Pointer to the underlying C-object

RecordLinkModifications¶

class RecordLinkModifications(unlinkRecords=None, linkAllCombinations=None, unlinkAllRecords=None, linkRecords=None, _isOwner=True)¶

Bases: object

RecordLinkModifications. A set of modifications to be made to record link groups

Parameters

unlinkRecords – type list of UnlinkRecords objects
linkAllCombinations – type list of LinkAllCombinations objects
unlinkAllRecords – type list of UnlinkAllRecords objects
linkRecords – type list of LinkRecords objects

property linkAllCombinations¶: Property linkAllCombinations is a list of LinkAllCombinations objects. Warning: Do not attempt to edit or append to the returned value.

property linkRecords¶: Property linkRecords is a list of LinkRecords objects. Warning: Do not attempt to edit or append to the returned value.

property unlinkAllRecords¶: Property unlinkAllRecords is a list of UnlinkAllRecords objects. Warning: Do not attempt to edit or append to the returned value.

property unlinkRecords¶: Property unlinkRecords is a list of UnlinkRecords objects. Warning: Do not attempt to edit or append to the returned value.

AddLinkAllCombinations(_linkAllCombinations)¶

Appends _linkAllCombinations to linkAllCombinations property on RecordLinkModifications C-object.

Parameters: _linkAllCombinations – object of type LinkAllCombinations.

AddLinkRecords(_linkRecords)¶

Appends _linkRecords to linkRecords property on RecordLinkModifications C-object.

Parameters: _linkRecords – object of type LinkRecords.

AddUnlinkAllRecords(_unlinkAllRecords)¶

Appends _unlinkAllRecords to unlinkAllRecords property on RecordLinkModifications C-object.

Parameters: _unlinkAllRecords – object of type UnlinkAllRecords.

AddUnlinkRecords(_unlinkRecords)¶

Appends _unlinkRecords to unlinkRecords property on RecordLinkModifications C-object.

Parameters: _unlinkRecords – object of type UnlinkRecords.

property c_obj¶: Pointer to the underlying C-object

RecordNameSearchRequest¶

class RecordNameSearchRequest(searchFullNames=None, recordName=None, caseSensitiveNames=None, filter=None, populateGUIDs=None, searchShortNames=None, table=None, _isOwner=True)¶

Bases: object

RecordNameSearchRequest. The input for the RecordNameSearch operation. Both the table and recordName are required.

Parameters

searchFullNames – type bool
recordName – type str
caseSensitiveNames – type bool
filter – type RecordFilter
populateGUIDs – type bool
searchShortNames – type bool
table – type TableReference

property caseSensitiveNames¶: Property caseSensitiveNames is of type bool.

property filter¶: Property filter is of type RecordFilter.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property recordName¶: Property recordName is of type str.

property searchFullNames¶: Property searchFullNames is of type bool.

property searchShortNames¶: Property searchShortNames is of type bool.

property table¶: Property table is of type TableReference.

property c_obj¶: Pointer to the underlying C-object

RecordReference¶

class RecordReference(DBKey=None, historyGUID=None, recordGUID=None, identity=None, version=None, lookupValue=None, _isOwner=True)¶

Bases: object

RecordReference. A type that allows identification of a particular record in a Granta MI database. This is done directly by specifying the Identity or GUID of the record.

Parameters

DBKey – type str
historyGUID – type str
recordGUID – type str
identity – type int
version – type int
lookupValue – type LookupValue

property DBKey¶: Property DBKey is of type str.

property historyGUID¶: Property historyGUID is of type str.

property identity¶: Property identity is of type int.

property lookupValue¶: Property lookupValue is of type LookupValue.

property recordGUID¶: Property recordGUID is of type str.

property version¶: Property version is of type int.

property c_obj¶: Pointer to the underlying C-object

RecordSearchCriterion¶

class RecordSearchCriterion(containsAnySearchValue=None, containsAllSearchValue=None, betweenSearchValue=None, lessThanSearchValue=None, type=None, betweenDateTimesSearchValue=None, searchAttribute=None, greaterThanSearchValue=None, exactlySearchValue=None, doesNotExistSearchValue=None, existsSearchValue=None, doesNotContainSearchValue=None, containsSearchValue=None, _isOwner=True)¶

Bases: object

RecordSearchCriterion. One criterion that controls results returned from a search. A search comprises one or more such criteria.

Parameters

containsAnySearchValue – type ContainsAnySearchValue
containsAllSearchValue – type ContainsAllSearchValue
betweenSearchValue – type BetweenSearchValue
lessThanSearchValue – type LessThanSearchValue
type – type str
betweenDateTimesSearchValue – type BetweenDateTimesSearchValue
searchAttribute – type AttributeReference
greaterThanSearchValue – type GreaterThanSearchValue
exactlySearchValue – type ExactlySearchValue
doesNotExistSearchValue – type DoesNotExistSearchValue
existsSearchValue – type ExistsSearchValue
doesNotContainSearchValue – type DoesNotContainSearchValue
containsSearchValue – type ContainsSearchValue

property betweenDateTimesSearchValue¶: Property betweenDateTimesSearchValue is of type BetweenDateTimesSearchValue.

property betweenSearchValue¶: Property betweenSearchValue is of type BetweenSearchValue.

property containsAllSearchValue¶: Property containsAllSearchValue is of type ContainsAllSearchValue.

property containsAnySearchValue¶: Property containsAnySearchValue is of type ContainsAnySearchValue.

property containsSearchValue¶: Property containsSearchValue is of type ContainsSearchValue.

property doesNotContainSearchValue¶: Property doesNotContainSearchValue is of type DoesNotContainSearchValue.

property doesNotExistSearchValue¶: Property doesNotExistSearchValue is of type DoesNotExistSearchValue.

property exactlySearchValue¶: Property exactlySearchValue is of type ExactlySearchValue.

property existsSearchValue¶: Property existsSearchValue is of type ExistsSearchValue.

property greaterThanSearchValue¶: Property greaterThanSearchValue is of type GreaterThanSearchValue.

property lessThanSearchValue¶: Property lessThanSearchValue is of type LessThanSearchValue.

property searchAttribute¶: Property searchAttribute is of type AttributeReference.

property type¶: Property type is of type str.

property c_obj¶: Pointer to the underlying C-object

RecordVersionState¶

class RecordVersionState(recordReference=None, versionState=None, _isOwner=True)¶

Bases: object

RecordVersionState. The version status of a particular Record in a Granta MI database.

Parameters

recordReference – type RecordReference
versionState – type int

class VersionState¶

Bases: object

Released = 0¶

Superseded = 1¶

Withdrawn = 2¶

Unreleased = 3¶

Unversioned = 4¶

Unknown = 5¶

property recordReference¶: Property recordReference is of type RecordReference.

property versionState¶: Property versionState is of type int. See RecordVersionState.VersionState for supported values.

property c_obj¶: Pointer to the underlying C-object

RecordWithAttributeAddresses¶

class RecordWithAttributeAddresses(recordReference=None, attributeAddresses=None, _isOwner=True)¶

Bases: object

RecordWithAttributeAddresses. A RecordReference with a list of attributes and their upload URL addresses.

Parameters

recordReference – type RecordReference
attributeAddresses – type list of AttributeAddress objects

property attributeAddresses¶: Property attributeAddresses is a list of AttributeAddress objects. Warning: Do not attempt to edit or append to the returned value.

property recordReference¶: Property recordReference is of type RecordReference.

AddAttributeAddress(_attributeAddress)¶

Appends _attributeAddress to attributeAddresses property on RecordWithAttributeAddresses C-object.

Parameters: _attributeAddress – object of type AttributeAddress.

property c_obj¶: Pointer to the underlying C-object

ResolveReferencesRequest¶

class ResolveReferencesRequest(entities=None, _isOwner=True)¶

Bases: object

ResolveReferencesRequest. Input for the ResolveReferences operation.

Parameters: entities – type list of RecordReference objects

property entities¶: Property entities is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

AddEntitie(_recordReference)¶

Appends _recordReference to entities property on ResolveReferencesRequest C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

ResolveReferencesResponse¶

class ResolveReferencesResponse(c_obj)¶

Bases: object

ResolveReferencesResponse. Output from the ResolveReferences operation.

Parameters: c_obj – ctypes.POINTER to a ResolveReferencesResponse object.

property entityResolutions¶: Property entityResolutions is a MIEntityResolution objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

RevisionInfo¶

class RevisionInfo(modifiedUser=None, createdUser=None, updateCount=None, modified=None, created=None, _isOwner=True)¶

Bases: object

RevisionInfo. Describes when an entity in a Granta MI database was created and updated.

Parameters

modifiedUser – type str
createdUser – type str
updateCount – type int
modified – type str
created – type str

property created¶: Property created is of type str.

property createdUser¶: Property createdUser is of type str.

property modified¶: Property modified is of type str.

property modifiedUser¶: Property modifiedUser is of type str.

property updateCount¶: Property updateCount is of type int.

property c_obj¶: Pointer to the underlying C-object

RichText¶

class RichText(type=None, value=None, _isOwner=True)¶

Bases: object

RichText. Contains a piece of text and its type.

Parameters

type – type int
value – type str

class Type¶

Bases: object

Plain = 0¶

Markdown = 1¶

property type¶: Property type is of type int.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

SearchResult¶

class SearchResult(recordReference=None, ranking=None, shortName=None, longName=None, _isOwner=True)¶

Bases: object

SearchResult. An extension of NamedRecord with a ranking. The higher the ranking the better the match to your search criteria.

Parameters

recordReference – type RecordReference
ranking – type str
shortName – type str
longName – type str

property longName¶: Property longName is of type str.

property ranking¶: Property ranking is of type str.

property recordReference¶: Property recordReference is of type RecordReference.

property shortName¶: Property shortName is of type str.

property c_obj¶: Pointer to the underlying C-object

SearchService¶

class SearchService(mi_session)¶

Bases: GRANTA_MIScriptingToolkit.Service.Service

The Search service finds Records, within Granta MI Databases, matching specified criteria.

SimpleTextSearch(_req)¶

Searches for records matching simple text criteria.

Parameters: _req – SimpleTextSearch object
Returns: SimpleTextSearchResponse object

CriteriaSearch(_req)¶

Searches for records matching attribute-based criteria.

Parameters: _req – CriteriaSearch object
Returns: SimpleTextSearchResponse object

RecordNameSearch(_req)¶

Searches for Records with a given exact Record name.

Parameters: _req – RecordNameSearchRequest object
Returns: SimpleTextSearchResponse object

Series¶

class Series(XYPoints=None, decoration=None, constraints=None, _isOwner=True)¶

Bases: object

Series. Type for functional data which includes X-Y data and any constraints.

Parameters

XYPoints – type XYData
decoration – type int
constraints – type Constraints

property constraints¶: Property constraints is of type Constraints.

property decoration¶: Property decoration is of type int. See GRANTA_Constants.GraphDecoration for supported values.

property XYPoints¶: Property XYPoints is of type XYData.

property c_obj¶: Pointer to the underlying C-object

Service¶

class Service¶

Bases: object

Base class for Granta MI Service objects. For internal use only.

ServiceLayerResponse¶

class ServiceLayerResponse(errorMessage=None, requestMessage=None, responseMessage=None, responseCode=None, _isOwner=True)¶

Bases: object

ServiceLayerResponse. The HTTP response information from Granta MI Service Layer. Useful for debugging bad requests.

Parameters

errorMessage – type str
requestMessage – type str
responseMessage – type str
responseCode – type int

property errorMessage¶: Property errorMessage is of type str.

property requestMessage¶: Property requestMessage is of type str.

property responseCode¶: Property responseCode is of type int. This is an HTTP status code.

property responseMessage¶: Property responseMessage is of type str.

property c_obj¶: Pointer to the underlying C-object

SetRecordAttributesRequest¶

class SetRecordAttributesRequest(importRecords=None, importErrorMode=None, _isOwner=True)¶

Bases: object

SetRecordAttributesRequest. The input to a set record attributes operation. Includes an array of records to import.

Parameters

importRecords – type list of ImportRecord objects
importErrorMode – type str

property importRecords¶: Property importRecords is of type list of ImportRecord.

property importErrorMode¶: Property importErrorMode is of type str. See GRANTA_Constants.ImportErrorMode for supported values.

AddImportRecord(_importRecord)¶

Appends _importRecord to importRecords property on SetRecordAttributesRequest C-object.

Parameters: _importRecord – object of type ImportRecord.

property c_obj¶: Pointer to the underlying C-object

SetRecordAttributesResponse¶

class SetRecordAttributesResponse(c_obj)¶

Bases: object

SetRecordAttributesResponse. Response for set record attributes operation. Includes an array of import records.

Parameters: c_obj – ctypes.POINTER to a SetRecordAttributesResponse object.

property recordsImported¶: Property recordsImported is a list of NamedRecord objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

property c_obj¶: Pointer to the underlying C-object

ShortTextDataType¶

class ShortTextDataType(value=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

ShortTextDataType. Type for values of short text (string) data.

Parameters

value – type str
isApplicable – type bool

property isApplicable¶: Property isApplicable is of type bool.

property value¶: Property value is of type str.

property c_obj¶: Pointer to the underlying C-object

SimpleTextSearch¶

class SimpleTextSearch(recordFilter=None, searchFilter=None, restrictToTables=None, searchValue=None, DBKey=None, searchMode=None, populateGUIDs=None, _isOwner=True)¶

Bases: object

SimpleTextSearch. The input to a simple text search operation. Both the DBKey, and search value are required.

Parameters

recordFilter – type RecordFilter
searchFilter – type int
restrictToTables – type list of PartialTableReference objects
searchValue – type str
DBKey – type str
searchMode – type int
populateGUIDs – type bool

property restrictToTables¶: Property restrictToTables is a list of PartialTableReference objects. Warning: Do not attempt to edit or append to the returned value.

property DBKey¶: Property DBKey is of type str.

property populateGUIDs¶: Property populateGUIDs is of type bool.

property searchValue¶: Property searchValue is of type str.

property recordFilter¶: Property recordFilter is of type RecordFilter.

property searchFilter¶: Property searchFilter is of type int. See GRANTA_Constants.TablesFilter for supported values.

property searchMode¶: Property searchMode is of type int. See GRANTA_Constants.SearchMode for supported values.

AddRestrictToTable(_partialTableReference)¶

Appends _partialTableReference to restrictToTables property on SimpleTextSearch C-object.

Parameters: _partialTableReference – object of type PartialTableReference.

property c_obj¶: Pointer to the underlying C-object

SimpleTextSearchResponse¶

class SimpleTextSearchResponse(c_obj)¶

Bases: object

SimpleTextSearchResponse. The output to the simple text search operation. Contains a list of records returned by the search and a ServiceLayerResponse object.

Parameters: c_obj – ctypes.POINTER to a SimpleTextSearchResponse object.

property searchResults¶: Property searchResults is a list of SearchResult objects. Warning: Do not attempt to edit or append to the returned value.

property serviceLayerResponse¶: Property serviceLayerResponse is of type ServiceLayerResponse.

AddSearchResult(_searchResult)¶

Appends _searchResult to searchResults property on SimpleTextSearchResponse C-object.

Parameters: _searchResult – object of type SearchResult.

property c_obj¶: Pointer to the underlying C-object

SourceRecord¶

class SourceRecord(record=None, recordLinkGroups=None, _isOwner=True)¶

Bases: object

SourceRecord. A type that contains a record reference and associated record link groups.

Parameters

record – type RecordReference
recordLinkGroups – type LinkedRecordsDataType

property record¶: Property record is of type RecordReference.

property recordLinkGroups¶: Property recordLinkGroups is of type LinkedRecordsDataType.

property c_obj¶: Pointer to the underlying C-object

SourceUnitConversionSet¶

class SourceUnitConversionSet(sourceSymbol=None, conversions=None, _isOwner=True)¶

Bases: object

SourceUnitConversionSet. All the unit conversions available for a specified unit.

Parameters

sourceSymbol – type str
conversions – type list of UnitConversionTarget objects

property conversions¶: Property conversions is a UnitConversionTarget objects. Warning: Do not attempt to edit or append to the returned value.

property sourceSymbol¶: Property sourceSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

SpecificUnitConversionContext¶

class SpecificUnitConversionContext(absoluteUnits=None, currency=None, unitSymbol=None, _isOwner=True)¶

Bases: object

SpecificUnitConversionContext. Type defining how values with convertable units should be represented.

Parameters

absoluteUnits – type bool
currency – type str
unitSymbol – type str

property absoluteUnits¶: Property absoluteUnits is of type bool.

property currency¶: Property currency is of type str.

property unitSymbol¶: Property unitSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

StringUtils¶

class Defs¶

Bases: object

unicode_type¶: alias of str

bytes_type¶: alias of bytes

string_types = (<class 'str'>, <class 'bytes'>)¶

EnsureEncoded(param)¶

class StringUtils¶

Bases: object

StringUtils. Class for dealing with memory of C character data. For internal usage only.

delete(obj)¶

SubsetDetail¶

class SubsetDetail(subset=None, name=None, _isOwner=True)¶

Bases: object

SubsetDetail. Detailed meta-information about a subset in a Granta MI database.

Parameters

subset – type SubsetReference
name – type str

property name¶: Property name is of type str.

property subset¶: Property subset is of type SubsetReference.

property c_obj¶: Pointer to the underlying C-object

SubsetReference¶

class SubsetReference(subsetIdentity=None, name=None, DBKey=None, partialTableReference=None, _isOwner=True)¶

Bases: object

SubsetReference. A type that identifies a particular subset in a Granta MI database. This may be done by specifying the identity of the subset, or by specifying a name that will match (only) the subset along with the table to which the subset belongs.

Parameters

subsetIdentity – type int
name – type str
DBKey – type str
partialTableReference – type PartialTableReference

property DBKey¶: Property DBKey is of type str.

property name¶: Property name is of type str.

property partialTableReference¶: Property partialTableReference is of type PartialTableReference. When used for input, this only needs to be specified if you are specifying a name rather than an id.

property subsetIdentity¶: Property subsetIdentity is of type int.

property c_obj¶: Pointer to the underlying C-object

SubsetsDataType¶

class SubsetsDataType(dataVersionNo=None, importNodeName=None, namedSubsets=None, nodeName=None, typeString=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

SubsetsDataType. Contains a list of subsets Contains a list of subsets (returned by DataExport for the pseudo attribute for Subsets)

Parameters

dataVersionNo – type int
importNodeName – type str
namedSubsets – type list of NamedSubset objects
nodeName – type str
typeString – type str

property dataVersionNo¶: Property dataVersionNo is of type int.

property importNodeName¶: Property importNodeName is of type str.

property namedSubsets¶: Property namedSubsets is a NamedSubset objects. Warning: Do not attempt to edit or append to the returned value.

property nodeName¶: Property nodeName is of type str.

property typeString¶: Property typeString is of type str.

property c_obj¶: Pointer to the underlying C-object

TableDetail¶

class TableDetail(tableFilters=None, standardAttributeReferences=None, tableReference=None, attributeReferences=None, defaultLayout=None, defaultSubset=None, _isOwner=True)¶

Bases: object

TableDetail. Detailed meta-information about a table in a Granta MI database.

Parameters

tableFilters – type list of int objects
standardAttributeReferences – type list of AttributeReference objects
tableReference – type TableReference
attributeReferences – type list of AttributeReference objects
defaultLayout – type NamedLayout
defaultSubset – type SubsetDetail

property attributeReferences¶: Property attributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property defaultLayout¶: Property defaultLayout is of type NamedLayout.

property defaultSubset¶: Property defaultSubset is of type SubsetDetail.

property standardAttributeReferences¶: Property standardAttributeReferences is a list of AttributeReference objects. Warning: Do not attempt to edit or append to the returned value.

property tableFilters¶: Property tableFilters is a list of int objects. See GRANTA_Constants.TablesFilter for supported values. Warning: Do not attempt to edit or append to the returned value.

property tableReference¶: Property tableReference is of type TableReference.

AddAttributeReferences(_attributeReference)¶

Appends _attributeReference to attributeReferences property on TableDetail C-object.

Parameters: _attributeReference – object of type AttributeReference.

property c_obj¶: Pointer to the underlying C-object

TableReference¶

class TableReference(GUID=None, name=None, DBKey=None, ID=None, _isOwner=True)¶

Bases: object

TableReference. A type that allows identification of a particular table in a particular Granta MI database. The DBKey is required in addition to at least one of either: ID, GUID, or Name.

Parameters

GUID – type str
name – type str
DBKey – type str
ID – type int

property DBKey¶: Property DBKey is of type str.

property GUID¶: Property GUID is of type str.

property ID¶: Property ID is of type int.

property name¶: Property name is of type str.

property c_obj¶: Pointer to the underlying C-object

TabularColumn¶

class TabularColumn(type=None, name=None, _isOwner=True)¶

Bases: object

TabularColumn. Describes a column within a particular Tabular data instance.

Parameters

type – type int
name – type str

class ColType¶

Bases: object

Local = 0¶

TargetAttribute = 1¶

TargetRecord = 2¶

TargetTabularColumn = 3¶

Unavailable = 4¶

property name¶: Property name is of type str.

property type¶: Property type is of type int. See TabularColumn.ColType for supported values.

property c_obj¶: Pointer to the underlying C-object

TabularColumnDetail¶

class TabularColumnDetail(name=None, dataType=None, databaseUnit=None, revisionInfo=None, discreteValues=None, type=None, _isOwner=True)¶

Bases: object

TabularColumnDetail. Describes a Tabular Column, defined in a Tabular Attribute. This details how the schema describes the Column, and does not provide information about the contents of the Column in any particular Datum.

Parameters

name – type str
dataType – type str
databaseUnit – type str
revisionInfo – type RevisionInfo
discreteValues – type list of str objects
type – type int

property dataType¶: Property dataType is of type str.

property databaseUnit¶: Property databaseUnit is of type str.

property discreteValues¶: Property discreteValues is a str objects. Warning: Do not attempt to edit or append to the returned value.

property name¶: Property name is of type str.

property revisionInfo¶: Property revisionInfo is of type RevisionInfo.

property type¶: Property type is of type int. See TabularColumn.ColType for supported values.

property c_obj¶: Pointer to the underlying C-object

TabularDataCell¶

class TabularDataCell(rangeDataValue=None, discreteDataValue=None, hyperlinkDataValue=None, listDataValue=None, fileDataValue=None, dataType=None, shortTextDataValue=None, integerDataValue=None, pointDataValue=None, logicalDataValue=None, longTextDataValue=None, dateDataValue=None, data=None, pictureDataValue=None, _isOwner=True)¶

Bases: object

TabularDataCell. A Cell within an item of Tabular Data. When importing, TabularDataRow’s CreateRow() and CreateUpdateRow() functions initialize empty cells. You can set this type’s data member to be various data types: range, point, short text, long text, discrete, integer, logical, hyperlink, file, picture, or date.

Parameters

rangeDataValue – type RangeDataType
discreteDataValue – type DiscreteDataType
hyperlinkDataValue – type HyperlinkDataType
listDataValue – type ListDataType
fileDataValue – type FileDataType
dataType – type str
shortTextDataValue – type ShortTextDataType
integerDataValue – type IntegerDataType
pointDataValue – type PointDataType
logicalDataValue – type LogicalDataType
longTextDataValue – type LongTextDataType
dateDataValue – type DateDataType
data – type IDataValue
pictureDataValue – type PictureDataType

property dataType¶: Property dataType is of type str.

property dateDataValue¶: Property dateDataValue is of type DateDataType.

property discreteDataValue¶: Property discreteDataValue is of type DiscreteDataType.

property fileDataValue¶: Property fileDataValue is of type FileDataType.

property hyperlinkDataValue¶: Property hyperlinkDataValue is of type HyperlinkDataType.

property integerDataValue¶: Property integerDataValue is of type IntegerDataType.

property listDataValue¶: Property listDataValue is of type ListDataType.

property logicalDataValue¶: Property logicalDataValue is of type LogicalDataType.

property longTextDataValue¶: Property longTextDataValue is of type LongTextDataType.

property pictureDataValue¶: Property pictureDataValue is of type PictureDataType.

property pointDataValue¶: Property pointDataValue is of type PointDataType.

property rangeDataValue¶: Property rangeDataValue is of type RangeDataType.

property shortTextDataValue¶: Property shortTextDataValue is of type ShortTextDataType.

property data¶: Property data is of type IDataValue.

property c_obj¶: Pointer to the underlying C-object

TabularDataRow¶

class TabularDataRow(cells=None, Id=None, linkedRecords=None, linkingValue=None, _isOwner=True)¶

Bases: object

TabularDataRow. A Row within an item of Tabular Data. When importing, this must be created by TabularDataType’s CreateRow() or CreateUpdateRow() functions. These functions return rows with empty cells (the number of which is the number of columns added with AddColumn())

Parameters

cells – type list of TabularDataCell objects
Id – type int
linkedRecords – type list of RecordReference objects
linkingValue – type str

property cells¶: Property cells is a TabularDataCell objects. Warning: Do not attempt to edit or append to the returned value.

property Id¶: Property Id is of type int.

property linkedRecords¶: Property linkedRecords is a RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property linkingValue¶: Property linkingValue is of type str.

property c_obj¶: Pointer to the underlying C-object

TabularDataType¶

class TabularDataType(columns=None, tabularDataRows=None, isApplicable=None, _isOwner=True)¶

Bases: GRANTA_MIScriptingToolkit.IDataValue.IDataValue

TabularDataType. Type representing an item of exported Tabular Data, including metadata such as Column definitions. This type can also be used for import, although the usage pattern is different. See the TabularDataRow type for more information.

Parameters

columns – type list of TabularColumn objects
tabularDataRows – type list of TabularDataRow objects
isApplicable – type bool

class ChangeType¶

Bases: object

InsertBefore = 0¶

Append = 1¶

Update = 2¶

Delete = 3¶

CreateRow()¶: Create and return a row for a tabular data import operation.

CreateUpdateRow(type, identity)¶

Create and return a row for a tabular data import update operation. To append a new row, use identity 0: new_row = tabular_data_type.CreateUpdateRow(type=ChangeType.Append, identity=0).

Parameters

type - (*) –
identity - (*) –

property columns¶: Property columns is a list of TabularColumn objects. Warning: Do not attempt to edit or append to the returned value.

property isApplicable¶: Property isApplicable is of type bool.

property tabularDataRows¶: Property tabularDataRows is a list of TabularDataRow objects. Warning: Do not attempt to edit or append to the returned value.

AddColumn(value)¶

Appends value to columns property on TabularDataType C-object.

Parameters: value – object of type Defs.string_types.

property c_obj¶: Pointer to the underlying C-object

TabularDetail¶

class TabularDetail(columns=None, linkedTable=None, linkingAttribute=None, _isOwner=True)¶

Bases: object

TabularDetail. Information about a specific tabular attribute. If the tabular attribute has a linking attribute, you can specify the linking attribute and the linked table containing that attribute.

Parameters

columns – type list of TabularColumnDetail objects
linkedTable – type PartialTableReference
linkingAttribute – type NamedAttribute

property columns¶: Property columns is a TabularColumnDetail objects. Warning: Do not attempt to edit or append to the returned value.

property linkedTable¶: Property linkedTable is of type PartialTableReference.

property linkingAttribute¶: Property linkingAttribute is of type NamedAttribute.

property c_obj¶: Pointer to the underlying C-object

TargetedSourceRecord¶

class TargetedSourceRecord(sourceRecord=None, targetRecords=None, _isOwner=True)¶

Bases: object

TargetedSourceRecord. A type for unlinking records, contains a source RecordReference and an array of target RecordReference objects.

Parameters

sourceRecord – type RecordReference
targetRecords – type list of RecordReference objects

property targetRecords¶: Property targetRecords is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property sourceRecord¶: Property sourceRecord is of type RecordReference.

AddTargetRecord(_recordReference)¶

Appends _recordReference to targetRecords property on TargetedSourceRecord C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

TreeRecord¶

class TreeRecord(parentRecordHistoryIdentity=None, color=None, recordReference=None, longName=None, shortName=None, type=None, children=None, _isOwner=True)¶

Bases: object

TreeRecord. Type representing a single record in a Granta MI database, along with information about its position in the node-tree.

Parameters

parentRecordHistoryIdentity – type int
color – type str
recordReference – type RecordReference
longName – type str
shortName – type str
type – type str
children – type list of TreeRecord objects

property children¶: Property children is a list of TreeRecord objects. Warning: Do not attempt to edit or append to the returned value.

property color¶: Property color is of type str.

property longName¶: Property longName is of type str.

property parentRecordHistoryIdentity¶: Property parentRecordHistoryIdentity is of type int.

property recordReference¶: Property recordReference is of type RecordReference.

property shortName¶: Property shortName is of type str.

property type¶: Property type is of type str.

AddChildren(_treeRecord)¶

Appends _treeRecord to children property on TreeRecord C-object.

Parameters: _treeRecord – object of type TreeRecord.

property c_obj¶: Pointer to the underlying C-object

UnitConversion¶

class UnitConversion(factor=None, offset=None, sourceSymbol=None, targetSymbol=None, _isOwner=True)¶

Bases: object

UnitConversion. Information about how to convert from a specified source unit to a target unit.

Parameters

factor – type float
offset – type float
sourceSymbol – type str
targetSymbol – type str

property factor¶: Property factor is of type float.

property offset¶: Property offset is of type float.

property sourceSymbol¶: Property sourceSymbol is of type str.

property targetSymbol¶: Property targetSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

UnitConversionContext¶

class UnitConversionContext(currency=None, absoluteUnits=None, unitSystem=None, _isOwner=True)¶

Bases: object

UnitConversionContext. Type defining how values with units should be represented

Parameters

currency – type str
absoluteUnits – type bool
unitSystem – type str

property absoluteUnits¶: Property absoluteUnits is of type bool.

property currency¶: Property currency is of type str.

property unitSystem¶: Property unitSystem is of type str.

property c_obj¶: Pointer to the underlying C-object

UnitConversionContextConversionSet¶

class UnitConversionContextConversionSet(unitConversionContext=None, unitConversions=None, _isOwner=True)¶

Bases: object

UnitConversionContextConversionSet. All the unit conversions available with a specified unit conversion context

Parameters

unitConversionContext – type UnitConversionContext
unitConversions – type list of UnitConversion objects

property unitConversions¶: Property unitConversions is a list of UnitConversion objects. Warning: Do not attempt to edit or append to the returned value.

property unitConversionContext¶: Property unitConversionContext is of type UnitConversionContext.

AddUnitConversion(_unitConversion)¶

Appends _unitConversion to unitConversions property on UnitConversionContextConversionSet C-object.

Parameters: _unitConversion – object of type UnitConversion.

property c_obj¶: Pointer to the underlying C-object

UnitConversionTarget¶

class UnitConversionTarget(factor=None, offset=None, targetSymbol=None, _isOwner=True)¶

Bases: object

UnitConversionTarget. Information about how to convert to a target unit. When this type is used directly, the source unit is assumed to be already known from a different type. To obtain a value in the target units, multiply the source value by the factor, and then add the offset.

Parameters

factor – type float
offset – type float
targetSymbol – type str

property factor¶: Property factor is of type float.

property offset¶: Property offset is of type float.

property targetSymbol¶: Property targetSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

UnitInformation¶

class UnitInformation(unitSymbol=None, unitName=None, _isOwner=True)¶

Bases: object

UnitInformation. A type used to give details of units for quantities. When this type is output by the Service Layer, both name and symbol will be populated. When passed as input to the Service Layer, only name or symbol need to be populated; if both are populated, only the symbol is used.

Parameters

unitSymbol – type str
unitName – type str

property unitName¶: Property unitName is of type str.

property unitSymbol¶: Property unitSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

UnittedParameterValue¶

class UnittedParameterValue(unitSymbol=None, parameterWithValues=None, _isOwner=True)¶

Bases: object

UnittedParameterValue. A Parameter, along with a single value of that Parameter, optionally with units.

Parameters

unitSymbol – type str
parameterWithValues – type ParameterReferenceAndValue

property parameterWithValues¶: Property parameterWithValues is of type ParameterReferenceAndValue.

property unitSymbol¶: Property unitSymbol is of type str.

property c_obj¶: Pointer to the underlying C-object

UnlinkAllRecords¶

class UnlinkAllRecords(sourceRecords=None, nodeName=None, _isOwner=True)¶

Bases: object

UnlinkAllRecords. For each given source record, remove all links in the Record Link Group.

Parameters

sourceRecords – type list of RecordReference objects
nodeName – type str

property sourceRecords¶: Property sourceRecords is a list of RecordReference objects. Warning: Do not attempt to edit or append to the returned value.

property nodeName¶: Property nodeName is of type str.

AddSourceRecord(_recordReference)¶

Appends _recordReference to sourceRecords property on UnlinkAllRecords C-object.

Parameters: _recordReference – object of type RecordReference.

property c_obj¶: Pointer to the underlying C-object

UnlinkRecords¶

class UnlinkRecords(sourceRecords=None, nodeName=None, _isOwner=True)¶

Bases: object

UnlinkRecords. For each given source record, remove links to the target records specified for that source record. Silently skip any links that do not exist.

Parameters

sourceRecords – type list of TargetedSourceRecord objects
nodeName – type str

property sourceRecords¶: Property sourceRecords is of type list of TargetedSourceRecord.

property nodeName¶: Property nodeName is of type str.

AddSourceRecord(_targetedSourceRecord)¶

Appends _targetedSourceRecord to sourceRecords property on UnlinkRecords C-object.

Parameters: _targetedSourceRecord – object of type TargetedSourceRecord.

property c_obj¶: Pointer to the underlying C-object

XYData¶

class XYData(XYPoints=None, XYRanges=None, type=None, _isOwner=True)¶

Bases: object

XYData. A collection of y-axis values for a graph where the y-axis values are either point or range values.

Parameters

XYPoints – type list of XYPoint objects
XYRanges – type list of XYRange objects
type – type str

property XYPoints¶: Property XYPoints is a list of XYPoint objects. Warning: Do not attempt to edit or append to the returned value.

property XYRanges¶: Property XYRanges is a list of XYRange objects. Warning: Do not attempt to edit or append to the returned value.

property type¶: Property type is of type str.

AddXYPoint(_XYPoint)¶

Appends _XYPoint to XYPoints property on XYData C-object.

Parameters: _XYPoint – object of type XYPoint.

AddXYRange(_XYRange)¶

Appends _XYRange to XYRanges property on XYData C-object.

Parameters: _XYRange – object of type XYRange.

property c_obj¶: Pointer to the underlying C-object

XYPoint¶

class XYPoint(Y=None, isEstimated=None, parameterValue=None, _isOwner=True)¶

Bases: object

XYPoint. An x-y datum where the y-axis value is a point.

Parameters

Y – type float
isEstimated – type bool
parameterValue – type ParameterValue

property isEstimated¶: Property isEstimated is of type bool.

property parameterValue¶: Property parameterValue is of type ParameterValue.

property Y¶: Property Y is of type float.

property c_obj¶: Pointer to the underlying C-object

XYRange¶

class XYRange(isEstimated=None, lowerY=None, upperY=None, parameterValue=None, _isOwner=True)¶

Bases: object

XYRange. An x-y datum where the y-axis value is a range.

Parameters

isEstimated – type bool
lowerY – type float
upperY – type float
parameterValue – type ParameterValue

property isEstimated¶: Property isEstimated is of type bool.

property lowerY¶: Property lowerY is of type float.

property parameterValue¶: Property parameterValue is of type ParameterValue.

property upperY¶: Property upperY is of type float.

property c_obj¶: Pointer to the underlying C-object