Goals
Goals Telerik.TestStudio.Load.Common.Goal collection
Goals are part of the definition of a load test.
Example: 
{
    "Data": {
        "Id": "string",
        "ResultId": "string",
        "Description": "string",
        "Success": "boolean",
        "MetricName": "string",
        "MachineName": "string",
        "IsCustomGoal": "string",
        "Threshold": "double",
        "Operator": "string",
        "PassWhenGoalMet": "boolean",
        "StopWhenGoalMet": "boolean"
    },
    "Metadata": "MetaData object"
}
GET /Goals GET goals 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 goals 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

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

Returns

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

Parameters

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

Returns

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

Parameters

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

Parameters

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

Parameters

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