JSON Object Example
{
    "JsonData": "{\r\n\t\"info\": {\r\n\t\t\"_postman_id\": \"dd40864b-abe2-4a65-ad18-1a9f04c75317\",\r\n\t\t\"name\": \"simple_test_without_error\",\r\n\t\t\"schema\": \"https://schema.getpostman.com/json/collection/v2.1.0/collection.json\"\r\n\t},\r\n\t\"item\": [\r\n\t\t{\r\n\t\t\t\"name\": \"GET First Check\",\r\n\t\t\t\"event\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"listen\": \"test\",\r\n\t\t\t\t\t\"script\": {\r\n\t\t\t\t\t\t\"id\": \"a070f8dd-e87d-4047-a006-255875cc61bc\",\r\n\t\t\t\t\t\t\"exec\": [\r\n\t\t\t\t\t\t\t\"pm.test(\\\"response is ok\\\", function () {\",\r\n\t\t\t\t\t\t\t\"    pm.response.to.have.status(200);\",\r\n\t\t\t\t\t\t\t\"});\",\r\n\t\t\t\t\t\t\t\"\",\r\n\t\t\t\t\t\t\t\"pm.test(\\\"response body has json with request queries\\\", function () {\",\r\n\t\t\t\t\t\t\t\"    pm.response.to.have.jsonBody('args.foo1', 'foo1_data');\",\r\n\t\t\t\t\t\t\t\"});\",\r\n\t\t\t\t\t\t\t\"\",\r\n\t\t\t\t\t\t\t\"\"\r\n\t\t\t\t\t\t],\r\n\t\t\t\t\t\t\"type\": \"text/javascript\"\r\n\t\t\t\t\t}\r\n\t\t\t\t},\r\n\t\t\t\t{\r\n\t\t\t\t\t\"listen\": \"prerequest\",\r\n\t\t\t\t\t\"script\": {\r\n\t\t\t\t\t\t\"id\": \"d9a6d283-0547-4c13-a6dd-64ed2471743e\",\r\n\t\t\t\t\t\t\"exec\": [\r\n\t\t\t\t\t\t\t\"\"\r\n\t\t\t\t\t\t],\r\n\t\t\t\t\t\t\"type\": \"text/javascript\"\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t],\r\n\t\t\t\"request\": {\r\n\t\t\t\t\"method\": \"GET\",\r\n\t\t\t\t\"header\": [],\r\n\t\t\t\t\"url\": {\r\n\t\t\t\t\t\"raw\": \"https://postman-echo.com/get?foo1=foo1_data&foo2={{$guid}}\",\r\n\t\t\t\t\t\"protocol\": \"https\",\r\n\t\t\t\t\t\"host\": [\r\n\t\t\t\t\t\t\"postman-echo\",\r\n\t\t\t\t\t\t\"com\"\r\n\t\t\t\t\t],\r\n\t\t\t\t\t\"path\": [\r\n\t\t\t\t\t\t\"get\"\r\n\t\t\t\t\t],\r\n\t\t\t\t\t\"query\": [\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"key\": \"foo1\",\r\n\t\t\t\t\t\t\t\"value\": \"foo1_data\"\r\n\t\t\t\t\t\t},\r\n\t\t\t\t\t\t{\r\n\t\t\t\t\t\t\t\"key\": \"foo2\",\r\n\t\t\t\t\t\t\t\"value\": \"{{$guid}}\"\r\n\t\t\t\t\t\t}\r\n\t\t\t\t\t]\r\n\t\t\t\t}\r\n\t\t\t},\r\n\t\t\t\"response\": []\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"name\": \"POST Second Check\",\r\n\t\t\t\"event\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"listen\": \"test\",\r\n\t\t\t\t\t\"script\": {\r\n\t\t\t\t\t\t\"id\": \"6033fafb-177c-4956-b3a1-bfefefb98307\",\r\n\t\t\t\t\t\t\"exec\": [\r\n\t\t\t\t\t\t\t\"pm.test(\\\"response is ok\\\", function () {\",\r\n\t\t\t\t\t\t\t\"    pm.response.to.have.status(200);\",\r\n\t\t\t\t\t\t\t\"});\",\r\n\t\t\t\t\t\t\t\"\",\r\n\t\t\t\t\t\t\t\"pm.test(\\\"response body has json with request body\\\", function () {\",\r\n\t\t\t\t\t\t\t\"    pm.response.to.have.jsonBody('data', \",\r\n\t\t\t\t\t\t\t\"        'This is expected to be sent back as part of response body.');\",\r\n\t\t\t\t\t\t\t\"});\"\r\n\t\t\t\t\t\t],\r\n\t\t\t\t\t\t\"type\": \"text/javascript\"\r\n\t\t\t\t\t}\r\n\t\t\t\t}\r\n\t\t\t],\r\n\t\t\t\"request\": {\r\n\t\t\t\t\"method\": \"POST\",\r\n\t\t\t\t\"header\": [],\r\n\t\t\t\t\"body\": {\r\n\t\t\t\t\t\"mode\": \"raw\",\r\n\t\t\t\t\t\"raw\": \"This is expected to be sent back as part of response body.\"\r\n\t\t\t\t},\r\n\t\t\t\t\"url\": {\r\n\t\t\t\t\t\"raw\": \"https://postman-echo.com/post\",\r\n\t\t\t\t\t\"protocol\": \"https\",\r\n\t\t\t\t\t\"host\": [\r\n\t\t\t\t\t\t\"postman-echo\",\r\n\t\t\t\t\t\t\"com\"\r\n\t\t\t\t\t],\r\n\t\t\t\t\t\"path\": [\r\n\t\t\t\t\t\t\"post\"\r\n\t\t\t\t\t]\r\n\t\t\t\t}\r\n\t\t\t},\r\n\t\t\t\"response\": []\r\n\t\t}\r\n\t],\r\n\t\"protocolProfileBehavior\": {}\r\n}",
    "ScriptTimeoutSec": 10,
    "DelayBetweenRequestsSec": 0,
    "CollectionTimeoutSec": 0,
    "RequestTimeoutSec": 0,
    "DNSResolveMode": "Device Cached",
    "DNSserverIP": "",
    "CustomDNSHosts": null,
    "Device_Id": 270071,
    "Id": 499954,
    "Task_Type_Id": 30,
    "Name": "postman"
}

 Fields Description

