...
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 | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
api/agilerun/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ExecuteTests | TestManagement / ManageExecution | ||||||||||
api/agilerun/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/agilerun/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/agileruns | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/assignedtosearch | No Permissions | Unsupported | No Permissions | Unsupported | Unsupported | ||||||||||
api/attachment/{id}/contents | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtest/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageScripts | TestManagement / ManageScripts | ||||||||||
api/automatedtest/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtestassignment/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageExecution | TestManagement / ManageExecution | ||||||||||
api/automatedtestassignment/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtestassignment/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
Assignment Runsapi/automatedtestassignment/{id}/runs | TestManagement / View | Unsupported | TestManagement / ExecuteTestsManageExecution | Unsupported | Unsupported | ||||||||||
Assignments | apiTestManagement / automatedtestassignmentsTestManagement/ View | UnsupportedTestManagement/ManageExecution | Unsupported | Unsupported | Automated Test Relationships | api/automatedtest/{id}/relationships | TestManagement/View | Unsupported | Unsupported | ||||||
Unsupported | Unsupported | api/automatedtestrun/{id} | TestManagement / View | Unsupported | Unsupported | Unsupported | TestManagement / ManageExecution | ||||||||
api/automatedtestrun/{runId}/attachment/{attachmentId} | Unsupported | Unsupported | Unsupported | Unsupported | TestManagement / ManageExecution | ||||||||||
api/automatedtestrun/{runId}/attachments | TestManagement/View | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | |||||||||
api/automatedtestrun/{id}/testdata | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId}/incident/{incidentId} | TestManagement / View | Unsupported | Unsupported | Unsupported | TestManagement / ManageExecution | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId}/incidents | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId}/attachment/{attachmentId} | Unsupported | Unsupported | Unsupported | Unsupported | TestManagement / ManageExecution | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId}/attachments | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId}/children | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtestrun/{runId}/node/{nodeId} | TestManagement/View | TestManagement / View | TestManagement / TestManagement/ ExecuteTests | Unsupported | Unsupported | Unsupported | |||||||||
api/automatedtestrun/{runId}/nodes | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/automatedtestruns | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
Test Schedule | 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 | |||||||||
Enforced by task implementation | Automated Test Types | api/automatedtesttypes | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | Automated Tests | api/automatedtests | TestManagement/View | Unsupported | ||||
TestManagement/ManageScripts | Unsupported | Unsupported | Task | api/backgroundtask/{id} | Enforced by task implementation | Unsupported | Unsupported | Unsupported | Unsupported | Background api/backgroundtasks | Unsupported | Unsupported | Enforced by task implementation | Unsupported | Unsupported |
api/customfield/{name} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/customfieldtype/{name} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/customfieldtypes | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/customfields | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/executionpackage/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageExecution | TestManagement / ManageExecution | ||||||||||
api/executionpackage/{id}/children | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/executionpackages | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | |||||||||||
api/exportfile/{filename} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
System | api/externalsystem/{id} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | |||||||||
Resources / ExternalLinks | Resources / ExternalLinks | Unsupported | Resources / ExternalLinks | Resources / ExternalLinks | |||||||||||
Resources / ExternalLinksapi/externalsystemlink/{id} | Resources / ExternalLinks | Unsupported | Unsupported | Resources / ExternalLinks | |||||||||||
Resources / ExternalLinks | Unsupported | Unsupported | Unsupported | No PermissionsUnsupported | |||||||||||
Field Values | api/externalsystemlink/{linkId}/field/{fieldName} | Resources/ExternalLinks | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||
api/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId} | No Permissions | Unsupported | Unsupported | Unsupported | TestManagement / ExecuteTests | Unsupported | Unsupported | ||||||||
Resources / ExternalLinks | Unsupported | Resources / ExternalLinksUnsupported | Unsupported | Unsupported | |||||||||||
Link Ticket Link | No Permissionsapi/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId}/link | Unsupported | Unsupported | TestManagement/ExecuteTests | Unsupported | Unsupported | |||||||||
Linksapi/externalsystemlinks | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/externalsystems | No PermissionsResources / ExternalLinks | UnsupportedUnsupported | Resources / ExternalLinks | Unsupported | Unsupported | ||||||||||
's Linksapi/externalsystem/{systemId}/links | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/gridwidget/{widgetType}/data/{dataName} | Unsupported | Unsupported | No Permissions | Unsupported | Unsupported | ||||||||||
api/gridwidgethost/{hostId}/project/{projectId}/position/{position} | No Permissions | Unsupported | Unsupported | No Permissions | Unsupported | ||||||||||
Grid Widget States | api/gridwidgethost/{hostId}/project/{projectId}/positions | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | |||||||||
api/group/{id} | No Permissions | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Administration / Organisation / ManageUserAndGroupSecurity | ||||||||||
api/group/{id}/permissions/projects | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/group/{id}/permissions/global | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | ||||||||||
api/group/{id}/users | No Permissions | Unsupported | Unsupported | No Permissions | Unsupported | ||||||||||
api/groups | No Permissions | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | ||||||||||
Searchapi/groupssearch | TestManagement / View | Unsupported | TestManagement / View | Unsupported | Unsupported | ||||||||||
api/incident/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ExecuteTests | TestManagement / ExecuteTests | ||||||||||
api/incident/{id}/comments | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/incident/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/incident/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/incidents | TestManagement/View | Unsupported | TestManagement / View | Unsupported | TestManagement / ExecuteTests | Unsupported | Unsupported | ||||||||
Administration / Organisation | Unsupported | UnsupportedTestManagement/ExecuteTests | Unsupported | Unsupported | |||||||||||
api/mailqueue/messages | Administration / Organisation | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/mailsender/default/settings | Administration / Organisation | Unsupported | Unsupported | Administration / Organisation | Unsupported | ||||||||||
api/user/{userId}/notification/{notificationId} | No Permissions | No Permissions | Unsupported | Unsupported | No Permissions | ||||||||||
api/user/{userId}/notifications | No Permissions | Unsupported | Administration / Organisation | Unsupported | No PermissionsPermissions | ||||||||||
Organisation | api/organisation/{id} | No Permissions | Unsupported | Unsupported | Administration / Organisation / ManageOrganisation | Unsupported | |||||||||
api/organisation/{organisationId}/picklist/{type} | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/organisation/{organisationId}/picklistsearch/{type} | TestManagement / View | Unsupported | TestManagement / View | Unsupported | Unsupported | ||||||||||
api/organisation/{id}/relationshiptypes | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/organisations | No PermissionsUnsupported | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
Permission | api/permission/{id} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | |||||||||
api/permissions | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/project/{id} | TestManagement / View | Unsupported | Unsupported | Project / ManageProject | UnsupportedProject / ManageProject | ||||||||||
api/project/{projectId}/assignees | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/projectcategories | No Permissions | Unsupported | Administration / Organisation / ManageOrganisation | Unsupported | Unsupported | ||||||||||
api/projectcategory/{id} | No Permissions | Unsupported | Unsupported | Administration / Organisation / ManageOrganisation | Administration /Organisation/ManageOrganisation/ Organisation / ManageOrganisation | ||||||||||
Project Category Children | api/projectcategory/{id}/children | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | |||||||||
api/group/{groupId}/permissions/project/{projectId} | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | ||||||||||
api/project/{projectId}/picklist/{type} | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/project/{projectId}/picklistsearch/{type} | TestManagement / View | Unsupported | TestManagement / View | Unsupported | Unsupported | ||||||||||
api/projecttemplates | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/project/{projectId}/tickets | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/user/{userId}/permissions/project/{projectId} | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | ||||||||||
api/projects | TestManagement / View | Unsupported | Project / ManageProject | Unsupported | Unsupported | ||||||||||
api/projectssearch | TestManagement/View | Unsupported | TestManagement / View | Unsupported | Unsupported | TestManagement / View | Unsupported | Unsupported | |||||||
Relationship | api/organisation/{organisationId}/relationshiptype/{key}/relationship/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / View | TestManagement / View | |||||||||
api/organisation/{id}/relationshiptype/{key} | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/relationshiptypes | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/organisation/{id}/relationshiptype/{key}/relationships | Unsupported | Unsupported | TestManagement / View | Unsupported | Unsupported | ||||||||||
Requirement | api/requirement/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageRequirements | TestManagement / ManageRequirements | |||||||||
api/requirement/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/requirement/{requirementId}/attachment/{id} | Unsupported | Unsupported | Unsupported | Unsupported | TestManagement / ManageRequirements | ||||||||||
api/requirement/{id}/attachments | TestManagement / View | Unsupported | TestManagement / ManageRequirements | Unsupported | Unsupported | ||||||||||
api/requirement/{id}/children | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/requirement/{id}/comments | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/requirementpackage/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageRequirements | TestManagement / ManageRequirements | ||||||||||
api/requirementpackage/{id}/children | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/requirementpackages | TestManagement / View | Unsupported | TestManagement / ManageRequirements | Unsupported | Unsupported | ||||||||||
api/requirement/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/requirements | TestManagement / View | Unsupported | TestManagement / ManageRequirements | Unsupported | Unsupported | ||||||||||
api/ | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/script/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageScripts | TestManagement / ManageScripts | ||||||||||
api/script/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scriptassignment/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageExecution | TestManagement / ManageExecution | ||||||||||
api/scriptassignment/{id}/allrelationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scriptassignment/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scriptassignment/{id}/runs | TestManagement / View | Unsupported | TestManagement / ExecuteTests | Unsupported | Unsupported | ||||||||||
api/scriptassignments | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/script/{scriptId}/attachment/{id} | Unsupported | Unsupported | Unsupported | Unsupported | TestManagement / ExecuteTests | ||||||||||
api/script/{id}/attachments | TestManagement / View | Unsupported | TestManagement / ManageScripts | Unsupported | Unsupported | ||||||||||
api/scriptpackage/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ManageScripts | TestManagement / ManageScripts | ||||||||||
api/scriptpackage/{id}/children | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scriptpackages | TestManagement / View | Unsupported | TestManagement / ManageScripts | Unsupported | Unsupported | ||||||||||
api/script/{id}/relationships | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scriptrun/{id} | TestManagement / View | Unsupported | Unsupported | TestManagement / ExecuteTests | TestManagement / ManageExecution | ||||||||||
api/scriptruns | TestManagement / View | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/scripts | TestManagement / View | Unsupported | TestManagement / ManageScripts | Unsupported | Unsupported | ||||||||||
api/script/{scriptId}/assignments | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/search | TestManagement / View | UnsupportedUnsupported | TestManagement / View | Unsupported | Unsupported | ||||||||||
api/search/index/{indexName} | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/search/indexes | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/stepresult/{id} | TestManagement / ViewUnsupported | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
Step Result Attachment | api/stepresult/{stepResultId}/attachment/{id} | Unsupported | Unsupported | Unsupported | Unsupported | TestManagement / ExecuteTests | |||||||||
api/stepresult/{id}/attachments | TestManagement / View | Unsupported | TestManagement / ExecuteTests | Unsupported | Unsupported | ||||||||||
api/stepresult/{stepResultId}/incident/{id} | TestManagement / View | Unsupported | Unsupported | Unsupported | TestManagement / ExecuteTests | ||||||||||
api/stepresult/{id}/incidents | TestManagement / View | Unsupported | TestManagement / ExecuteTests | Unsupported | Unsupported | ||||||||||
Synchronizer Schedule | api/synchronizer/{linkId}/schedule/{id} | Resources / ExternalLinks | Resources / ExternalLinks | Unsupported | Resources / ExternalLinks | Resources / ExternalLinks | |||||||||
api/synchronizer/{linkId}/schedule/{id}/run | Unsupported | Unsupported | Resources / ExternalLinks | Unsupported | Unsupported | ||||||||||
api/synchronizer/{id}/schedules | Resources / ExternalLinks | Unsupported | Resources / ExternalLinks | Unsupported | Unsupported | ||||||||||
api/systemevent/{id} | No Permissions | Unsupported | Unsupported | Unsupported | No Permissions | ||||||||||
api/systemevents | No Permissions | Unsupported | Administration | Unsupported | No Permissions | ||||||||||
api/systeminfo | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
Attachment Setapi/temporaryattachmentset/{id} | No Permissions | Unsupported | No Permissions | Unsupported | Unsupported | ||||||||||
api/temporaryattachmentset/{setId}/attachment/{id} | Unsupported | Unsupported | Unsupported | Unsupported | No Permissions | ||||||||||
api/temporaryattachmentsets | Unsupported | Unsupported | No Permissions | Unsupported | Unsupported | ||||||||||
api/automatedtest/{testId}/assignments | TestManagement / View | Unsupported | TestManagement / ManageExecution | Unsupported | Unsupported | ||||||||||
api/timezone | No Permissions | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/user/{id} | No Permissions | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Administration / Organisation /ManageUserAndGroupSecurity/ ManageUserAndGroupSecurity | ||||||||||
User Groups | api/user/{id}/groups | No Permissions | Unsupported | Unsupported | No Permissions | Unsupported | |||||||||
api/user/{userId}/mailmessages | Unsupported | Unsupported | Administration / Organisation | Unsupported | Unsupported | ||||||||||
api/user/{id}/password | Unsupported | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | ||||||||||
api/user/{id}/permissions/projects | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Unsupported | Unsupported | ||||||||||
api/user/{id}/permissions/global | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | ||||||||||
api/users | No Permissions | Unsupported | Administration / Organisation / ManageUserAndGroupSecurity | Unsupported | Unsupported | ||||||||||
api/userssearch | TestManagement / View | Unsupported | TestManagement / View | Unsupported | Unsupported |