|
What is a REST API
|
REST (representational state transfer) is an approach for getting information
content from a Web site by reading a designated Web page that contains an
XML (Extensible Markup Language) file that describes and includes the desired
content.
As described in a dissertation by Roy Fielding, REST is an "architectural style" that basically
exploits the existing technology and protocols of the Web, including HTTP (Hypertext Transfer Protocol)
and XML. For more information on REST, please read this article at
wikipedia
|
|
What is JSON
|
JSON, short for JavaScript Object Notation, is a lightweight computer data interchange format.
It is a text-based, human-readable format for representing simple data structures and associative arrays
(called objects).
We are using JSON, because its more human readable than XML, is more light weight
and easier to use in AJAX applications. For more information on JSON please visit
the JSON web site
|
|
How to call the API
|
Before you can call the Web services , you will need to have an API Key. Please reach out
to the TraceCloud sales team to receive your API Key. Each key comes with a daily
limit on how many calls you can make, so please work with your TraceCloud team
to figure out the expected number of daily API calls.
|
|
Web services usage
|
The Web services can be used to programmatically manipulate your Requirements data.
For examples you can a) Get the list of projects you have access too and b) for these
projects get the list of Requirements Types, Folder, Reports and Users and c) get the
list of Requirements in each of those sets and d) manipulate the Requirements.
Every call returns 2 mandatory parameters, a) responseStatus which is set to 'success' or
'error' and b) errorMessage which is either empty or has an error message.
|
|
API Calls
|
Get My Projects
|
Close
|
Title
Get My projects
|
Description
Returns a list of projects
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
Action name to return the list of projects |
String |
Value : getMyProjects |
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=getMyProjects
|
Sample Result
{
"errorMessage": "",
"projects": [
{
"createdBy": "sami@tracecloud.com",
"description": "Account Summary Tool updating",
"name": "Account Summary Tool - Sanbox",
"prefix": "AST",
"lastModifiedBy": "sami@tracecloud.com",
"projectId": 30,
"restrictedDomains": "tracecloud.com,verisign.com,cisco.com"},
{
"createdBy": "sami@tracecloud.com",
"description": "we are using this projec to track the requirements
for developing the TraceCloud system. It's part of our effort to
bootstrap our application and to feel the pain points experienced
by a typical Requirements Management user..",
"name": "Trace Cloud Development",
"prefix": "TCD",
"lastModifiedBy": "sami@tracecloud.com",
"projectId": 19,
"restrictedDomains": "tracecloud.com,yahoo.com,gmail.com,hotmail.com"}],
"responseStatus": "success"}
|
|
Get Project Details
|
Close
|
Title
Get Project Details
|
Description
Returns project details
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
Action name to return the details of a specified project |
String |
Value : getProjectDetails |
| projectId |
Required |
The id of the project |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getProjectDetails&projectId=19
|
Sample Result
{
"errorMessage": "",
"projectDetails": {
"createdBy": "sami@tracecloud.com",
"description": "we are using this projec to track the requirements for developing
the TraceCloud system. It's part of our effort to bootstrap our application and
to feel the pain points experienced by a typical Requirements Management user..",
"name": "Trace Cloud Development",
"prefix": "TCD",
"lastModifiedBy": "sami@tracecloud.com",
"projectId": 19,
"restrictedDomains": "tracecloud.com,yahoo.com,gmail.com,hotmail.com"},
"responseStatus": "success"}
|
|
Get All Requirement Types in a Project
|
Close
|
Title
Get Requirement Types
|
Description
Returns requirement types
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
Action name to return the requirement types of a specified project |
String |
Value : getProjectRequirementTypes |
| projectId |
Required |
The id of the project |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getProjectRequirementTypes&projectId=39
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"requirementTypes": [
{
"createdBy": "a@b.com",
"description": "pew",
"name": "pew",
"prefix": "pew",
"requirementTypeId": 361,
"lastModifiedBy": "a@b.com",
"enableApproval": 0,
"rootFolderId": 442,
"attributes": [
],
"projectId": 39},
{
"createdBy": "a@b.com",
"description": "d",
"name": "d",
"prefix": "d",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"enableApproval": 0,
"rootFolderId": 441,
"attributes": [
{
"attributeDefaultValue": "bug",
"attributeDescription": "type",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 45,
"attributeType": "Drop Down",
"attributeName": "type",
"attributeDropDownOptions": "enhancement,bug",
"createdBy": "a@b.com",
"attributeSortOrder": "1",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"attributeRequired": 1,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "3",
"attributeDescription": "sev",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 47,
"attributeType": "Drop Down",
"attributeName": "severity",
"attributeDropDownOptions": "1,2,3,4,5",
"createdBy": "a@b.com",
"attributeSortOrder": "2",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"attributeRequired": 1,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "fsd",
"attributeDescription": "fdafadattributeImpactsVersion=0",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 48,
"attributeType": "Text Box",
"attributeName": "test",
"attributeDropDownOptions": "",
"createdBy": "a@b.com",
"attributeSortOrder": "2",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"attributeRequired": 0,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "",
"attributeDescription": "fdsattributeImpactsVersion=1",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 49,
"attributeType": "Text Box",
"attributeName": "test2",
"attributeDropDownOptions": "",
"createdBy": "a@b.com",
"attributeSortOrder": "2",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"attributeRequired": 0,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "yes",
"attributeDescription": "impact",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 46,
"attributeType": "Drop Down",
"attributeName": "impact to customer",
"attributeDropDownOptions": "yes,no",
"createdBy": "system",
"attributeSortOrder": "3",
"requirementTypeId": 360,
"lastModifiedBy": "system",
"attributeRequired": 0,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "",
"attributeDescription": "test",
"attributeImpactsApprovalWorkflow": 1,
"attributeImpactsTraceability": 0,
"attributeId": 50,
"attributeType": "Text Box",
"attributeName": "test3",
"attributeDropDownOptions": "",
"createdBy": "a@b.com",
"attributeSortOrder": "f",
"requirementTypeId": 360,
"lastModifiedBy": "a@b.com",
"attributeRequired": 0,
"attributeImpactsVersion": 1}],
"projectId": 39},
"projectId": 39},
{
"createdBy": "a@b.com",
"description": "Default Test Result type created by the system.
These are usually created by Test Engineers prior to Go Live",
"name": "Test Results",
"prefix": "TR",
"requirementTypeId": 215,
"lastModifiedBy": "a@b.com",
"enableApproval": 0,
"rootFolderId": 272,
"attributes": [
{
"attributeDefaultValue": "",
"attributeDescription": "testbustcache=1248999937062",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 37,
"attributeType": "Text Box",
"attributeName": "test",
"attributeDropDownOptions": "",
"createdBy": "a@b.com",
"attributeSortOrder": "a",
"requirementTypeId": 215,
"lastModifiedBy": "a@b.com",
"attributeRequired": 0,
"attributeImpactsVersion": 0}],
"projectId": 39}]}
|
|
Get All Folders in a Project
|
Close
|
Title
Get folders
|
Description
Returns folders
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the folders of a specified project |
String |
Value : getProjectFolders |
| projectId |
Required |
The id of the project |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getProjectFolders&projectId=19
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"folders": [
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"createdBy": "system",
"requirementTypeName": "Release",
"folderOrder": 1,
"description": "Default folder used to storeRelease",
"requirementTypeId": 113,
"name": "Release",
"lastModifiedBy": "system",
"folderPath": "Release",
"parentFolderId": 0,
"projectId": 19,
"folderLevel": 1,
"folderId": 114}},
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"createdBy": "system",
"requirementTypeName": "Business Requirements",
"folderOrder": 2,
"description": "Default folder used to storeBusiness Requirements",
"requirementTypeId": 114,
"name": "Business Requirements",
"lastModifiedBy": "system",
"folderPath": "Business Requirements",
"parentFolderId": 0,
"projectId": 19,
"folderLevel": 1,
"folderId": 115}},
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"createdBy": "sami@tracecloud.com",
"requirementTypeName": "Test Results",
"folderOrder": 0,
"description": "Y",
"requirementTypeId": 118,
"name": "TEST",
"lastModifiedBy": "sami@tracecloud.com",
"folderPath": "Test Results\/TEST",
"parentFolderId": 119,
"projectId": 19,
"folderLevel": 2,
"folderId": 251}}]}
|
|
Get All Users in a Project
|
Close
|
Title
Get users
|
Description
Returns users in a project
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the users of a specified project |
String |
Value : getProjectUsers |
| projectId |
Required |
The id of the project |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getProjectUsers&projectId=19
|
Sample Result
{
"errorMessage": "",
"users": [
{
"lastName": "Developer",
"emailId": "qa_dev_1@tracecloud.com",
"userId": 4,
"firstName": "Josh",
"userType": "readWrite"},
{
"lastName": "Marketing",
"emailId": "qa_mktg_1@tracecloud.com",
"userId": 2,
"firstName": "Richard ",
"userType": "readWrite"},
{
"lastName": "Roy",
"emailId": "sami@tracecloud.com",
"userId": 1,
"firstName": "Shambhavi",
"userType": "readWrite"},
{
"lastName": "sdfd",
"emailId": "shambhaviroy@gmail.com",
"userId": 7,
"firstName": "sdfd",
"userType": "expired"},
{
"lastName": "Reddy",
"emailId": "sreenatht1@yahoo.com",
"userId": 11,
"firstName": "San",
"userType": "expired"}],
"responseStatus": "success"}
|
|
Get All Reports in a Project
|
Close
|
Title
Get project reports
|
Description
Returns reports
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the reports of a specified project |
String |
Value : getProjectReports |
| projectId |
Required |
The id of the project |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getProjectReports&projectId=19
|
Sample Result
{
"errorMessage": "",
"reports": [
{
"reportType": "list",
"createdBy": "qa_mktg_1@tracecloud.com",
"reportDefinition": "projectId:--:19:###:folderId:--:121:###:active:--:
active:###:danglingSearch:--:all:###:orphanSearch:--:all:###:completedSearch
:--:all:###:incompleteSearch:--:all:###:suspectUpStreamSearch:--:all:
###:suspectDownStreamSearch:--:all:###:includeSubFoldersSearch:--:no:
###:nameSearch:--::###:descriptionSearch:--::###:ownerSearch:--::###:
externalURLSearch:--::###:traceToSearch:--::###:traceFromSearch:--::
###:statusSearch:--::###:prioritySearch:--::###:pctCompleteSearch:--:",
"reportDescription": "Canned report created by the system to display ALL
the Requirements in this folder.",
"traceTreeDepth": 1,
"projectId": 19,
"reportName": "All Requirements",
"reportId": 802,
"reportVisibility": "public",
"folderId": 121},
{
"reportType": "list",
"createdBy": "qa_mktg_1@tracecloud.com",
"reportDefinition": "projectId:--:19:###:folderId:--:122:###:active:--:
active:###:danglingSearch:--:all:###:orphanSearch:--:all:###:completed
Search:--:all:###:incompleteSearch:--:all:###:suspectUpStreamSearch:--
:all:###:suspectDownStreamSearch:--:all:###:includeSubFoldersSearch:--
:no:###:nameSearch:--::###:descriptionSearch:--::###:ownerSearch:--:
:###:externalURLSearch:--::###:traceToSearch:--::###:traceFromSearch
:--::###:statusSearch:--::###:prioritySearch:--::###:pctCompleteSearch:--:",
"reportDescription": "Canned report created by the system to display
ALL the Requirements in this folder.",
"traceTreeDepth": 1,
"projectId": 19,
"reportName": "All Requirements",
"reportId": 810,
"reportVisibility": "public",
"folderId": 122},
{
"reportType": "traceTree",
"createdBy": "qa_mktg_1@tracecloud.com",
"reportDefinition": "projectId:--:19:###:folderId:--:136:###:active:--:
active:###:danglingSearch:--:all:###:orphanSearch:--:all:###:completedSearch
:--:all:###:incompleteSearch:--:all:###:suspectUpStreamSearch:--:all:###:
suspectDownStreamSearch:--:all:###:includeSubFoldersSearch:--:no:###:nameSearch
:--::###:descriptionSearch:--::###:ownerSearch:--::###:externalURLSearch:--::
###:traceToSearch:--::###:traceFromSearch:--::###:statusSearch:--::###:
prioritySearch:--::###:pctCompleteSearch:--:",
"reportDescription": "Canned report created by the system to
display ALL the Requirements in this folder.",
"traceTreeDepth": 3,
"projectId": 19,
"reportName": "All Requirements",
"reportId": 929,
"reportVisibility": "public",
"folderId": 136}],
"responseStatus": "success"}
|
|
Get Details of a Requirement Type
|
Close
|
Title
Get requirement type details
|
Description
Returns the details of a requirement type
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the details of a requirement type |
String |
Value : getRequirementTypeDetails |
| RequirementTypeId |
Required |
The id of the requirement type |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementTypeDetails&requirementTypeId=114
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"requirementTypeDetails": {
"createdBy": "sami@tracecloud.com",
"description": "Default Business Requirement type created by the system.
These are high level requirements usually created by business analysts
prior to Business Commit",
"name": "Business Requirements",
"prefix": "BR",
"requirementTypeId": 114,
"lastModifiedBy": "sami@tracecloud.com",
"enableApproval": 1,
"rootFolderId": 115,
"attributes": [
{
"attributeDefaultValue": "Bug",
"attributeDescription": "To describe a bug or enhancement",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 6,
"attributeType": "Drop Down",
"attributeName": "Type",
"attributeDropDownOptions": "Bug, Enhancement",
"createdBy": "system",
"attributeSortOrder": "1",
"requirementTypeId": 114,
"lastModifiedBy": "system",
"attributeRequired": 1,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "3",
"attributeDescription": "Severity describes the severity of the bug
or enhancement, 1 is the highest severity and 6 is the lowest. ",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 7,
"attributeType": "Drop Down",
"attributeName": "Severity",
"attributeDropDownOptions": "1,2,3,4,5,6",
"createdBy": "sami@tracecloud.com",
"attributeSortOrder": "2",
"requirementTypeId": 114,
"lastModifiedBy": "sami@tracecloud.com",
"attributeRequired": 1,
"attributeImpactsVersion": 0},
{
"attributeDefaultValue": "yes",
"attributeDescription": "iimpact to customer",
"attributeImpactsApprovalWorkflow": 0,
"attributeImpactsTraceability": 0,
"attributeId": 8,
"attributeType": "Drop Down",
"attributeName": "Impact to customer",
"attributeDropDownOptions": "yes,no",
"createdBy": "sami@tracecloud.com",
"attributeSortOrder": "3",
"requirementTypeId": 114,
"lastModifiedBy": "sami@tracecloud.com",
"attributeRequired": 0,
"attributeImpactsVersion": 0}],
"projectId": 19}}
|
|
Get All Requirements in a Requirement Type
|
Close
|
Title
Get requirements of a requirement type
|
Description
Returns requirements of a requirement type
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the requirements of a requirement type |
String |
Value : getRequirementsInRequirementType |
| requirementTypeId |
Required |
The id of the requirement type |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementsInRequirementType&requirementTypeId=114
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"requirementTypeDetails": {
"createdBy": "sami@tracecloud.com",
"description": "Default Business Requirement type created by the system.
These are high level requirements usually created by business analysts
prior to Business Commit",
"name": "Business Requirements",
"prefix": "BR",
"requirementTypeId": 114,
"lastModifiedBy": "sami@tracecloud.com",
"enableApproval": 1,
"projectId": 19,
"requirements": [
{
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 2,
"userDefinedAttributes": "Type:#:Bug:##:Severity:#:3:##:Impact to
customer:#:yes",
"folderPath": "Business Requirements\/Word Integration",
"traceFrom": "FR-324",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1517,
"traceTo": "REL-10",
"approvedByAllDt": "16 August 2009 03:43:58 PM ",
"folderId": 136,
"version": 1,
"fullTag": "BR-2",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "A user should be able to click on the link called
\"Generate Report\" and generate a report with the latest data for
all the embedded reports or requirements. The user should have the
ability to select a format for download (HTML, WORD 97-2003, WORD 2007). ",
"priority": "Medium",
"requirementTypeId": 114,
"name": "A user should be able to click on the link called \"Generate
Report\" and generate a report with the",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"},
{
"approvers": "",
"externalURL": "",
"status": "Draft",
"tag": 508,
"userDefinedAttributes": "Type:#:Bug:##:Severity:#:3:##:Impact
to customer:#:yes",
"folderPath": "Business Requirements\/Ideas",
"traceFrom": "",
"projectId": 19,
"deleted": 1,
"pctComplete": 0,
"requirementId": 66005,
"traceTo": "",
"approvedByAllDt": "N\/A",
"folderId": 130,
"version": 1,
"fullTag": "BR-508",
"createdBy": "sami@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "test
--Trace From : --Trace To :",
"priority": "Medium",
"requirementTypeId": 114,
"name": "test",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "sami@tracecloud.com"}]}}
|
|
Get Details of a Folder
|
Close
|
Title
Get Folder Details
|
Description
Returns folder details
|
URL
/RESTAPI
|
Method
GET
|
Parameters
| Query String Parameter |
Required/Optional |
Description |
Type |
Notes |
| Key |
Required |
the API key |
String |
|
| Action |
Required |
action name to return the details of a folder |
String |
Value : getFolderDetails |
| folderId |
Required |
The id of the folder |
Number |
|
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getFolderDetails&folderId=130
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"folderOrder": 0,
"description": "This folder is used to track the new Business Requirement
Ideas and we can use the collaboration mechanism to review these ideas,
before they can be assigned to a release. We use this to track both
bugs and new enhancement requests.",
"requirementTypeId": 114,
"name": "Ideas",
"lastModifiedBy": "qa_mktg_1@tracecloud.com",
"folderPath": "Business Requirements\/Ideas",
"parentFolderId": 115,
"projectId": 19,
"folderLevel": 2,
"folderId": 130}}}
|
|
Get All Requirements in a Folder
|
Close
|
Description
Gets all the Requirements in a Folder
|
Parameters
The API Key and Folder Id
|
Permissions
The caller has to be a member of the project in which this Folder exists
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementsInFolder&folderId=130
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"parentFolderId": 115,
"folderPath": "Business Requirements\/Ideas",
"projectId": 19,
"folderLevel": 2,
"requirements": [
{
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 325,
"userDefinedAttributes": "Type:#:Bug:##:Severity:#:3:##:Impact
to customer:#:yes",
"folderPath": "Business Requirements\/Ideas",
"traceFrom": "",
"projectId": 19,
"deleted": 1,
"pctComplete": 0,
"requirementId": 2178,
"traceTo": "REL-12",
"approvedByAllDt": "23 August 2009 09:34:16 AM ",
"folderId": 130,
"version": 1,
"fullTag": "BR-325",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "I showed this to you before. --Trace From : --Trace To :REL-12",
"priority": "Medium",
"name": "When the search result for text id comes, the side scroll bar
disappears even when the result is lon",
"lastModifiedBy": "qa_mktg_1@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"},
{
"approvers": "",
"externalURL": "",
"status": "Draft",
"tag": 565,
"userDefinedAttributes": "Type:#: Enhancement:##:Severity:#:1:##:Impact
to customer:#:yes",
"folderPath": "Business Requirements\/Ideas",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 0,
"requirementId": 93466,
"traceTo": "REL-13",
"approvedByAllDt": "N\/A",
"folderId": 130,
"version": 1,
"fullTag": "BR-565",
"createdBy": "sami@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "chnage comparision report that tracks which traces
have become suspect
",
"priority": "Medium",
"name": "chnage comparision report that tracks which traces have
become suspect",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "sami@tracecloud.com"}],
"folderId": 130,
"createdBy": "qa_mktg_1@tracecloud.com",
"description": "This folder is used to track the new Business Requirement Ideas
and we can use the collaboration mechanism to review these ideas, before they
can be assigned to a release. We use this to track both bugs and new
enhancement requests.",
"folderOrder": 0,
"requirementTypeName": "Business Requirements",
"name": "Ideas",
"requirementTypeId": 114,
"lastModifiedBy": "qa_mktg_1@tracecloud.com"}}
|
|
Get All Requirements owned by a user
|
Close
|
Description
Gets all the Requirements owned by a user
|
Parameters
The API Key and User Id
|
Permissions
The caller has to be a member of the project in which this Folder exists
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getUsersRequirements&userId=10&projectId=39
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"folderDetails": {
"lastName": "Roy",
"emailId": "sami@tracecloud.com",
"userId": 1,
"firstName": "Shambhavi",
"requirements": [
{
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 1,
"userDefinedAttributes": "",
"folderPath": "Test Cases",
"traceFrom": "TR-1",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1505,
"traceTo": "",
"approvedByAllDt": "15 August 2009 05:26:15 PM ",
"folderId": 118,
"version": 1,
"fullTag": "TC-1",
"createdBy": "sami@tracecloud.com",
"requirementTypeName": "Test Cases",
"description": "test",
"priority": "Medium",
"name": "test",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "sami@tracecloud.com"},
{
"approvers": "",
"externalURL": "",
"status": "Draft",
"tag": 565,
"userDefinedAttributes": "Type:#: Enhancement:##:Severity:#:1:
##:Impact to customer:#:yes",
"folderPath": "Business Requirements\/Ideas",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 0,
"requirementId": 93466,
"traceTo": "REL-13",
"approvedByAllDt": "N\/A",
"folderId": 130,
"version": 1,
"fullTag": "BR-565",
"createdBy": "sami@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "chnage comparision report that tracks which
traces have become suspect
",
"priority": "Medium",
"name": "chnage comparision report that tracks which traces
have become suspect",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "sami@tracecloud.com"}],
"userType": "readWrite"}}
|
|
Get All Requirements in a Report
|
Close
|
Description
Gets all the Requirements from executing a stored report
|
Parameters
The API Key and Report Id
|
Permissions
The caller has to be a member of the project in which this Report exists. Also, he needs to be the owner
of this report, or this is a public report created by someone else.
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getReportRequirements&reportId=905
|
Sample Result
{
"errorMessage": "",
"responseStatus": "success",
"reportDetails": {
"reportType": "traceTree",
"createdBy": "qa_mktg_1@tracecloud.com",
"reportDefinition": "projectId:--:19:###:folderId:--:133:###:active:--:active
:###:danglingSearch:--:all:###:orphanSearch:--:all:###:completedSearch:--:all
:###:incompleteSearch:--:all:###:suspectUpStreamSearch:--:all:###:suspectDown
StreamSearch:--:all:###:includeSubFoldersSearch:--:no:###:nameSearch:--::###:
descriptionSearch:--::###:ownerSearch:--::###:externalURLSearch:--::###:
traceToSearch:--::###:traceFromSearch:--::###:statusSearch:--::###:prioritySearch
:--::###:pctCompleteSearch:--:",
"reportDescription": "Canned report created by the system to display ALL
the Requirements in this folder.",
"traceTreeDepth": 3,
"projectId": 19,
"requirements": [
{
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 240,
"userDefinedAttributes": "Type:#:Bug:##:Severity:#:3:##:Impact to
customer:#:yes",
"folderPath": "Business Requirements\/Folder Metrics",
"traceFrom": "FR-288",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1755,
"traceTo": "REL-8",
"approvedByAllDt": "16 August 2009 03:44:06 PM ",
"folderId": 133,
"version": 1,
"fullTag": "BR-240",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "A should be able to see Folder metrics by clicking on
Folder Metrics button on the right and then selecting one of various
types of Folder metrics report",
"priority": "Medium",
"name": "A should be able to see Folder metrics by clicking on Folder
Metrics button on the right and then ",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"}],
"reportName": "All Requirements",
"reportId": 905,
"reportVisibility": "public",
"folderId": 133}}
|
|
Get Requirement Details By Requirement Id
|
Close
|
Description
Gets the details of a Requirement from a Requirement Id
|
Parameters
The API Key and Requirement Id
|
Permissions
The caller has to be a member of the project in which this Requirement exists. And he/she needs to have read permissions
on the requirement
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementById&requirementId=2026
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria selected
in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Get Requirement Details By Requirement Tag (eg: BR-16)
|
Close
|
Description
Gets the details of a Requirement from a Requirement Tag (eg : BR-16)
|
Parameters
The API Key , Project Id, and Requirement Tag (BR-16)
|
Permissions
The caller has to be a member of the project in which this Requirement exists. And he/she needs to have read permissions
on the requirement
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementByFullTag&projectId=39&fullTag=REL-1395
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on
criteria selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Get the list of Requirements that a Requirement Traces to
|
Close
|
Description
Gets a list of Requirement this Requirement Traces to
|
Parameters
The API Key , Requirement Id
|
Permissions
The caller has to be a member of the project in which this Requirement exists. And he/she needs to have read permissions
on the requirement
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementTraceTo&requirementId=1584
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 69,
"userDefinedAttributes": "Type:#: Enhancement:##:Severity:#:3:
##:Impact to customer:#:yes",
"folderPath": "Business Requirements\/Administration Requirements",
"traceFrom": "FR-19,FR-27",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1584,
"traceTo": "(s)REL-2",
"approvedByAllDt": "16 August 2009 03:44:01 PM ",
"folderId": 121,
"version": 1,
"fullTag": "BR-69",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "Administrator should be able to update comma separated
list of domains in Project Core Info Page. Only members whose emails
end in restricted domains should be able to become members of this
project.",
"priority": "Medium",
"name": "Administrator should be able to update comma separated list
of domains in Project Core Info Page. ",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"},
"responseStatus": "success",
"requirementTraceTo": [
{
"requirementDetails": {
"approvers": "",
"externalURL": "msnbc.com",
"status": "Draft",
"tag": 2,
"userDefinedAttributes": "",
"folderPath": "Release",
"traceFrom": "BR-12,BR-13,(s)BR-14,(s)BR-15,(s)BR-16,(s)BR-17,
(s)BR-18,(s)BR-19,(s)BR-20,(s)BR-21,(s)BR-22,(s)BR-23,(s)BR-24,
(s)BR-80,(s)BR-81,(s)BR-82,(s)BR-83,(s)BR-84,(s)BR-85,(s)BR-86,
",
"projectId": 19,
"deleted": 0,
"pctComplete": 0,
"requirementId": 1507,
"traceTo": "",
"approvedByAllDt": "N\/A",
"folderId": 114,
"version": 2,
"fullTag": "REL-2",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Release",
"description": "Admin Requirements",
"priority": "High",
"name": "Admin Requirements",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"},
"traceToRequirementId": 1507,
"traceFromRequirementId": 1584,
"traceId": 307,
"suspect": 1}]}
|
|
Get the list of Requirements that this Requirement has a Trace From
|
Close
|
Description
Get the list of Requirements that this Requirement has a Trace From
|
Parameters
The API Key , Requirement Id
|
Permissions
The caller has to be a member of the project in which this Requirement exists. And he/she needs to have read permissions
on the requirement
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=getRequirementTraceFrom&requirementId=19749
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 69,
"userDefinedAttributes": "Type:#: Enhancement:##:Severity:#:3:
##:Impact to customer:#:yes",
"folderPath": "Business Requirements\/Administration Requirements",
"traceFrom": "FR-19,FR-27",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1584,
"traceTo": "(s)REL-2",
"approvedByAllDt": "16 August 2009 03:44:01 PM ",
"folderId": 121,
"version": 1,
"fullTag": "BR-69",
"createdBy": "qa_mktg_1@tracecloud.com",
"requirementTypeName": "Business Requirements",
"description": "Administrator should be able to update comma separated
list of domains in Project Core Info Page. Only members whose emails
end in restricted domains should be able to become members of this
project.",
"priority": "Medium",
"name": "Administrator should be able to update comma separated list
of domains in Project Core Info Page. ",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_mktg_1@tracecloud.com"},
"requirementTraceFrom": [
{
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 19,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Administration Feature",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1808,
"traceTo": "BR-69",
"approvedByAllDt": "16 August 2009 04:25:43 PM ",
"folderId": 120,
"version": 1,
"fullTag": "FR-19",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "Administrator should be able to enter a comma separated
list of domains in Project Core Info page. Only members whose emails
names end in these restricted domains should be able to become members
of this project.",
"priority": "Medium",
"name": "Administrator should be able to enter a comma separated list
of domains in Project Core Info page.",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"traceToRequirementId": 1584,
"traceFromRequirementId": 1808,
"traceId": 518,
"suspect": 0},
{
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 27,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Administration Feature",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 1816,
"traceTo": "BR-69",
"approvedByAllDt": "16 August 2009 04:25:44 PM ",
"folderId": 120,
"version": 1,
"fullTag": "FR-27",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "Administrator should be able to update comma separated
list of domains in Project Core Info Page. Only members whose emails
end in restricted domains should be able to become members of this
project.",
"priority": "Medium",
"name": "Administrator should be able to update comma separated list
of domains in Project Core Info Page. ",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"traceToRequirementId": 1584,
"traceFromRequirementId": 1816,
"traceId": 526,
"suspect": 0}],
"responseStatus": "success"}
|
|
Create A Requirement Type
|
Close
|
Description
Create A new Requirement Type
|
Parameters
The API Key , projectId, TPrefix=tes, rTName, , rTDescription, rTDisplaySequence (Optional)
|
Permissions
The caller has to be an Administrator in the Project where the Requirement Type
is being created
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=createRequirementType&projectId=39&rTApprovalWorkflow=enable&rTPrefix=tes&rTName=from api&rTDescription=created from api
|
Sample Result
|
|
Create A Folder
|
Close
|
Description
Create A new Folder
|
Parameters
The API Key , parentFolderId, Folder Name, Folder Description
|
Permissions
The caller has to be a member where the parentFolder resides
and he/she has to have write privileges on the parentFolder
|
Sample Call
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQ&action=createFolder&parentFolderId=267&folderName=test3&folderDescription= test folder created by api
|
Sample Result
|
|
Create A Requirement Type Attribute
|
Close
|
Description
Create A Requirement Type Attribute
|
Parameters
|
Permissions
The caller has to be an administrator
|
Sample Call
|
Sample Result
|
|
Create A Trace
|
Close
|
Description
Create A Trace to / from this requirement.
|
Parameters
requirementId (for which the operation is taking place eg : 19234),
traceTo(FullTag of the requirement to which the trace should go eg :REL-3)
traceFrom (FullTag of the requirement from which the trace should come eg : FR-1)
|
Permissions
The caller has to be a member of the project where these Requirements reside,
and have Trace permissions on both the Requirements
|
Sample Call to Trace 'requirementId=106787' To a requirement called 'REL-3'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=createTrace&requirementId=106787&traceTo=rel-3
Sample Call to Trace From a requirement called 'FR-332' to requirementId=106787'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=createTrace&requirementId=106787&traceFrom=FR-332
To create trace to / from across project, simply attach the prefix of the project before the requirement tag.
In this example, we are tracing to a requirement in another project, called 'AST'.
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=createTrace&requirementId=106787&traceTo=AST:rel-1
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria selected
in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Delete A Trace
|
Close
|
Description
Deletes a A Trace between two requirements
|
Parameters
requirementId (for which the operation is taking place eg : 19234) and
traceTo(FullTag of the requirement to which this requirementId is tracing eg :REL-3)
or
requirementId (for which the operation is taking place eg : 19234) and
traceFrom (FullTag of the requirement from which the trace should come eg : FR-1)
|
Permissions
The caller has to be a member of the project where these Requirements reside
|
Sample Call to Delete a Trace from 'requirementId=106787' To a requirement called 'REL-3'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=deleteTrace&requirementId=106787&traceTo=rel-3
Sample Call to Delete a Trace From a requirement called 'FR-332' to requirementId=106787'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=deleteTrace&requirementId=106787&traceFrom=FR-332
To Delete a trace to / from across projects, simply attach the prefix of the project before the requirement tag.
In this example, we are delete a trace to a requirement in another project, called 'AST'.
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=deleteTrace&requirementId=106787&traceTo=AST:rel-1
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria selected
in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Clear A Trace
|
Close
|
Description
Clears a A Suspect Trace between two requirements
|
Parameters
requirementId (for which the operation is taking place eg : 19234) and
traceTo(FullTag of the requirement to which this requirementId is tracing eg :REL-3)
or
requirementId (for which the operation is taking place eg : 19234) and
traceFrom (FullTag of the requirement from which the trace should come eg : FR-1)
|
Permissions
The caller has to be a member of the project where these Requirements reside
|
Sample Call to Clear a Suspect Trace from 'requirementId=106787' To a requirement called 'REL-3'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=clearSuspectTrace&requirementId=106787&traceTo=rel-3
Sample Call to Clear a Suspect Trace From a requirement called 'FR-332' to requirementId=106787'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=clearSuspectTrace&requirementId=106787&traceFrom=FR-332
To Clear a Suspect trace to / from across projects, simply attach the prefix of the project before the requirement tag.
In this example, we are delete a trace to a requirement in another project, called 'AST'.
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=clearSuspectTrace&requirementId=106787&traceTo=AST:rel-1
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria selected
in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Set A Trace to Suspect
|
Close
|
Description
Sets a Trace between two requirements to suspect
|
Parameters
requirementId (for which the operation is taking place eg : 19234) and
traceTo(FullTag of the requirement to which this requirementId is tracing eg :REL-3)
or
requirementId (for which the operation is taking place eg : 19234) and
traceFrom (FullTag of the requirement from which the trace should come eg : FR-1)
|
Permissions
The caller has to be a member of the project where these Requirements reside
|
Sample Call to make Suspect a Trace from 'requirementId=106787' To a requirement called 'REL-3'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=makeTraceSuspect&requirementId=106787&traceTo=rel-3
Sample Call to make Suspect a Trace From a requirement called 'FR-332' to requirementId=106787'
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=makeTraceSuspect&requirementId=106787&traceFrom=FR-332
To make Suspect a trace to / from across projects, simply attach the prefix of the project before the requirement tag.
In this example, we are delete a trace to a requirement in another project, called 'AST'.
https://www.tracecloud.com/GloreeJava2/RESTAPI?key=HIDLIZJKQO&action=makeTraceSuspect&requirementId=106787&traceTo=AST:rel-1
|
Sample Result
{
"errorMessage": "",
"requirementDetails": {
"approvers": "",
"externalURL": "",
"status": "Approved",
"tag": 237,
"userDefinedAttributes": "",
"folderPath": "Functional Requirements\/Trace Tree Report",
"traceFrom": "",
"projectId": 19,
"deleted": 0,
"pctComplete": 100,
"requirementId": 2026,
"traceTo": "BR-195",
"approvedByAllDt": "16 August 2009 10:26:34 PM ",
"folderId": 129,
"version": 1,
"fullTag": "FR-237",
"createdBy": "qa_dev_1@tracecloud.com",
"requirementTypeName": "Functional Requirements",
"description": "A User should be able to create and run a report based on criteria
selected in Trace Tree Report tab.",
"priority": "Medium",
"name": "A User should be able to create and run a report based on criteria selected
in Trace Tree Report t",
"lastModifiedBy": "sami@tracecloud.com",
"owner": "qa_dev_1@tracecloud.com"},
"responseStatus": "success"}
|
|
Create A Requirement
|
Close
|
Description
Create A Requirement
|
Parameters
|
Permissions
The caller has to be have Create Requirements privileges on the parent folder
|
Sample Call
|
Sample Result
|
|
Delete A Requirement
|
Close
|
Description
Delete (Can be restored) A Requirement
|
Parameters
API Key and Requirement id
|
Permissions
The caller has to be have Delete Requirements privileges on the parent folder
|
Sample Call
|
Sample Result
|
|
Purge A Requirement
|
Close
|
Description
Purge (Permanently Delete) A Requirement
|
Parameters
API Key and Requirement id
|
Permissions
The caller has to be have Delete Requirements privileges on the parent folder
|
Sample Call
|
Sample Result
|
|
Move A Requirement
|
Close
|
Description
Move A Requirement to a different folder
|
Parameters
API Key and Requirement id and Target Folder Id
|
Permissions
The caller has to be have Edit Requirements privileges on the parent folder
of the called Requirement and on the Target Folder
|
Sample Call
|
Sample Result
|
|
Change Owner for Requirement
|
Close
|
Description
Change Requirement owner i.e assign someone else as the responsible
person for this requirement
|
Parameters
API Key and Requirement id and new Owner Id (user Id) or new Owner Email Id
|
Permissions
The caller has to be have Edit Requirements privileges on the parent folder
of the called Requirement and the new Owner should be a member of this project.
|
Sample Call
|
Sample Result
|
|
Change Requirement Attribute
|
Close
|
Description
Change Requirement Attribute value
|
Parameters
API Key and Requirement id and attribute label and attribute value
|
Permissions
The caller has to be have Edit Requirements privileges on the parent folder
of the called Requirement and the attribute label should match existing
standard or custom attributes. Also the value has to match whats acceptable
for this attribute. i.e Priority has to be High, Medium or Low etc..
|
Sample Call
|
Sample Result
|
|