Start
The Start operation starts a runbook instance.
Request
| Method | Request URI | HTTP Version |
|---|---|---|
POST |
HTTPS://<HOST>:<PORT>/00000000-0000-0000-0000-000000000000/Runbooks(guid'<GUID>')/Start |
HTTP/1.1 |
Note
This OData operation requires the request URL to point to an instance of the Runbook entity.
Behavior
The following table describes how this operation behaves.
| Setting | Value |
|---|---|
Is composable? |
False |
Has side effects? |
True |
Requires an entity instance? |
True |
Return type |
Edm.Guid |
Results belong to an entity set? |
None |
Parameters
The following table describes the parameters of this operation.
| Name | Type | Nullable | Description |
|---|---|---|---|
GUID |
Edm.Guid |
False |
The unique identifier of the runbook. |
parameters |
Collection(Orchestrator.ResourceModel.NameValuePair) |
False |
A name value pair. |
Code Example
POST https://sma-server:9090/00000000-0000-0000-0000-000000000000/Runbooks(guid'ba12b433-342e-4c15-88a1-942020c7a92e')/Start HTTP/1.1
Uri startRunbookUri = new Uri(string.Concat(SMAService.Runbooks, string.Format("(guid'{0}')/{1}", runbookID, "Start")), UriKind.Absolute);
var returnValue = SMAService.Execute<Guid>(startRunbookUri, "POST", true);