Back to Customer API documentation

Customer REST API Method: results/update

This method is used to update the properties of a result. Currently the only operation supported by this is to set the compatibility state of a result (whether it appears with a green tick or red cross in the Litmus web interface). This is set via the check_state parameter which support either 'ticked', 'crossed' or 'nostate' as valid values. A result which returns nil for check_state is considered to be 'nostate'.

URL:

https://#{company}.litmus.com/tests/#{test-id}/versions/#{version}/results/#{result-id}.xml

HTTP Method(s):

PUT

Parameters:

• test-id.  Required. The ID of the test you wish to retrieve
• version. Required. The version of this test you wish to retrieve.
• result-id. Required. The ID of the result you wish to retrieve.

Request: 

          XML example: 

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <check_state>ticked</check_state>
</result>

Response: 

       XML example (truncated): 

<?xml version="1.0" encoding="UTF-8"?>
<result>
  <check_state>ticked</check_state>
  <error_at</> type="datetime" nil="true"></error_at>
  <finished_at type="datetime" nil="true"></finished_at>
  <id type="integer">1284884</id>
  <started_at type="datetime" nil="true"></started_at>
  <test_code>saf2</test_code>
  <state>pending</state>
  <result_type>page</result_type>
  <testing_application>
    <average_time_to_process type="integer">162</average_time_to_process>
    <result_type>page</result_type>
    <popular>false</popular>
    <status>0</status>
    <platform_name>Mac OS</platform_name>
    <platform_long_name>Mac OS X</platform_long_name>
    <application_code>saf2</application_code>
    <application_long_name>Safari 2.0 OSX</application_long_name>
  </testing_application>
  <result_images type="array">
    <result_image>
      <image_type>full</image_type>
    </result_image>
    <result_image>
      <image_type>window</image_type>
    </result_image>
  </result_images>
</result>