POST v1/{subscriptionID}/touchPoints/{touchPointID}/test
Tests a touchpoint.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
touchPointID |
The touchpoint ID to be tested. |
globally unique identifier |
Required |
Body Parameters
The production parameters for testing.
ProductionTestParametersModelName | Description | Type | Additional information |
---|---|---|---|
FilteredListID |
Gets and sets the filtered list ID of the production. |
globally unique identifier |
None. |
Range |
Gets and sets the production range. |
ProductionRangeModel |
None. |
Type |
Gets the production parameters type. |
ProductionParametersType |
None. |
Request Formats
application/json, text/json, application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Returns the created run.
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": "efcf6ab9-7ddf-4ec8-a663-8fa9c4b54400", "SubscriptionID": "e956c468-2b2d-4dc3-a067-7980c0ef2d73", "ProjectID": "c49979ae-8d90-4d36-a12e-185622eede02", "TouchPointID": "5edee247-04c6-4f3c-b3d3-ac5aef774e8a", "Creator": { "ID": "036a20a3-21ff-45d0-9ead-616a2e6f25dd", "Name": "sample string 2" }, "CreationTime": "2022-05-23T18:19:09.3390691Z", "Type": 1, "TriggeringType": 1, "Status": 1, "ProductionType": 1, "Message": "sample string 5", "UProduceJobs": [ { "UProduceJobID": "b69abbb5-2c07-4142-ada4-71161c5d9baa", "FriendlyID": "sample string 2" }, { "UProduceJobID": "b69abbb5-2c07-4142-ada4-71161c5d9baa", "FriendlyID": "sample string 2" } ] }