Need API link for Customers

Manoj Kumar May 17, 2021

Hi All,

         I am having a hard time finding the API link for customers in JiraAlign.

For example in our instance: The first one for users works whereas the second one for users doesn't work.

  1. https://myinstance.jiraalign.com/api/users (This works)
  2. https://myinstance.jiraalign.com/align/api/2/users (doesn't work)

Similarly, I am trying to find the working link for Customers. When I use the similar as the first one from above it outputs an error.

 

The link I'm trying for Customers: https://myinstance.jiraalign.com/api/customer

The error I'm getting: "Message": "No HTTP resource was found that matches the request URI

 

Any help here is appreciated.

 

Thank you,

Manoj

2 answers

1 accepted

1 vote
Answer accepted
Allan Maxwell
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 18, 2021

Try this ...note the bolded text "rest"

https://mycustomer.jiraalign.com/rest/align/api/2

NOT

https://mycustomer.jiraalign.com/align/api/2

Manoj Kumar May 18, 2021

Hi @Allan Maxwell ,

                               Even this link is not working for me. Please see the screenshot.

I am using this link : https://ncrengtoolstest.jiraalign.com/rest/align/api/2/usersCapture75.PNG

 

Thank you,

Manoj

Allan Maxwell
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 18, 2021

The API2 is not on by default, so you would need to turn that on using a Master Toggle ...that's my best guess.

Manoj Kumar May 18, 2021

Hi @Allan Maxwell , It's already enabled but still not able to access the data.

Also, FYI first URL doesn't work whereas the second works.

  1. https://ncrengtoolstest.jiraalign.com/rest/align/api/2/users
  2. https://ncrengtoolstest.jiraalign.com/api/users

MicrosoftTeams-image (9).png

Thank you,

Manoj

Allan Maxwell
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 18, 2021

If I use PostMan then https://ABC.jiraalign.com/rest/align/api/2/users works fine.  If I just paste it into a browser URL bar, I get the same error that you are getting.

0 votes
Rodrigo Cortez
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 18, 2021

Hi @Manoj Kumar 

There you go with the endpoints for these objects (and corresponding DTO schemas):

  • /align/api/2/Customers
    • AgileCraft.Services.Models.Customers.CustomerDto
  • /align/api/2/Users
    • AgileCraft.Services.Models.Users.UserDto

You can find all available endpoints by browsing to your instance's Swagger:

Notice that authorization is based on the authenticated user when Jira Align REST APIs are called.  User privileges, such as data and page access, via the REST APIs are identical to privileges in the interface.  For example, if a user's system role provides read-only access to epics in a single portfolio, the user will not be able to create or update epics with the API, and will only be able to read epics from the single portfolio.

Manoj Kumar May 18, 2021

Hi @Rodrigo Cortez ,

                                  The URLs don't work for me this is why I'm checking if I am doing wrong here. Attached the screenshot.

Also, I am super admin in the tool so it's no issue with the permissions.Capture74.PNG

 

Thank you,

Manoj

Rodrigo Cortez
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
May 19, 2021

Hi @Manoj Kumar ,

/align/api/2/Users and /align/api/2/Customers are API 2.0 endpoints, not regular web pages that one can browse to.

Browse to your Swagger page https://ncrengtoolstest.jiraalign.com/rest/align/api/docs/index.html and, once authorized, you'll be able to try out all of them from there.

Screen Shot 2021-05-19 at 08.57.05.png

 

Please review this getting started article for information on how to create & user a bearer token in Swagger.

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events