Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------

Find more posts tagged with

English

Monarch

Accepted answers

CPorthouse

I agree with Mo. You need to capture the session id. I normally create a function to handle the response:

def getResponse(url, jsonData):     global session     if not 'session' in globals():         session = requests.Session()         session.headers.update({'Content-Type':'application/json'})      r = session.post(url, json=jsonData)     return r

So when I login (with a defined function I created called 'login'):

response = login('admin', 'password')

I create a global "session" variable which will be used automatically when I call my getResponse function:

def startProcess(processName):     start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start'     print('Attempting to start process ' + processName)     return getResponse(start_url, processName)

------------------------------
Chris Porthouse
Senior Implementation & Integration Engineer
Altair
------------------------------
-------------------------------------------
Original Message:
Sent: 05-09-2020 04:55 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------"

All comments

Mo Abdolrahim

Hi Leonid,
I am not familiar with Python syntax, but you need to create a session variable for the first request and then use the session variable for subsequent request. In the python syntax you provided I don't see you are passing a session variable to the second request.

The following is the syntax in PowerShell script:
$rep = Invoke-WebRequest -Uri $login_url -Method POST -Body $postParams -SessionVariable session

Noticed the session object in the invoke-WebRequest method.
The session object is then used in the next invoke-web-request method.
Invoke-WebRequest -Uri $start_process_url -Method POST -Body $processName -WebSession $session

Regards
Mo

------------------------------
Mahmoud Abdolrahim
Senior Implementation & Integration Engineer
Datawatch Corporation
MA
(978) 935-3840
------------------------------
-------------------------------------------
Original Message:
Sent: 05-09-2020 04:55 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------
"

CPorthouse

I agree with Mo. You need to capture the session id. I normally create a function to handle the response:

def getResponse(url, jsonData):     global session     if not 'session' in globals():         session = requests.Session()         session.headers.update({'Content-Type':'application/json'})      r = session.post(url, json=jsonData)     return r

So when I login (with a defined function I created called 'login'):

response = login('admin', 'password')

I create a global "session" variable which will be used automatically when I call my getResponse function:

def startProcess(processName):     start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start'     print('Attempting to start process ' + processName)     return getResponse(start_url, processName)

Leonid

I agree with Mo. You need to capture the session id. I normally create a function to handle the response:
def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r
</code> So when I login (with a defined function I created called 'login'): <pre class="language-python">response = login('admin', 'password')</pre> I create a global "session" variable which will be used automatically when I call my getResponse function: <pre class="language-python">def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)</pre> ------------------------------ Chris Porthouse Senior Implementation & Integration Engineer Altair ------------------------------ ------------------------------------------- Original Message: Sent: 05-09-2020 04:55 PM From: Leonid Shteyngardt Subject: Visual Process API error Hello, I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong? Thank you! monarch_rest_api.py import requests url = "http://us1-monarch1/MSAdmin/api" login_info = {"Username":"test_login", "Password":"test_password"} jobname = "Test Job" resp = requests.post(url + "/login", json = login_info) print ("Login: ", resp.status_code) resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'}) print ("Start: ", resp.status_code) print (resp.json()) Output H:\python>python monarch_rest_api.py Login: 200 Start: 500 {'Message': 'An error has occurred.'} ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------"</blockquote> Thank you very much Chris and Mo for your suggestions and code samples! You not only saved me time and frustration, but also provided the way to write concise and efficient code. Everything works correctly now. I just have one more question. When I try to get process status: response = session.get(url + "/v1/visualprocesses/" + tracking_id + "/status") print (response.text) the response.text returns codes - 200, 300, 400. But when I try to run the same request in the Chrome it returns XML and descriptions: Ready, Running, Completed. Is there a way to get the same description from within the Python? Thank you very much, Leonid ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------ ------------------------------------------- Original Message: Sent: 05-10-2020 10:24 AM From: Chris Porthouse Subject: Visual Process API error I agree with Mo. You need to capture the session id. I normally create a function to handle the response: <pre class="language-python">def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r</pre> <code>

So when I login (with a defined function I created called 'login'):
response = login('admin', 'password')
I create a global "session" variable which will be used automatically when I call my getResponse function:
def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)
------------------------------
Chris Porthouse
Senior Implementation & Integration Engineer
Altair
------------------------------

Original Message:
Sent: 05-09-2020 04:55 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------"

