Name is required.
Email address is required.
Invalid email address
Answer is required.
Exceeding max length of 5KB

API v1

Does anyone have a working example of a v1 call to run an Orchestration Job? I see lots of v0 examples, but I can't figure out how to pass variables into a v1 call.

3 Community Answers

Matillion Agent  

Dan D'Orazio —

Hi Brian -

I agree, the examples provided for v0 don’t help with this. I was able to figure it out by sending a ‘GET’ request for the job, and noticing that there was some information about what a POST would look like for /run in the response.

You can pass the variables into the body of the post (below), where “test_variable_in” and “test_2” are Job Variable names. I’ve tested it out in Python, but it could just as easily be done using curl / Postman.

post_endpoint_v1 = "rest/v1/group/name/Development/project/name/Sandbox/version/name/default/job/name/run-via-api/run?environmentName=Development"
r = requests.post(
  'http://127.0.0.1:8080/{}'.format(post_endpoint_v1), 
  auth=('username', r'password'),
  headers={"Content-Type": "application/json"},
  data='{"scalarVariables": {"test_variable_in": "something", "test_2": "something else"}}'
)

Hope this helps,
Dan


Brian Raney —

I have not been able to get this to work in Postman/Curl. Tried many permutations. Please provide a working example.

Thanks.


Matillion Agent  

Kalyan Arangam —

Hi Brian,

Below is an example to launch a job using using v1 api. It also demonstrates passing two scalar variables varstr and varnum and a Grid variable jobgridvar.
The grid variable jobgridvar has just two columns name and value and hence the 2×2 list. Note that the scalarVariables and gridVariables keys are optional and are not required if you do not intend to pass any variable defaults to the job.

curl -X POST -u api-user:api-user-password "http://10.12.12.12/rest/v1/group/name/Demonstration%20Projects/project/name/My%20Project/version/name/default/job/name/dim_airport_setup/run" -H 'Content-Type: application/json' -d '{"scalarVariables": {"varstr":"string value","varnum": 25},"gridVariables" : {"jobgridvar": [["R1C1", "R1C2"], ["R2C1", "R2C2"]]}}'

So the above launches a job dim_airport_setup in Project group Demonstration Projects, project My Project,version default and passing defaults for two scalar variables varstr and varnum and a Grid variable jobgridvar.

Hope that helps.

I’ve raised a ticket to provide this example on out site soon.

Best
Kalyan

Post Your Community Answer

To add an answer please login