GET/projects/{ProjectId}/requirements/{Id}

Applies to QAComplete 12.80 SaaS, last modified on April 20, 2021

Gets information on a requirement from QAComplete.

Use the operation to get information on a requirement specified by its ID.

To get information on all the requirements registered in a QAComplete project, use the …/requirements (GET) operation.

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must belong to a security group that has the Read privilege for Requirements.

Request Format

To get information on a requirements, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/projects/{ProjectId}/requirements/{Id}

ProjectId  :  integer, required

The ID of the project, to which the requirement belongs.

Id  :  integer, required

The ID of the requirement you want to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/projects/11873/requirements/1 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/projects/11873/requirements/1

Response Format

On success, the operation responds with HTTP status code 200 and returns a JSON object with the requirement information.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1664


{
  "id": 1,
  "title": "Add Visual Studio Integration",
  "status": "Active",
  "active": "true",
  "project_id": 11873,
  "__permissions": {
    "acl": 7
  },
  "act_finish": "2015-08-22T17:00:00.0000000",
  "act_hrs": 36.100,
  "act_start": "2015-08-14T08:00:00.0000000",
  "assigned_to_name": "Smith, John",
  "assignee_user_id": 25263,
  "business_rule": "br1",
  "comments": "comment 1",
  "custom_fields": [
    {
      "id": "Custom1",
      "name": "Area",
      "value": "Integration"
    }
  ],
  "date_created": "2015-08-10T09:19:39.8030000",
  "date_last_escalated": "2015-08-16T08:30:00.0000000",
  "date_opened": "2015-08-14T10:28:36.7130000",
  "date_updated": "2015-08-15T10:19:39.8030000",
  "description": "Add integration with Microsoft Visual Studio",
  "est_finish": "2015-08-14T17:00:00.0000000",
  "est_hrs": 20.000,
  "est_hrs_remaining": 2,
  "est_start": "2015-08-12T08:00:00.0000000",
  "folder_id": 10,
  "folder_name": "Integration",
  "grouping": "IDE",
  "import_id": 0,
  "keywords": "Integration",
  "last_escalation_rule": "rule1",
  "last_escalation_rule_id": 271,
  "nbr_escalations": 1,
  "nbr_events": 0,
  "nbr_files": 0,
  "nbr_files_not_secured": 0,
  "nbr_notes": 1,
  "nbr_tasks": 0,
  "notes_description": "note 1",
  "opened_by": 25263,
  "opened_by_company": "EDGB",
  "opened_by_email": "john.smith@edgb.com",
  "opened_by_name": "Smith, John",
  "original_id": 0,
  "owner_name": "Smith, John",
  "owner_user_id": 24663,
  "pct_complete": 90,
  "subgrouping": "Other",
  "update_user_id": 24663,
  "user_name": "Smith, John"
}

Error responses

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

If the project with the specified ProjectId does not exist or the authenticating user does not have rights to access the project, the operation returns the Access is denied error.

If the requirement with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Requirements Resources

Highlight search results