GET v1/{subscriptionID}/runs/{runID}
Gets a run.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
runID |
The run ID to be retrieved. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a run for the specified run ID.
RunModelName | Description | Type | Additional information |
---|---|---|---|
ID |
Gets the run ID. |
globally unique identifier |
None. |
SubscriptionID |
Gets the subscription ID of the run. |
globally unique identifier |
None. |
ProjectID |
Gets the project ID of the run. |
globally unique identifier |
None. |
TouchPointID |
Gets the touchpoint ID of the run. |
globally unique identifier |
None. |
Creator |
Gets the user who created the run. |
UserViewModel |
None. |
CreationTime |
Gets the creation time of the run. |
date |
None. |
Type |
Gets the run type. |
RunType |
None. |
TriggeringType |
Gets the triggering type of the tun. |
RunTriggeringType |
None. |
Status |
Gets the run status. |
RunStatus |
None. |
Response Formats
application/json, text/json
Sample:
{ "ID": "a0da050b-dedb-4a7c-a1f4-66d3cf1a71b7", "SubscriptionID": "e4923cf9-bda6-442b-afca-295c64cbe1cf", "ProjectID": "2674c70e-b7d9-4d3f-a545-ab8f24cecf23", "TouchPointID": "3e619f7c-e204-4ed0-a96a-91b3568eae6d", "Creator": { "ID": "95144cf5-5eaf-4dbe-aeef-ed7720cb3c35", "Name": "sample string 2" }, "CreationTime": "2022-05-23T17:26:05.074258Z", "Type": 1, "TriggeringType": 1, "Status": 1, "ProductionType": 1, "Message": "sample string 5", "UProduceJobs": [ { "UProduceJobID": "89105827-8997-4028-8eba-3d7ba2a9b57b", "FriendlyID": "sample string 2" }, { "UProduceJobID": "89105827-8997-4028-8eba-3d7ba2a9b57b", "FriendlyID": "sample string 2" } ] }