Acceptance Criteria

Manage acceptance criterias in TeamPulse.

GET /acceptancecriteria/{id} - Get acceptance criteria by ID

GET /acceptancecriteria - Get all acceptance criterias for the projects to which user has access to.

GET /workitems/{workItemId}/acceptancecriteria - Get all acceptance criterias for a specific workitem

POST /acceptancecriteria - Create an acceptance criteria

PUT /acceptancecriteria/{id} - Update an acceptance criteria

DELETE /acceptancecriteria/{id} - Delete an acceptance criteria

Acceptance Criteria Model

The object representing an acceptance criteria has the following properties:

id: integer (Read-only) - ID of the acceptance criteria.

workItemId: integer (Required) - ID of the workitem to which the acceptance criteria belongs to.

projectId: integer - ID of the project to which the acceptance criteria belongs to.

title: string (Required) - Title of the acceptance criteria.

description: string - Description of the acceptance criteria.

status: string - Status of the acceptance criteria. Allowed statuses are 'Pass', 'Fail' and 'Not Executed'.

createdBy: string - The name of the user who created the acceptance criteria

createdAt: DateTime - The date when the acceptance criteria is created

lastModifiedBy: string - The name of the user who last modified the acceptance criteria

lastModifiedAt: DateTime - The date when the acceptance criteria is last modified

Resource Url

To make API requests use the URL [teampulse]/api/v1 where [teampulse] is the URL to the TeamPulse instance which you want to manage via the API.

Example:

[teampulse]/api/v1/acceptancecriteria

Get acceptance criteria

GET /acceptancecriteria/{id}

Response

HTTP/1.1 200

{
    "id": 1,
    "title": "title",
    "description": "description",
    "workItemId": 100,
    "projectId": 1,
    "status": "Not Executed",
    "createdBy": "Paul Smith",
    "createdAt": "2013-06-23T00:00:00",
    "lastModifiedBy": "Paul Smith",
    "lastModifiedAt": "2013-06-23T00:00:00"
}

Get acceptance criterias

GET /acceptancecriteria : Get all acceptance criterias for the projects to which user has access to.

GET /workitems/{workItemId}/acceptancecriteria : Get all acceptance criterias for a specific workitem

OData $filter and $orderby options can be supplied to filter and order the results. $top and $skip to get top N items and skip the top M. Read more how to use the OData options

Response

HTTP/1.1 200

{
  "totalResults": 3,
  "top": 3,
  "results": [
    {
      "id": 1,
      "title": "title 1",
      "description": "description 1",
      "workItemId": 100,
      "projectId": 1,
      "status": "Not Executed",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-23T00:00:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-23T00:00:00"
    },
    {
      "id": 2,
      "title": "title 2",
      "description": "description 2",
      "workItemId": 100,
      "projectId": 1,
      "status": "Not Executed",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-23T00:00:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-23T00:00:00"
    },
    {
      "id": 3,
      "title": "title 3",
      "description": "description 3",
      "workItemId": 100,
      "projectId": 1,
      "status": "Pass",
      "createdBy": "Paul Smith",
      "createdAt": "2013-06-23T00:00:00",
      "lastModifiedBy": "Paul Smith",
      "lastModifiedAt": "2013-06-23T00:00:00"
    }
  ]
}

Create an acceptance criteria

POST /acceptancecriteria

Request

{
  "title": "title",
  "workItemId": 100
}

Response

HTTP/1.1 201

{
  "id": 1,
  "title": "title",
  "description": "",
  "workItemId": 100,
  "projectId": 1,
  "status": "Not Executed",
  "createdBy": "Paul Smith",
  "createdAt": "2013-06-23T00:00:00",
  "lastModifiedBy": "Paul Smith",
  "lastModifiedAt": "2013-06-23T00:00:00"
}

Update an acceptance criteria

PUT /acceptancecriteria/{id}

Request

{
  "name": "title 1",
  "status": "Pass"
}

Response

HTTP/1.1 200

{
  "id": 1,
  "title": "title 1",
  "description": "",
  "workItemId": 100,
  "projectId": 1,
  "status": "Pass",
  "createdBy": "Paul Smith",
  "createdAt": "2013-06-23T00:00:00",
  "lastModifiedBy": "Paul Smith",
  "lastModifiedAt": "2013-06-23T00:00:00"
}

Delete an acceptance criteria

DELETE /acceptancecriteria/{id}

Response

HTTP/1.1 200