API / Permissions

Permissions

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.

NameURI TemplateGETPATCHPOSTPUTDELETE
Agile Runapi/agilerun/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ExecuteTestsTestManagement/ManageExecution
Agile Run All Relationshipsapi/agilerun/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Agile Run Relationshipsapi/agilerun/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Agile Runsapi/agilerunsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Assigned To Searchapi/assignedtosearchNo PermissionsUnsupportedNo PermissionsUnsupportedUnsupported
Attachment Contentsapi/attachment/{id}/contentsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Automated Testapi/automatedtest/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageScriptsTestManagement/ManageScripts
Automated Test All Relationshipsapi/automatedtest/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Assignmentapi/automatedtestassignment/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageExecutionTestManagement/ManageExecution
Automated Test Assignment All Relationshipsapi/automatedtestassignment/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Assignment Relationshipsapi/automatedtestassignment/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Assignment Runsapi/automatedtestassignment/{id}/runsTestManagement/ViewUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
Automated Test Assignmentsapi/automatedtestassignmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Automated Test Relationshipsapi/automatedtest/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Runapi/automatedtestrun/{id}TestManagement/ViewUnsupportedUnsupportedUnsupportedTestManagement/ManageExecution
Automated Test Run Attachmentapi/automatedtestrun/{runId}/attachment/{attachmentId}UnsupportedUnsupportedUnsupportedUnsupportedTestManagement/ManageExecution
Automated Test Run Attachmentsapi/automatedtestrun/{runId}/attachmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Automated Test Run Dataapi/automatedtestrun/{id}/testdataTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Run Incidentapi/automatedtestrun/{runId}/node/{nodeId}/incident/{incidentId}TestManagement/ViewUnsupportedUnsupportedUnsupportedTestManagement/ManageExecution
Automated Test Run Incidentsapi/automatedtestrun/{runId}/node/{nodeId}/incidentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Automated Test Run Node Attachmentapi/automatedtestrun/{runId}/node/{nodeId}/attachment/{attachmentId}UnsupportedUnsupportedUnsupportedUnsupportedTestManagement/ManageExecution
Automated Test Run Node Attachmentsapi/automatedtestrun/{runId}/node/{nodeId}/attachmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Automated Test Run Result Childrenapi/automatedtestrun/{runId}/node/{nodeId}/childrenTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Run Result Nodeapi/automatedtestrun/{runId}/node/{nodeId}TestManagement/ViewTestManagement/ExecuteTestsUnsupportedUnsupportedUnsupported
Automated Test Run Result Root Nodesapi/automatedtestrun/{runId}/nodesTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Runsapi/automatedtestrunsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Scheduleapi/automatedtestschedule/{id}No PermissionsUnsupportedUnsupportedNo PermissionsNo Permissions
Automated Test Schedule Import Configurationapi/automatedtestschedule/{scheduleId}/importconfiguration/{configId}No PermissionsNo PermissionsUnsupportedNo PermissionsNo Permissions
Automated Test Schedule Import Configurationsapi/automatedtestschedule/{id}/importconfigurationsNo PermissionsUnsupportedNo PermissionsUnsupportedUnsupported
Automated Test Schedule Schedule Configurationapi/automatedtestschedule/{scheduleId}/schedule/{scheduleConfigId}Resources/ExternalLinksResources/ExternalLinksUnsupportedResources/ExternalLinksResources/ExternalLinks
Automated Test Schedule Schedule Configuration Runapi/automatedtestschedule/{scheduleId}/schedule/{scheduleConfigId}/runUnsupportedUnsupportedResources/ExternalLinksUnsupportedUnsupported
Automated Test Schedule Schedule Configurationsapi/automatedtestschedule/{id}/schedulesResources/ExternalLinksUnsupportedResources/ExternalLinksUnsupportedUnsupported
Automated Test Schedulesapi/automatedtestschedulesNo PermissionsUnsupportedNo PermissionsUnsupportedUnsupported
Automated Test Typeapi/automatedtesttype/{name}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Automated Test Typesapi/automatedtesttypesNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Automated Testsapi/automatedtestsTestManagement/ViewUnsupportedTestManagement/ManageScriptsUnsupportedUnsupported
Background Taskapi/backgroundtask/{id}Enforced by task implementationUnsupportedUnsupportedUnsupportedUnsupported
Background Tasksapi/backgroundtasksUnsupportedUnsupportedEnforced by task implementationUnsupportedUnsupported
Custom Fieldapi/customfield/{name}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Custom Field Typeapi/customfieldtype/{name}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Custom Field Typesapi/customfieldtypesNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Custom Fieldsapi/customfieldsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Execution Packageapi/executionpackage/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageExecutionTestManagement/ManageExecution
Execution Package Childrenapi/executionpackage/{id}/childrenTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Execution Packagesapi/executionpackagesTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Export Fileapi/exportfile/{filename}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
External Systemapi/externalsystem/{id}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
External System Linkapi/externalsystemlink/{id}Resources/ExternalLinksUnsupportedUnsupportedUnsupportedNo Permissions
External System Link Field Valuesapi/externalsystemlink/{linkId}/field/{fieldName}Resources/ExternalLinksUnsupportedUnsupportedUnsupportedUnsupported
External System Link Ticketapi/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
External System Link Ticket Linkapi/externalsystemlink/{externalSystemLinkId}/ticket/{ticketId}/linkUnsupportedUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
External System Linksapi/externalsystemlinksNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
External Systemsapi/externalsystemsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
External System's Linksapi/externalsystem/{systemId}/linksNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Grid Widget Dataapi/gridwidget/{widgetType}/data/{dataName}UnsupportedUnsupportedNo PermissionsUnsupportedUnsupported
Grid Widget Stateapi/gridwidgethost/{hostId}/project/{projectId}/position/{position}No PermissionsUnsupportedUnsupportedNo PermissionsUnsupported
Grid Widget Statesapi/gridwidgethost/{hostId}/project/{projectId}/positionsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Groupapi/group/{id}No PermissionsUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityAdministration/Organisation/ManageUserAndGroupSecurity
Group Permission Projectsapi/group/{id}/permissions/projectsAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedUnsupportedUnsupported
Group Permissionsapi/group/{id}/permissions/globalAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupported
Group Usersapi/group/{id}/usersNo PermissionsUnsupportedUnsupportedNo PermissionsUnsupported
Groupsapi/groupsNo PermissionsUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupported
Groups Searchapi/groupssearchTestManagement/ViewUnsupportedTestManagement/ViewUnsupportedUnsupported
Incidentapi/incident/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ExecuteTestsTestManagement/ExecuteTests
Incident Commentsapi/incident/{id}/commentsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Incident Relationshipsapi/incident/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Incident Relationships All Relationshipsapi/incident/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Incidentsapi/incidentsTestManagement/ViewUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
Mail Queue Messagesapi/mailqueue/messagesAdministration/OrganisationUnsupportedUnsupportedUnsupportedUnsupported
Mail Sender Settingsapi/mailsender/default/settingsAdministration/OrganisationUnsupportedUnsupportedAdministration/OrganisationUnsupported
Notificationapi/user/{userId}/notification/{notificationId}No PermissionsNo PermissionsUnsupportedUnsupportedNo Permissions
Notificationsapi/user/{userId}/notificationsNo PermissionsUnsupportedAdministration/OrganisationUnsupportedNo Permissions
Organisationapi/organisation/{id}No PermissionsUnsupportedUnsupportedAdministration/Organisation/ManageOrganisationUnsupported
Organisation Picklistapi/organisation/{organisationId}/picklist/{type}TestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Organisation Picklist Searchapi/organisation/{organisationId}/picklistsearch/{type}TestManagement/ViewUnsupportedTestManagement/ViewUnsupportedUnsupported
Organisation Relationship Typesapi/organisation/{id}/relationshiptypesTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Organisationsapi/organisationsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Permissionapi/permission/{id}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Permissionsapi/permissionsNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Projectapi/project/{id}TestManagement/ViewUnsupportedUnsupportedProject/ManageProjectUnsupported
Project Assigneesapi/project/{projectId}/assigneesTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Project Categoriesapi/projectcategoriesNo PermissionsUnsupportedAdministration/Organisation/ManageOrganisationUnsupportedUnsupported
Project Categoryapi/projectcategory/{id}No PermissionsUnsupportedUnsupportedAdministration/Organisation/ManageOrganisationAdministration/Organisation/ManageOrganisation
Project Category Childrenapi/projectcategory/{id}/childrenNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Project Group Permissionsapi/group/{groupId}/permissions/project/{projectId}Administration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupported
Project Picklistapi/project/{projectId}/picklist/{type}TestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Project Picklist Searchapi/project/{projectId}/picklistsearch/{type}TestManagement/ViewUnsupportedTestManagement/ViewUnsupportedUnsupported
Project Templatesapi/projecttemplatesNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Project Ticketsapi/project/{projectId}/ticketsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Project User Permissionsapi/user/{userId}/permissions/project/{projectId}Administration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupported
Projectsapi/projectsTestManagement/ViewUnsupportedProject/ManageProjectUnsupportedUnsupported
Projects Searchapi/projectssearchTestManagement/ViewUnsupportedTestManagement/ViewUnsupportedUnsupported
Relationshipapi/organisation/{organisationId}/relationshiptype/{key}/relationship/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ViewTestManagement/View
Relationship Typeapi/organisation/{id}/relationshiptype/{key}TestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Relationship Typesapi/relationshiptypesTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Relationshipsapi/organisation/{id}/relationshiptype/{key}/relationshipsUnsupportedUnsupportedTestManagement/ViewUnsupportedUnsupported
Requirementapi/requirement/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageRequirementsTestManagement/ManageRequirements
Requirement All Relationshipsapi/requirement/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Requirement Attachmentapi/requirement/{requirementId}/attachment/{id}UnsupportedUnsupportedUnsupportedUnsupportedTestManagement/ManageRequirements
Requirement Attachmentsapi/requirement/{id}/attachmentsTestManagement/ViewUnsupportedTestManagement/ManageRequirementsUnsupportedUnsupported
Requirement Childrenapi/requirement/{id}/childrenTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Requirement Commentsapi/requirement/{id}/commentsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Requirement Packageapi/requirementpackage/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageRequirementsTestManagement/ManageRequirements
Requirement Package Childrenapi/requirementpackage/{id}/childrenTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Requirement Packagesapi/requirementpackagesTestManagement/ViewUnsupportedTestManagement/ManageRequirementsUnsupportedUnsupported
Requirement Relationshipsapi/requirement/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Requirementsapi/requirementsTestManagement/ViewUnsupportedTestManagement/ManageRequirementsUnsupportedUnsupported
Rootapi/No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Scriptapi/script/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageScriptsTestManagement/ManageScripts
Script All Relationshipsapi/script/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Script Assignmentapi/scriptassignment/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageExecutionTestManagement/ManageExecution
Script Assignment All Relationshipsapi/scriptassignment/{id}/allrelationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Script Assignment Relationshipsapi/scriptassignment/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Script Assignment Runsapi/scriptassignment/{id}/runsTestManagement/ViewUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
Script Assignmentsapi/scriptassignmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Script Attachmentapi/script/{scriptId}/attachment/{id}UnsupportedUnsupportedUnsupportedUnsupportedTestManagement/ExecuteTests
Script Attachmentsapi/script/{id}/attachmentsTestManagement/ViewUnsupportedTestManagement/ManageScriptsUnsupportedUnsupported
Script Packageapi/scriptpackage/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ManageScriptsTestManagement/ManageScripts
Script Package Childrenapi/scriptpackage/{id}/childrenTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Script Packagesapi/scriptpackagesTestManagement/ViewUnsupportedTestManagement/ManageScriptsUnsupportedUnsupported
Script Relationshipsapi/script/{id}/relationshipsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Script Runapi/scriptrun/{id}TestManagement/ViewUnsupportedUnsupportedTestManagement/ExecuteTestsTestManagement/ManageExecution
Script Runsapi/scriptrunsTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Scriptsapi/scriptsTestManagement/ViewUnsupportedTestManagement/ManageScriptsUnsupportedUnsupported
Script's Assignmentsapi/script/{scriptId}/assignmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Searchapi/searchTestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Search Indexapi/search/index/{indexName}No PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Search Indexesapi/search/indexesNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Step Resultapi/stepresult/{id}TestManagement/ViewUnsupportedUnsupportedUnsupportedUnsupported
Step Result Attachmentapi/stepresult/{stepResultId}/attachment/{id}UnsupportedUnsupportedUnsupportedUnsupportedTestManagement/ExecuteTests
Step Result Attachmentsapi/stepresult/{id}/attachmentsTestManagement/ViewUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
Step Result Incidentapi/stepresult/{stepResultId}/incident/{id}TestManagement/ViewUnsupportedUnsupportedUnsupportedTestManagement/ExecuteTests
Step Result Incidentsapi/stepresult/{id}/incidentsTestManagement/ViewUnsupportedTestManagement/ExecuteTestsUnsupportedUnsupported
Synchronizer Scheduleapi/synchronizer/{linkId}/schedule/{id}Resources/ExternalLinksResources/ExternalLinksUnsupportedResources/ExternalLinksResources/ExternalLinks
Synchronizer Schedule Runapi/synchronizer/{linkId}/schedule/{id}/runUnsupportedUnsupportedResources/ExternalLinksUnsupportedUnsupported
Synchronizer Schedulesapi/synchronizer/{id}/schedulesResources/ExternalLinksUnsupportedResources/ExternalLinksUnsupportedUnsupported
System Eventapi/systemevent/{id}No PermissionsUnsupportedUnsupportedUnsupportedNo Permissions
System Eventsapi/systemeventsNo PermissionsUnsupportedAdministrationUnsupportedNo Permissions
System Infoapi/systeminfoNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Temporary Attachment Setapi/temporaryattachmentset/{id}No PermissionsUnsupportedNo PermissionsUnsupportedUnsupported
Temporary Attachment Set Attachmentapi/temporaryattachmentset/{setId}/attachment/{id}UnsupportedUnsupportedUnsupportedUnsupportedNo Permissions
Temporary Attachments Setapi/temporaryattachmentsetsUnsupportedUnsupportedNo PermissionsUnsupportedUnsupported
Test Automated Test Assignmentsapi/automatedtest/{testId}/assignmentsTestManagement/ViewUnsupportedTestManagement/ManageExecutionUnsupportedUnsupported
Time Zoneapi/timezoneNo PermissionsUnsupportedUnsupportedUnsupportedUnsupported
Userapi/user/{id}No PermissionsUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityAdministration/Organisation/ManageUserAndGroupSecurity
User Groupsapi/user/{id}/groupsNo PermissionsUnsupportedUnsupportedNo PermissionsUnsupported
User Mailapi/user/{userId}/mailmessagesUnsupportedUnsupportedAdministration/OrganisationUnsupportedUnsupported
User Passwordapi/user/{id}/passwordUnsupportedUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupported
User Permission Projectsapi/user/{id}/permissions/projectsAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedUnsupportedUnsupported
User Permissionsapi/user/{id}/permissions/globalAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupported
Usersapi/usersNo PermissionsUnsupportedAdministration/Organisation/ManageUserAndGroupSecurityUnsupportedUnsupported
Users Searchapi/userssearchTestManagement/ViewUnsupportedTestManagement/ViewUnsupportedUnsupported