Tests
Tests Collection
The collection contains multiple types of tests: web test ArtOfTest.WebAii.Design.ProjectModel.Test and load test Telerik.TestStudio.Load.LoadDesignTest
GET /Tests GET tests via query. Note that this does NOT currently return attachments.
Returns the ENTIRE document including OID and Metadata, unless fields parameter or header is specified.
You may limit the number of tests returned by using the optional query parameter or header.
When used as a header the format is
     
Query: { "Data.FieldToCompare" : "Value" }
.
Equality is via implication only: 
{ "field": "value" }
and the following operators are supported:
    
$and, $ne, $gt, $lt, $gte, $lte
Example operator usage:
     
Query:
{
    "Metadata.LastUpdate": {
        "$gt": "2012-08-15"
    }
}

Parameters

/Tests?skip={skip}&take={take}&sortKeys={sortKeys}&schema={schema}&includeDeleted={includeDeleted}&query={query}&fields={fields}
skip [Int32]
Starting point for paging. Defaults to 0.
take [Int32]
End point for paging. Defaults to 100.
sortKeys [String]
Comma seperated list of fields to sort the test result set on. NOTE: Not implemented.
schema [String]
Identifier for the object being stored.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
includeDeleted [Boolean]
Boolean indicating wheter to fetch deleted tests. Defaults to true.
query [String]
Filter for test result set. Query format: 
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields [String]
Filter to limit the fields returned on a test. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata

Returns

An array of IStorageDataEntity objects 
{
    "Id": "string",
    "Metadata": "IStorageDataMetadata",
    "Data": "json representaion of test"
}
HTTP Status
Reason
200
OK
400
Bad Request: Invalid arguments supplied.
GET /Tests/{id} GET a test by id. This will return attachments.
Retrieves the full test including attachments. When attachments are present the response's content type will be multipart/mixed.

Parameters

/Tests/{id}?includeDeleted={includeDeleted}
id [String] required
The identifier of the test being retreived
includeDeleted [Boolean]
Optional boolean indicating wheter to fetch deleted tests. Defaults to true.

Returns

IStorageDataEntity object: 
{
    "Id": "string",
    "Metadata": "IStorageDataMetadata",
    "Data": "json representaion of test"
}
HTTP Status
Reason
200
OK
400
Bad Request: id parameter not supplied.
404
Not Found: test does not exist.
410
Gone: test is deleted when request supplies includeDeleted parameter as false.
POST /Tests Add a new test (or tests) to the test collection
The request body should contain the json representation of the test or tests to add.
Example: 
{ "Key" : "NewValue", "Key2" : "NewValue2", ... }
Note: This handles "bulk upload" of several tests with any number of associated attachments.
Attachments can be re-used (associated with multiple Json tests). When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example:
    
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"
     --4c90d0f5-e0b0-4806-b9a1-214c3513b60d
     Content-Type: application/json; charset=utf-8
     { Json representation of test }
     --4c90d0f5-e0b0-4806-b9a1-214c3513b60d
     Content-Type: multipart/mixed
     Content-Disposition: attachment; filename="name.extension"
     file data

Parameters

/Tests?schema={schema}&name={name}&parentId={parentId}
schema [String]
Optional identifier for the test being stored. This will be stored in the Metadata object of the created test.
Example: "Telerik.TestStudio.Shared.Communication.Transports.TestListResultTransport"
name [String]
Allows the inclusion of a name for metadata tagging (and Activity creation)
parentId [String]
Allows the inclusion of a Parent Id for metadata tagging (and Activity creation)

Returns

201 Created. The response body will contain the created test and the custom added Header contains the Meadata for the newly created test in json format.
Example Added custom header:     
Added:
{
    "Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
    "Metadata": {
        "Name": null,
        "ParentId": null,
        "LastUpdate": "2013-06-17T15:00:18.336Z",
        "LastUpdatedBy": "storageservice",
        "Schema": "",
        "Deleted": false,
        "AttachmentIds": null,
        "Tag": null
    },
    "Data": null
}
HTTP Status
Reason
201
Created: test succesfully created. Added Header contains the metadata for the newly created test.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT /Tests/{id} Update a test in the test collection
The request body should contain the json representation of the test to update.
Example:
    
{ "Data.Key" : "NewValue", "Data.Key2" : "NewValue2" }

Note: Keys for Data values must be prefixed with "Data." qualifier.
When adding an attachment to a test the request content type must be set to Content-Type: multipart/mixed.
Example: 
Content-Type: multipart/mixed; boundary="4c90d0f5-e0b0-4806-b9a1-214c3513b60d"

     --4c90d0f5-e0b0-4806-b9a1-214c3513b60d
     Content-Type: application/json; charset=utf-8
     { Json representation of test }
     --4c90d0f5-e0b0-4806-b9a1-214c3513b60d
     Content-Type: multipart/mixed
     Content-Disposition: attachment; filename="name.extension"
     file data

Parameters

/Tests/{id}?lastUpdate={lastUpdate}
id [String] required
The identifier of the test to update
lastUpdate [String] required
The timestamp of last update for this test.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)

Returns

200 OK. The response body contains the updated test and the custom Updated header contains the updated test metadata.
Example custom Updated header:
Updated:
{
    "UpdatedDocuments": [
        {
            "Id": "516e8725-3c0e-4f6b-8b98-d5507429d609",
            "Metadata": {
                "Name": null,
                "ParentId": null,
                "LastUpdate": "2013-06-17T15:14:16.0482808Z",
                "LastUpdatedBy": "storageservice",
                "Schema": "",
                "Deleted": false,
                "AttachmentIds": null,
                "Tag": null
            },
            "Data": null
        }
    ]
}
HTTP Status
Reason
200
OK. Updated header will contain metadata for updated test.
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match test's last updated timestamp.
409
Conflict: test has been previously deleted.
DELETE /Tests/{id} Remove a test from the test collection
Note: this does not perform a hard delete. The test is tombstoned in the collection.

Parameters

/Tests/{id}?lastUpdate={lastUpdate}
id [String] required
The identifier of the test to remove.
lastUpdate [String] required
The timestamp of last update for this test.
Dates are stored in UTC and should be in ISO-8601 format(yyyy-MM-ddTHH:mmm:ssss.fffZ)

Returns

200 OK
HTTP Status
Reason
200
OK
400
Bad Request: id parameter is not supplied.
400
Bad Request: lastUpdate is not in the correct date format. All dates must be UTC in ISO-8601 format (yyyy-MM-ddTHH:mmm:ssss.fffZ).
400
Bad Request: lastUpdate parameter is not supplied.
409
Conflict: lastUpdate does not match test's last updated timestamp.
409
Conflict: test has been previously deleted.