restmapi 1.0.4.4

MORPHEE REST API SDK

REST MAPI Package

REST MAPI (MORPHEE API) package allows to control MORPHEE at runtime using MORPHEE REST API. MAPI main principle is to provide so called MAPI services. From MAPI, you should first ask for a specific service before using it.

:information_source: Each service has access rights that could be set in UEditor.

Install

To install restmapi pyhton module, first ensure that you are connected to our devops feed by adding in your %HOMEDRIVE%%HOMEPATH%\pip directory pip.ini as follow:

[global]
index-url=https://pkgs.dev.azure.com/STS-Software/MORPHEE/_packaging/FEV-MORPHEE-Feed/pypi/simple/
extra-index-url= https://pkgs.dev.azure.com/STS-Software/_packaging/STS-Azure-Feed/pypi/simple/
				 https://pypi.org/simple

Then to install the module run:

pip install restmapi

Example

Here a small example to start MORPHEE using REST MAPI.

from restmapi.services import MAPIServices

with MAPIServices.instance.get_service("MorpheeProcessControl") as morphee_process_control:
	if morphee_process_control.is_morphee_process_started() != True:
		morphee_process_control.start()

Internal information

Project source location: Project internal source location

Jira issues: MORPHEE Jira project