Field Type Required/Optional Description
JsonData

string

required

 The JSON file with the Postman Collection.
Device_Id

int32

required

READ ONLY Field. Unique device ID.
ScriptTimeoutSec

int32

optional

The Script Timeout intervalmeasured in seconds, is the length of time the device should wait for the assertion script to complete before ending the task and returning an error. The maximum script timeout is 30 seconds.
DelayBetweenRequestsSec

int32

optional

The Delay Between Requests, measured in seconds, is the time between each request in the collection. By default, we use the Delay time set in Postman Collection Runner.
CollectionTimeoutSec

int32

optional

The Collection Timeoutmeasured in seconds, is the length of time the device should wait for the requests to complete and collection execution before ending the task and returning an error.
RequestTimeoutSec

int32

optional

The Request Timeout interval, measured in seconds, is the length of time the device should wait for a response on a single request from the collection.
DNSResolveMode string optional POSSIBLE VALUES:

  • Device Cached
  • Non Cached
  • TTL Cached
  • External DNS Server

For detailed explanation please see the “DNS Mode Option” article.

DNSserverIP string optional Field for a custom DNS server IP address.

For detailed explanation please see the “DNS Mode Option” article.

Id

int32

required

*Only for edit operations

READ ONLY Field. Unique task id.

Example:
"Id": 17715
Task_Type_Id

int32

required

Type of the task field.

Example:
"Task_Type_Id": 30
Name

string

optional

Task name.

Example:
"Task_Name""Postman"