Trigger SC Orchestrator 2022 Runbook via JSON based Web API

Question

Trigger SC Orchestrator 2022 Runbook via JSON based Web API

McDaniel, Dave 66

I am attempting to trigger a runbook via the new SCO Web Api using Powershell invoke-Rest Method. I am able to successfully retrieve Runbooks, however I have not been able to successfully trigger a runbook yet. Any help is appreciated. Below is example of powershell i have been using.

$RunbookURL = 'http://<Orchestratorserver>:<port>/api/runbooks'

$RB_ID = "<Runbook ID>"

$JobUrl = 'http://<Orchestratorserver>:<port>/api/jobs'

$Runbooks = Invoke-RestMethod -Uri $RunbookURL -UseDefaultCredentials -Method Get

$Runbook = $Runbooks.value | where-object{$_.ID -eq "$RB_ID"}

$Body = '{

"RunbookId":  "$RB_ID",  
"Parameters: null,

}'|ConvertTo-Json

$ExecuteRBresponse = Invoke-RestMethod -Uri $JobUrl -UseDefaultCredentials -Method Post -Body $Body -ContentType "application/json"

McDaniel, Dave 66 Reputation points

2022-09-17T00:57:34.627+00:00

Hi there, it's been almost a month. Any help on this would be appreciated. While I have found documentation for API installation, I have thus far been unable to find any documentation regarding the use of the Orchestrator JSON based Web API. This page whats-new-in-orch states that "the job creation with parameters API has been greatly simplified." However, I am unable to find any documentation with instructions to this end.
McDaniel, Dave 66 Reputation points

2022-09-19T14:59:17.213+00:00

Currently when I try to execute a runbook via Invoke-RestMethod I receive the Error 400 Bad Request and it states "Invalid Job creation params" Can someone explain what the mandatory params for Job creation are and how the JSON body structure should look?

McDaniel, Dave 66 Reputation points

2022-09-17T00:57:34.627+00:00

Hi there, it's been almost a month. Any help on this would be appreciated. While I have found documentation for API installation, I have thus far been unable to find any documentation regarding the use of the Orchestrator JSON based Web API. This page whats-new-in-orch states that "the job creation with parameters API has been greatly simplified." However, I am unable to find any documentation with instructions to this end.
McDaniel, Dave 66 Reputation points

2022-09-19T14:59:17.213+00:00

Currently when I try to execute a runbook via Invoke-RestMethod I receive the Error 400 Bad Request and it states "Invalid Job creation params" Can someone explain what the mandatory params for Job creation are and how the JSON body structure should look?

Answer 1

Brad Davis 81

here is what have that works:

# Details of the runbook we are going to run  
$rbid = "0E3D0830-5BB6-4717-BB94-330E0338F153"    
  
$OrchURI = 'http://<SERVERFQDN>:81' #Replace 81 by the WebService port  
  
# To Start a job  
$body = @{  
  
RunbookId = $rbid  
  
CreatedBy = $null  
  
} | ConvertTo-Json  
  
Invoke-RestMethod -Uri ('{0}/api/Jobs' -f $OrchURI) -Body $body -Method Post -ContentType 'application/json' -UseDefaultCredentials

McDaniel, Dave 66 Reputation points

2022-09-28T15:06:29.25+00:00

Brad,

Thanks for this! This is exactly what I needed!
McDaniel, Dave 66 Reputation points

2022-10-03T16:32:46.247+00:00

@Brad Davis : Hi There Brad, are you able to successfully pass multiple RB parameters into the $body? If so, how did you structure? Thanks in advance.
Brad Davis 81 Reputation points

2022-10-03T16:39:34.243+00:00

That's the same problem I am running into and have asked about here (how I found your question that I was able to help with).

Here's a link to where I asked. Maybe add a comment that you are having same issue to help people see.

https://learn.microsoft.com/en-us/answers/questions/1026891/orchestrator-2022-passing-parameters-to-runbook-wi.html

If I do find an answer I will post it here as well.
McDaniel, Dave 66 Reputation points

2022-10-03T16:42:49.417+00:00

Thanks Brad! I will take a look and comment also.

Brad Davis 81

@McDaniel, Dave I got it! Had to run a debug on the webconsole to figure it out.

My Initialize data looks like:

And my code (with server URI left out) is:

$body = @"  
{  
    "RunbookId":"0E3D0830-5BB6-4717-BB94-330E0338F153",  
    "Parameters": [ { "Name": "Action", "Value": "testss" }, { "Name": "Serial", "Value": "testsserial" } ]  
}  
"@  
  
Invoke-RestMethod -Uri ('{0}/api/Jobs' -f $OrchURI) -Body $body -Method Post -ContentType 'application/json' -UseDefaultCredentials

McDaniel, Dave 66 Reputation points

2022-10-03T20:57:11.587+00:00

@Brad Davis That is fantastic! Thanks so much for sharing!

Trigger SC Orchestrator 2022 Runbook via JSON based Web API

0 additional answers

Activity