CPorthouse

Thank you very much Chris and Mo for your suggestions and code samples! You not only saved me time and frustration, but also provided the way to write concise and efficient code. Everything works correctly now. I just have one more question.
When I try to get process status:

response = session.get(url + "/v1/visualprocesses/" + tracking_id + "/status")
print (response.text)

the response.text returns codes - 200, 300, 400. But when I try to run the same request in the Chrome it returns XML and descriptions: Ready, Running, Completed. Is there a way to get the same description from within the Python?

Thank you very much,
Leonid

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------
-------------------------------------------
Original Message:
Sent: 05-10-2020 10:24 AM
From: Chris Porthouse
Subject: Visual Process API error

I agree with Mo. You need to capture the session id. I normally create a function to handle the response:
def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r
</code> So when I login (with a defined function I created called 'login'): <pre class="language-python">response = login('admin', 'password')</pre> I create a global "session" variable which will be used automatically when I call my getResponse function: <pre class="language-python">def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)</pre> ------------------------------ Chris Porthouse Senior Implementation & Integration Engineer Altair ------------------------------ Original Message: Sent: 05-09-2020 04:55 PM From: Leonid Shteyngardt Subject: Visual Process API error Hello, I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong? Thank you! monarch_rest_api.py import requests url = "http://us1-monarch1/MSAdmin/api" login_info = {"Username":"test_login", "Password":"test_password"} jobname = "Test Job" resp = requests.post(url + "/login", json = login_info) print ("Login: ", resp.status_code) resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'}) print ("Start: ", resp.status_code) print (resp.json()) Output H:\python>python monarch_rest_api.py Login: 200 Start: 500 {'Message': 'An error has occurred.'} ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------"</blockquote> The response.text method will return the content of the response. Different browsers will handle it differently. If you only want the text of the response try <pre class="language-python">response.reason</pre> If you simply want the status code you can use: <pre class="language-python">response.status_code</pre> status_code also has an overloaded __bool__() operator so you can use an if statement and if the status_code is between 200-400, it will return TRUE. ------------------------------ Chris Porthouse Senior Implementation & Integration Engineer Altair ------------------------------ ------------------------------------------- Original Message: Sent: 05-10-2020 07:30 PM From: Leonid Shteyngardt Subject: Visual Process API error Thank you very much Chris and Mo for your suggestions and code samples! You not only saved me time and frustration, but also provided the way to write concise and efficient code. Everything works correctly now. I just have one more question. When I try to get process status: response = session.get(url + "/v1/visualprocesses/" + tracking_id + "/status") print (response.text) the response.text returns codes - 200, 300, 400. But when I try to run the same request in the Chrome it returns XML and descriptions: Ready, Running, Completed. Is there a way to get the same description from within the Python? Thank you very much, Leonid ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------ Original Message: Sent: 05-10-2020 10:24 AM From: Chris Porthouse Subject: Visual Process API error I agree with Mo. You need to capture the session id. I normally create a function to handle the response: <pre class="language-python">def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r</pre> <code>

So when I login (with a defined function I created called 'login'):
response = login('admin', 'password')
I create a global "session" variable which will be used automatically when I call my getResponse function:
def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)
------------------------------
Chris Porthouse
Senior Implementation & Integration Engineer
Altair

Original Message:
Sent: 05-09-2020 04:55 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------"

Leonid

The response.text method will return the content of the response. Different browsers will handle it differently. If you only want the text of the response try
response.reason
If you simply want the status code you can use:
response.status_code
status_code also has an overloaded __bool__() operator so you can use an if statement and if the status_code is between 200-400, it will return TRUE.
------------------------------
Chris Porthouse
Senior Implementation & Integration Engineer
Altair
------------------------------
-------------------------------------------
Original Message:
Sent: 05-10-2020 07:30 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Thank you very much Chris and Mo for your suggestions and code samples! You not only saved me time and frustration, but also provided the way to write concise and efficient code. Everything works correctly now. I just have one more question.
When I try to get process status:

response = session.get(url + "/v1/visualprocesses/" + tracking_id + "/status")
print (response.text)

the response.text returns codes - 200, 300, 400. But when I try to run the same request in the Chrome it returns XML and descriptions: Ready, Running, Completed. Is there a way to get the same description from within the Python?

Thank you very much,
Leonid

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------

