9.2.52. Ask Manual Question Simple Single Sensor Sse¶

Ask the question ‘Get Computer Name from all machines’, wait for result data to be complete, and get result data

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

URL: https://10.0.1.240:443/auth
HTTP Method: GET
Elapsed Time: 0:00:00.014375
Step 1 Request Body
Step 1 Response Body
Request Headers:

{
  "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:

{
  "connection": "keep-alive",
  "content-length": "134",
  "content-type": "text/plain; charset=us-ascii"
}

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

URL: https://10.0.1.240:443/info.json
HTTP Method: GET
Elapsed Time: 0:00:00.035130
Step 2 Request Body
Step 2 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-length": "20906",
  "content-type": "application/json"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.270664
Step 3 Request Body
Step 3 Response Body
Request Headers:

{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "565",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.012705
Step 4 Request Body
Step 4 Response Body
Request Headers:

{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "639",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-length": "766",
  "content-type": "text/xml;charset=UTF-8"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.019470
Step 5 Request Body
Step 5 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.033041
Step 6 Request Body
Step 6 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.210846
Step 7 Request Body
Step 7 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

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

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.161301
Step 8 Request Body
Step 8 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "text/xml;charset=UTF-8",
  "transfer-encoding": "chunked"
}

9.2.52.9. Step 9 - Issue a GetResultData to start a Server Side Export and get an export_id¶

URL: https://10.0.1.240:443/soap
HTTP Method: POST
Elapsed Time: 0:00:00.007986
Step 9 Request Body
Step 9 Response Body
Request Headers:

{
  "Accept": "*/*",
  "Accept-Encoding": "gzip",
  "Connection": "keep-alive",
  "Content-Length": "556",
  "Content-Type": "text/xml; charset=utf-8",
  "User-Agent": "python-requests/2.7.0 CPython/2.7.10 Darwin/14.5.0",
  "session": "1-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "connection": "keep-alive",
  "content-length": "874",
  "content-type": "text/xml;charset=UTF-8"
}

9.2.52.10. Step 10 - Perform an HTTP get to retrieve the status of a server side export¶

URL: https://10.0.1.240:443/export/1/495576668976.xml.status
HTTP Method: GET
Elapsed Time: 0:00:00.017106
Step 10 Request Body
Step 10 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "content-length": "27",
  "content-type": "application/octet-stream"
}

9.2.52.11. Step 11 - Perform an HTTP get to retrieve the data of a server side export¶

URL: https://10.0.1.240:443/export/1/495576668976.xml.gz
HTTP Method: GET
Elapsed Time: 0:00:00.016918
Step 11 Request Body
Step 11 Response Body
Request Headers:

{
  "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-686-e3a7d7eebdd64d851b738f6be2ffd5f52a869a1eae15bd756d92c00c65eb269284b788acb904193d734b983c59ef3811de6c71c3ed830d1f747bffdb2ac3f08a"
}

Response Headers:

{
  "content-encoding": "gzip",
  "content-length": "229",
  "content-type": "application/octet-stream"
}

Footnotes

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