Api rest for view all project area and project area creation
Hi everyone, I would like some clarifications.
I have searched far and wide, but unfortunately I have not found what is right for me, especially as I am a newbie to REST services so I apologize in advance.
After several searches I found this string for the project area getAll and it works:
https: // hostname: port / ccm / rpt / repository / foundation? fields = foundation / projectArea / (name | teamMembers / userId)
Now I wanted to ask you mainly the url and the body of the call for creating a workarea, as the body I would also have found it, maybe:
<? xml version = "1.0" encoding = "UTF-8"?><jp06: project-area xmlns: jp06 = "http://jazz.net/xmlns/prod/jazz/process/0.6/" jp06: templateId = "com.ibm.team.process.test" jp06: templateLocale = " en_US ">
<jp06: name> testProjectAreaCreation </ jp06: name>
<jp06: summary> The summary </ jp06: summary>
<jp06: description> The description </ jp06: description>
<jp06: visibility jp06: access = "PUBLIC" />
</ jp06: project-area>
But I can't find the url for the post call, I'm going crazy and above all I've often read that you postpone here:
https://jazz.net/wiki/bin/view/Main/DraftTeamProcessRestApi#Project_Areas_collection, but here I find only the "parameters" but not the end points for the calls. I also take this opportunity to find out if there is a sort of summary (including the end point, however) to do other operations as well, such as modifying a project area for example. I apologize for my English but it is the work of Google Translate.
Oh one last thing, for get or post calls, I have to login first right? And how do I know when the login call I have made expires?
Oh one last thing, for get or post calls, I have to login first right? And how do I know when the login call I have made expires?
Thanks everyone in advance.
Accepted answer
https://jazz.net/wiki/bin/view/Main/DraftTeamProcessRestApi#Service_Entry_Points_start_here
states:
Project Areas collectionURL: the value of the rdf:resource attribute from the projectAreas element in the server's rootservices document.
So you GET the rootservices e.g.
The response XML contains the services. You want the projectAreas service.
So in the example: https://elm.example.com:9443/ccm/process/project-areas is the Project Areas Collection URI to send to.
Comments
6 other answers
As far as I can tell, the API https://hostname:port/ccm/rpt/ is part of the reportable REST API. It is a read-only API.
I am not sure if there is a public REST API that allows to do what you want. So far I have always used the Plain Java Client Libraries to automate this. The https://jazz.net/wiki/bin/view/Main/DraftTeamProcessRestApi API would be your best bet. I will look and try to figure out what the URL should look like later and try to answer here, in case I can find it.
I share your feeling I have had similar issues with our REST and OSLC APIs.
Comments
Thanks Ralph, for the answer, but the link you gave me, which by the way is the one I found but that does not present the endpoints, or at least I can't see them, there are the "creation" posts also the body that I posted in question is taken from there but "parameterized" for my needs. The problem is that I can't find the call endpoints.
The guide would be better, from my point of view, if it did not deduce the end points but presented them directly, certainly it is my lack, but in my "ignorance" on the subject I could tell you that they exist because there are also posts of more "objects "it's just that the end point for the call is missing, anyway thanks again, if I find something else too, I'll update the post.
Thank you very much what you posted is very useful, this afternoon I will study it well. But I have to ask you two more questions, I try to post them here, otherwise I will open a new post.
The first is that all the calls, I see that require a login to be made, so at the moment I have two end points, one for the login and one for the request, I don't know if merging them together can solve the problem of separation, otherwise there is a way to not always request the login?
Another question, I have to create a project Area that inherits the process template from a father, is there any way to tell him in the call? I state that the list you provided me has not yet been studied well, but this afternoon I go under to see it, in the meantime, thank you very much.
@David Can you explain to me what you are referring to for OSCL is a completely new topic for me and I apologize for that. Thank you.
@David Can you explain to me what you are referring to for OSCL is a completely new topic for me and I apologize for that. Thank you.
Comments
If users try these APIs, I have to assume some basic knowledge of RTC and its administration.
If you want to use the API for something e.g. creating a project area, you better know how that works in the tool.
If you want to create an EWM Project, you have to provide a process template. Process templates are maintained in the admin section and have an ID which is clearly visible in the admin UI.
Another way of getting the process template ID would be to use the API we talk about here to GET the project areas and to inspect the response body for the ID's
Comments
Here I am again, re-reading the answer, I realized that maybe I have explained myself badly, I try to do it better.
This endPoint:
https://hostname:port/ccm/process/project-areas
If sent in get, it returns all the PAs present, if sent in post through a suitable body it should enter the PA.
Now making the call in get, I get the result if I do it in post it returns 403 to me (as long as the body is correct) but I do not think that the 403 is due to a failed login I believe more than anything else that it is not possible, but in the link above there is the get for the PA Collection that inserts one with two members, I tried to do exactly the same thing and the user with whom I do it has the rights to create them.
Note, In order to be able to POST successfully, add a header X-Jazz-CSRF-Prevent and in the value paste the value of the JSESSIONID Cookie from your session (e.g. you get it during the login or GET operations).
If you fail to do so, the server will reject the request with a 403 Forbidden. I am not aware if this is documented anywhere, but you can find it in the forum.
If you copy paste, make sure to replace the contributor URI's in the example to valid ones e.g. in my case
not
Comments