TestLists
TestLists ArtOfTest.WebAii.Design.Execution.TestList Collection
TestLists are containers for a group of Tests.
GET /TestLists GET testlists 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 testlists 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

/TestLists?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 testlist 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 testlists. Defaults to true.
query [String]
Filter for testlist result set. Query format: 
{"Data.Key" : "Value", "Data.Key2" : "Value2" }
fields [String]
Filter to limit the fields returned on a testlist. Fields format: Data.FieldToInclude, Data.AnotherFieldToInclude ,Metadata

Returns

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

Parameters

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

Returns

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

Parameters

/TestLists?schema={schema}&name={name}&parentId={parentId}
schema [String]
Optional identifier for the testlist being stored. This will be stored in the Metadata object of the created testlist.
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 testlist and the custom added Header contains the Meadata for the newly created testlist 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: testlist succesfully created. Added Header contains the metadata for the newly created testlist.
400
Bad Request: Attachements are present without Content-Ids.
400
Bad Request: Attachements are present without refereneces.
PUT /TestLists/{id} Update a testlist in the testlist collection
The request body should contain the json representation of the testlist 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 testlist 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 testlist }
     --4c90d0f5-e0b0-4806-b9a1-214c3513b60d
     Content-Type: multipart/mixed
     Content-Disposition: attachment; filename="name.extension"
     file data

Parameters

/TestLists/{id}?lastUpdate={lastUpdate}
id [String] required
The identifier of the testlist to update
lastUpdate [String] required
The timestamp of last update for this testlist.
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 testlist and the custom Updated header contains the updated testlist 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 testlist.
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 testlist's last updated timestamp.
409
Conflict: testlist has been previously deleted.
DELETE /TestLists/{id} Remove a testlist from the testlist collection
Note: this does not perform a hard delete. The testlist is tombstoned in the collection.

Parameters

/TestLists/{id}?lastUpdate={lastUpdate}
id [String] required
The identifier of the testlist to remove.
lastUpdate [String] required
The timestamp of last update for this testlist.
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 testlist's last updated timestamp.
409
Conflict: testlist has been previously deleted.