Original Message:
Sent: 05-10-2020 10:24 AM
From: Chris Porthouse
Subject: Visual Process API error

I agree with Mo. You need to capture the session id. I normally create a function to handle the response:
def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r
</code> So when I login (with a defined function I created called 'login'): <pre class="language-python">response = login('admin', 'password')</pre> I create a global "session" variable which will be used automatically when I call my getResponse function: <pre class="language-python">def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)</pre> ------------------------------ Chris Porthouse Senior Implementation & Integration Engineer Altair Original Message: Sent: 05-09-2020 04:55 PM From: Leonid Shteyngardt Subject: Visual Process API error Hello, I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong? Thank you! monarch_rest_api.py import requests url = "http://us1-monarch1/MSAdmin/api" login_info = {"Username":"test_login", "Password":"test_password"} jobname = "Test Job" resp = requests.post(url + "/login", json = login_info) print ("Login: ", resp.status_code) resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'}) print ("Start: ", resp.status_code) print (resp.json()) Output H:\python>python monarch_rest_api.py Login: 200 Start: 500 {'Message': 'An error has occurred.'} ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------"</blockquote> Works perfectly. Thank you so much, Chris! ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 ------------------------------ ------------------------------------------- Original Message: Sent: 05-11-2020 07:16 AM From: Chris Porthouse Subject: Visual Process API error The response.text method will return the content of the response. Different browsers will handle it differently. If you only want the text of the response try <pre class="language-python">response.reason</pre> If you simply want the status code you can use:<pre class="language-python">response.status_code</pre> status_code also has an overloaded __bool__() operator so you can use an if statement and if the status_code is between 200-400, it will return TRUE. ------------------------------ Chris Porthouse Senior Implementation & Integration Engineer Altair ------------------------------ Original Message: Sent: 05-10-2020 07:30 PM From: Leonid Shteyngardt Subject: Visual Process API error Thank you very much Chris and Mo for your suggestions and code samples! You not only saved me time and frustration, but also provided the way to write concise and efficient code. Everything works correctly now. I just have one more question. When I try to get process status: response = session.get(url + "/v1/visualprocesses/" + tracking_id + "/status") print (response.text) the response.text returns codes - 200, 300, 400. But when I try to run the same request in the Chrome it returns XML and descriptions: Ready, Running, Completed. Is there a way to get the same description from within the Python? Thank you very much, Leonid ------------------------------ Leonid Shteyngardt App Dev Manager Canaccord Genuity Inc. New York NY (212) 389-8176 Original Message: Sent: 05-10-2020 10:24 AM From: Chris Porthouse Subject: Visual Process API error I agree with Mo. You need to capture the session id. I normally create a function to handle the response: <pre class="language-python">def getResponse(url, jsonData): global session if not 'session' in globals(): session = requests.Session() session.headers.update({'Content-Type':'application/json'}) r = session.post(url, json=jsonData) return r</pre> <code>

So when I login (with a defined function I created called 'login'):
response = login('admin', 'password')
I create a global "session" variable which will be used automatically when I call my getResponse function:
def startProcess(processName): start_url = 'http://ds13w2k12/MSAdmin/api/v1/visualprocesses/start' print('Attempting to start process ' + processName) return getResponse(start_url, processName)
------------------------------
Chris Porthouse
Senior Implementation & Integration Engineer
Altair

Original Message:
Sent: 05-09-2020 04:55 PM
From: Leonid Shteyngardt
Subject: Visual Process API error

Hello,

I'm trying to use Monarch Visual Process Designer API from Python. Login request returns success, but visualprocess/start returns an error. Below is a script and the output. What am I doing wrong?

Thank you!

monarch_rest_api.py
import requests

url = "http://us1-monarch1/MSAdmin/api"
login_info = {"Username":"test_login", "Password":"test_password"}
jobname = "Test Job"

resp = requests.post(url + "/login", json = login_info)
print ("Login: ", resp.status_code)

resp = requests.post(url + "/v1/visualprocesses/start", data=jobname, headers={'Content-Type':'application/json'})
print ("Start: ", resp.status_code)
print (resp.json())

Output
H:\python>python monarch_rest_api.py
Login: 200
Start: 500
{'Message': 'An error has occurred.'}

------------------------------
Leonid Shteyngardt
App Dev Manager
Canaccord Genuity Inc.
New York NY
(212) 389-8176
------------------------------"