Jira Align API endpoints for accessing custom room data
Summary
This article provides a list of Jira Align (JA) API endpoints relevant to retrieve custom rooms data.
Environment
Jira Align
Solution
Jira Align contains a set of APIs to access custom hierarchies (custom rooms).
An interactive list of these endpoints is also available on Jira Align itself via: https://<your JA instance name>.jiraalign.com/rest/align/api/docs/index.html where you replace the <your JA instance name> with your JA instance name.
Custom Hierarchies
| API | Purpose |
|---|---|
| *GET/align/api/2/CustomHierarchies* | Returns a list of custom hierarchies. |
| *POST/align/api/2/CustomHierarchies* | Creates a custom hierarchy. |
| *GET/align/api/2/CustomHierarchies/{id}* | Returns a specific custom hierarchy. |
| *PUT/align/api/2/CustomHierarchies/{id}* | Update a specific custom hierarchy. |
| *PATCH/align/api/2/CustomHierarchies/{id}* | Partially modify a specific custom hierarchy. |
| *DELETE/align/api/2/CustomHierarchies/{id}* | Delete a specific custom hierarchy and associated custom statuses. |
| *GET/align/api/2/CustomHierarchies/{id}/auditlog* | Returns auditLog of specific custom hierarchy. |
| *GET/align/api/2/CustomHierarchies/{hierarchyId}/levels* | Returns a list of custom hierarchy levels. |
| *POST/align/api/2/CustomHierarchies/{hierarchyId}/levels* | Creates a custom hierarchy level. |
| *GET/align/api/2/CustomHierarchies/{hierarchyId}/levels/{id}* | Returns a specific custom hierarchy level. |
| *PUT/align/api/2/CustomHierarchies/{hierarchyId}/levels/{id}* | Update a specific custom hierarchy level. |
| *PATCH/align/api/2/CustomHierarchies/{hierarchyId}/levels/{id}* | Partially modify a specific custom hierarchy level. |
| *DELETE/align/api/2/CustomHierarchies/{hierarchyId}/levels/{id}* | Delete a specific custom hierarchy level and associated object type mapping. |
| *GET/align/api/2/CustomHierarchies/{hierarchyId}/relations* | Returns a list of Level to Work Item type mappings for the specified hierarchy. |
| *GET/align/api/2/CustomHierarchies/{hierarchyId}/relations/{portfolioId}* | Returns Level to Work Item type mappings for the specified hierarchy and portfolio. |
| *POST/align/api/2/CustomHierarchies/{hierarchyId}/relations/{portfolioId}* | Creates Level to Work Item type mappings for the specified hierarchy and portfolio. |
| *PUT/align/api/2/CustomHierarchies/{hierarchyId}/relations/{portfolioId}* | Updates Level to Work Item type mappings for the specified hierarchy and portfolio. |
| *PATCH/align/api/2/CustomHierarchies/{hierarchyId}/relations/{portfolioId}* | Updates specific Level to Work Item type mapping for the specified hierarchy and portfolio. |
| *DELETE/align/api/2/CustomHierarchies/{hierarchyId}/relations/{portfolioId}* | Deletes all Level to Work Item type mappings for the specified hierarchy and portfolio. |
| *GET/align/api/2/CustomHierarchies/{hierarchyId}/levels/{id}/auditlog* | Returns auditLog of specific custom hierarchy level. |
Domains
| | |
|---|---|
| *GET/align/api/2/Domains* | Returns a list of custom hierarchy domains. |
| *POST/align/api/2/Domains* | Creates a custom hierarchy domain. |
| *GET/align/api/2/Domains/{id}* | Returns a specific custom hierarchy domain. |
| *PUT/align/api/2/Domains/{id}* | Update a specific custom hierarchy domain. |
| *PATCH/align/api/2/Domains/{id}* | Partially modify a specific custom hierarchy domain. |
| *DELETE/align/api/2/Domains/{id}* | Delete a specific custom hierarchy domain. |
| *GET/align/api/2/Domains/{domainId}/health* | Returns a list of custom hierarchy domain health change list with comments. |
| *POST/align/api/2/Domains/{domainId}/health* | Pushes changes to the `Health` status of the specified domain with comments. |
| *GET/align/api/2/Domains/{domainId}/health/{commentId}* | Returns a specific custom hierarchy domain health change with comment. |
| *GET/align/api/2/Domains/{id}/auditlog* | Returns auditLog of specific domain. |
Domain relations
| | |
|---|---|
| *POST/align/api/2/domains/{domainId}/relations* | Creates a domain work item relation. |
| *GET/align/api/2/domains/{domainId}/relations* | Returns a list of domain item relations. |
| *GET/align/api/2/domains/{domainId}/relations/{id}* | Returns a specific domain item relation. |
| *DELETE/align/api/2/domains/{domainId}/relations/{id}* | Delete a specific domain item relation. |
References
Last modified on Oct 22, 2024
Powered by Confluence and Scroll Viewport.