9.2.54. Ask Manual Question Sensor With Parameters And Some Supplied Parameters

Ask the question ‘Get Folder Contents{folderPath=C:Program Files} from all machines’, wait for result data to be complete, and get result data

9.2.54.1. Step 1 - Authenticate to the SOAP API via /auth

1
2
3
4
5
6
7
8
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip, deflate",
  "Connection": "keep-alive",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "password": "VGFuaXVtMjAxNSE=",
  "username": "QWRtaW5pc3RyYXRvcg=="
}
  • Response Headers:
1
2
3
4
5
{
  "connection": "keep-alive",
  "content-length": "134",
  "content-type": "text/plain; charset=us-ascii"
}

9.2.54.2. Step 2 - Get the server version via /info.json

1
2
3
4
5
6
7
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip, deflate",
  "Connection": "keep-alive",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
{
  "connection": "keep-alive",
  "content-length": "20906",
  "content-type": "application/json"
}

9.2.54.3. Step 3 - Issue a GetObject to get the full object of a sensor for inclusion in a Select for a Question

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "567",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.4. Step 4 - Issue an AddObject to add a Question object

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "758",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
{
  "connection": "keep-alive",
  "content-length": "766",
  "content-type": "text/xml;charset=UTF-8"
}

9.2.54.5. Step 5 - Issue a GetObject on the recently added object in order to get the full object

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "492",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.6. Step 6 - Issue a GetResultInfo for a Question to check the current progress of answers

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "496",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.7. Step 7 - Issue a GetResultInfo for a Question to check the current progress of answers

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "496",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.8. Step 8 - Issue a GetResultInfo for a Question to check the current progress of answers

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "496",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.9. Step 9 - Issue a GetResultInfo for a Question to check the current progress of answers

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "496",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.54.10. Step 10 - Issue a GetResultData to get answers for a question

1
2
3
4
5
6
7
8
9
{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "524",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-689-2a03816e698477276b936587ef80b2c3696518452227d8e8f1747447823783356f9e029f79978f954eb61cfe1e5140342fe4bb930edb8377d4cbe67225b2a73e"
}
  • Response Headers:
1
2
3
4
5
6
{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

Footnotes

[1]this file automatically created by BUILD/build_api_examples.py