Page History

...

The account accessing the API requires project/organisation level permissions to access each supported Method of a resource, the table below documents each resource and the permissions required for use.

Name	URI Template	GET	PATCH	POST	PUT	DELETE
Agile Run	api/agilerun/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ManageExecution
Agile Run All Relationships	api/agilerun/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Agile Run Relationships	api/agilerun/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Agile Runs	api/agileruns	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Assigned To Search api/assignedtosearch	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Attachment Contents api/attachment/{id}/contents	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test api/automatedtest/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Automated Test All Relationships	api/automatedtest/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignment	api/automatedtestassignment/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Automated Test Assignment All Relationships api/automatedtestassignment/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignment Relationships	api/automatedtestassignment/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Assignment Runsapi/automatedtestassignment/{id}/runs Assignments	TestManagement / View	Unsupported	TestManagement / ExecuteTestsManageExecution	Unsupported	Unsupported
Automated Test Assignments Relationships	apiTestManagement / automatedtestassignmentsTestManagement/ View	UnsupportedTestManagement/ManageExecution	Unsupported	Unsupported	Automated Test Relationships	api/automatedtest/{id}/relationships	TestManagement/View	Unsupported	Unsupported
Unsupported	Unsupported	Automated Test Run api/automatedtestrun/{id}	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Attachment api/automatedtestrun/{runId}/attachment/{attachmentId}	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Attachments	api/automatedtestrun/{runId}/attachments	TestManagement/View	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Data	api/automatedtestrun/{id}/testdata	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Run Incident	api/automatedtestrun/{runId}/node/{nodeId}/incident/{incidentId}	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Incidents api/automatedtestrun/{runId}/node/{nodeId}/incidents	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Node Attachment	api/automatedtestrun/{runId}/node/{nodeId}/attachment/{attachmentId}	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageExecution
Automated Test Run Node Attachments	api/automatedtestrun/{runId}/node/{nodeId}/attachments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Automated Test Run Result Children api/automatedtestrun/{runId}/node/{nodeId}/children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Run Result Node	api/automatedtestrun/{runId}/node/{nodeId}	TestManagement/View	TestManagement / View	TestManagement / TestManagement/ ExecuteTests	Unsupported	Unsupported	Unsupported
Automated Test Run Result Root Nodes	api/automatedtestrun/{runId}/nodes	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Runs	api/automatedtestruns	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Schedule Tests	api/automatedtestschedule/{id}	TestManagement / View	Unsupported	TestManagement / ManageScriptsNo Permissions	Unsupported	Unsupported	No Permissions	No Permissions
Automated Test Schedule Import Configuration	api/automatedtestschedule/{scheduleId}/importconfiguration/{configId}	No Permissions	No Permissions	Unsupported	No Permissions	No Permissions
Automated Test Schedule Import Configurations	api/automatedtestschedule/{id}/importconfigurations	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Automated Test Schedule Schedule Configuration	api/automatedtestschedule/{scheduleId}/schedule/{scheduleConfigId}	Resources/ExternalLinks	Resources/ExternalLinks	Unsupported	Resources/ExternalLinks	Resources/ExternalLinks
Automated Test Schedule Schedule Configuration Run	api/automatedtestschedule/{scheduleId}/schedule/{scheduleConfigId}/run	Unsupported	Unsupported	Resources/ExternalLinks	Unsupported	Unsupported
Automated Test Schedule Schedule Configurations	api/automatedtestschedule/{id}/schedules	Resources/ExternalLinks	Unsupported	Resources/ExternalLinks	Unsupported	Unsupported
Automated Test Schedules	api/automatedtestschedules	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Automated Test Type	api/automatedtesttype/{name}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Automated Test Types	api/automatedtesttypes	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Automated Tests	api/automatedtests	TestManagement/View	Unsupported	TestManagement/ManageScripts	Unsupported	Unsupported
Background Task	Enforced by task implementation	Background Task	api/backgroundtask/{id}	Enforced by task implementation	Unsupported	Unsupported	Unsupported	Unsupported
Background Tasks api/backgroundtasks	Unsupported	Unsupported	Enforced by task implementation	Unsupported	Unsupported
Custom Field	api/customfield/{name}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Field Type	api/customfieldtype/{name}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Field Types api/customfieldtypes	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Custom Fields	api/customfields	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Execution Package	api/executionpackage/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Execution Package Children api/executionpackage/{id}/children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Execution Packages api/executionpackages	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Export File	Export File	api/exportfile/{filename}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Source Metadata	api/externalsourcemetadata	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Sources Metadata	api/externalsourcesmetadata	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System	api/externalsystem/{id}	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Resources / ExternalLinks
External System Link api/externalsystemlink/{id}	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Unsupported	Resources / ExternalLinks
External System Link Field Values	api/externalsystemlink/{linkId}/field/{fieldName}	Resources / ExternalLinksUnsupported	Unsupported	Unsupported	Unsupported	Unsupported
External System Link Ticket	External System Link Ticket	api/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System Link Ticket Link	api/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId}/link	Unsupported	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
External System Links	api/externalsystemlinks	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
External System Type api/externalsystemtype/{id}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External System Types api/externalsystemtypes	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
External Systems	api/externalsystems	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
External System 's Linksapi/externalsystem/{systemId}/links 's Links	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Grid Widget Data	api/gridwidget/{widgetType}/data/{dataName}	Unsupported	Unsupported	No Permissions	Unsupported	Unsupported
Grid Widget State	api/gridwidgethost/{hostId}/project/{projectId}/position/{position}	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
Grid Widget States	Grid Widget States	api/gridwidgethost/{hostId}/project/{projectId}/positions	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Group	api/group/{id}	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Administration / Organisation / ManageUserAndGroupSecurity
Group Permission Projects api/group/{id}/permissions/projects	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Unsupported	Unsupported
Group Permissions	api/group/{id}/permissions/global	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Group Users api/group/{id}/users	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
Groups api/groups	No Permissions	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported
Groups Searchapi/groupssearch Search	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Incident	api/incident/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ExecuteTests
Incident Comments	api/incident/{id}/comments	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incident Relationships	api/incident/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incident Relationships All Relationships api/incident/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Incidents	api/incidents	TestManagement/View	Unsupported		TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Latest Performance Measurement	Administration / Organisation	Unsupported	UnsupportedTestManagement/ExecuteTests	Unsupported	Unsupported
Mail Queue Messages	api/mailqueue/messages	Administration / Organisation	Unsupported	Unsupported	Unsupported	Unsupported
Mail Sender Settings api/mailsender/default/settings	Administration / Organisation	Unsupported	Unsupported	Administration / Organisation	Unsupported
Notification	api/user/{userId}/notification/{notificationId}	No Permissions	No Permissions	Unsupported	Unsupported	No Permissions
Notifications api/user/{userId}/notifications	No Permissions	Unsupported	Administration / Organisation	Unsupported	No PermissionsPermissions
Organisation	Organisation	api/organisation/{id}	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageOrganisation	Unsupported
Organisation Picklist	api/organisation/{organisationId}/picklist/{type}	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Organisation Picklist Search	api/organisation/{organisationId}/picklistsearch/{type}	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Organisation Relationship Types api/organisation/{id}/relationshiptypes	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Organisations	api/organisations	No PermissionsUnsupported	Unsupported	Unsupported	Unsupported	Unsupported
Permission	Permission	api/permission/{id}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Permissions	api/permissions	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project	api/project/{id}	TestManagement / View	Unsupported	Unsupported	Project / ManageProject	UnsupportedProject / ManageProject
Project Assignees	api/project/{projectId}/assignees	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project Categories api/projectcategories	No Permissions	Unsupported	Administration / Organisation / ManageOrganisation	Unsupported	Unsupported
Project Category api/projectcategory/{id}	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageOrganisation	Administration /Organisation/ManageOrganisation/ Organisation / ManageOrganisation
Project Category Children	Project Category Children	api/projectcategory/{id}/children	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project Group Permissions	api/group/{groupId}/permissions/project/{projectId}	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Project Picklist	api/project/{projectId}/picklist/{type}	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project Picklist Search api/project/{projectId}/picklistsearch/{type}	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported
Project Templates api/projecttemplates	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Project Tickets	api/project/{projectId}/tickets	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Project User Permissions	api/user/{userId}/permissions/project/{projectId}	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Projects	api/projects	TestManagement / View	Unsupported	Project / ManageProject	Unsupported	Unsupported
Projects Search	api/projectssearch	TestManagement/View	Unsupported	TestManagement / View	Unsupported	Unsupported		TestManagement / View	Unsupported	Unsupported
Relationship	Relationship	api/organisation/{organisationId}/relationshiptype/{key}/relationship/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / View	TestManagement / View
Relationship Type	api/organisation/{id}/relationshiptype/{key}	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Relationship Types	api/relationshiptypes	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Relationships api/organisation/{id}/relationshiptype/{key}/relationships	Unsupported	Unsupported	TestManagement / View	Unsupported	Unsupported
Requirement	Requirement	api/requirement/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageRequirements	TestManagement / ManageRequirements
Requirement All Relationships	api/requirement/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Attachment	api/requirement/{requirementId}/attachment/{id}	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ManageRequirements
Requirement Attachments	api/requirement/{id}/attachments	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Requirement Children api/requirement/{id}/children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Comments api/requirement/{id}/comments	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Package	api/requirementpackage/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageRequirements	TestManagement / ManageRequirements
Requirement Package Children	api/requirementpackage/{id}/children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirement Packages api/requirementpackages	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Requirement Relationships	api/requirement/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Requirements api/requirements	TestManagement / View	Unsupported	TestManagement / ManageRequirements	Unsupported	Unsupported
Root api/	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Script api/script/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Script All Relationships api/script/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment	api/scriptassignment/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageExecution	TestManagement / ManageExecution
Script Assignment All Relationships	api/scriptassignment/{id}/allrelationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment Relationships api/scriptassignment/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Assignment Runs	api/scriptassignment/{id}/runs	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Script Assignments api/scriptassignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Script Attachment api/script/{scriptId}/attachment/{id}	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Script Attachments	api/script/{id}/attachments	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script Package	api/scriptpackage/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ManageScripts	TestManagement / ManageScripts
Script Package Children api/scriptpackage/{id}/children	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Packages	api/scriptpackages	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script Relationships api/script/{id}/relationships	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Script Run api/scriptrun/{id}	TestManagement / View	Unsupported	Unsupported	TestManagement / ExecuteTests	TestManagement / ManageExecution
Script Runs api/scriptruns	TestManagement / View	Unsupported	Unsupported	Unsupported	Unsupported
Scripts api/scripts	TestManagement / View	Unsupported	TestManagement / ManageScripts	Unsupported	Unsupported
Script's Assignments	api/script/{scriptId}/assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Search	api/search	TestManagement / View	UnsupportedUnsupported	TestManagement / View	Unsupported	Unsupported
Search Index api/search/index/{indexName}	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Search Indexes	api/search/indexes	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Step Result api/stepresult/{id}	TestManagement / ViewUnsupported	Unsupported	Unsupported	Unsupported	Unsupported
Step Result Attachment	Step Result Attachment	api/stepresult/{stepResultId}/attachment/{id}	Unsupported	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Step Result Attachments	api/stepresult/{id}/attachments	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Step Result Incident	api/stepresult/{stepResultId}/incident/{id}	TestManagement / View	Unsupported	Unsupported	Unsupported	TestManagement / ExecuteTests
Step Result Incidents api/stepresult/{id}/incidents	TestManagement / View	Unsupported	TestManagement / ExecuteTests	Unsupported	Unsupported
Synchronizer Schedule	Synchronizer Schedule	api/synchronizer/{linkId}/schedule/{id}	Resources / ExternalLinks	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Resources / ExternalLinks
Synchronizer Schedule Run	api/synchronizer/{linkId}/schedule/{id}/run	Unsupported	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
Synchronizer Schedules	api/synchronizer/{id}/schedules	Resources / ExternalLinks	Unsupported	Resources / ExternalLinks	Unsupported	Unsupported
System Event api/systemevent/{id}	No Permissions	Unsupported	Unsupported	Unsupported	No Permissions
System Events api/systemevents	No Permissions	Unsupported	Administration	Unsupported	No Permissions
System Info	api/systeminfo	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
Temporary Attachment Setapi/temporaryattachmentset/{id} Attachment Set	No Permissions	Unsupported	No Permissions	Unsupported	Unsupported
Temporary Attachment Set Attachment	api/temporaryattachmentset/{setId}/attachment/{id}	Unsupported	Unsupported	Unsupported	Unsupported	No Permissions
Temporary Attachments Set api/temporaryattachmentsets	Unsupported	Unsupported	No Permissions	Unsupported	Unsupported
Test Automated Test Assignments	api/automatedtest/{testId}/assignments	TestManagement / View	Unsupported	TestManagement / ManageExecution	Unsupported	Unsupported
Time Zone api/timezone	No Permissions	Unsupported	Unsupported	Unsupported	Unsupported
User api/user/{id}	No Permissions	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Administration / Organisation /ManageUserAndGroupSecurity/ ManageUserAndGroupSecurity
User Groups	User Groups	api/user/{id}/groups	No Permissions	Unsupported	Unsupported	No Permissions	Unsupported
User Mail	api/user/{userId}/mailmessages	Unsupported	Unsupported	Administration / Organisation	Unsupported	Unsupported
User Password	api/user/{id}/password	Unsupported	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
User Permission Projects	api/user/{id}/permissions/projects	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Unsupported	Unsupported
User Permissions api/user/{id}/permissions/global	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported
Users api/users	No Permissions	Unsupported	Administration / Organisation / ManageUserAndGroupSecurity	Unsupported	Unsupported
Users Search api/userssearch	TestManagement / View	Unsupported	TestManagement / View	Unsupported	Unsupported

Child pages

Versions Compared

Old Version 2

New Version Current

Key