Access to user information via the web
What is the sanctioned way to access user information via the web? For
example, to query the current user, to find a user by name, etc. I note
there is a service
service/com.ibm.team.repository.common.internal.IContributorRestService that
seems to return the current user, but I cannot call that service.
There is another service,
com.ibm.team.workitem.common.internal.rest.IWorkItemRestService, that I
*can* call to access lists of users.
Both of these are marked internal, so presumably I should not call them. Is
the current recommended approach that I should provide my own service that
implements the user access I need in my web UI?
example, to query the current user, to find a user by name, etc. I note
there is a service
service/com.ibm.team.repository.common.internal.IContributorRestService that
seems to return the current user, but I cannot call that service.
There is another service,
com.ibm.team.workitem.common.internal.rest.IWorkItemRestService, that I
*can* call to access lists of users.
Both of these are marked internal, so presumably I should not call them. Is
the current recommended approach that I should provide my own service that
implements the user access I need in my web UI?
2 answers
Just a minor update - I can call the IContributorRestService successfully.
But my question still stands, "should I, and if not what is the
alternative?"
"fmcgrath" <fmcgrath@us.ibm.com> wrote in message
news:fdc0c6$mbm$1@localhost.localdomain...
But my question still stands, "should I, and if not what is the
alternative?"
"fmcgrath" <fmcgrath@us.ibm.com> wrote in message
news:fdc0c6$mbm$1@localhost.localdomain...
What is the sanctioned way to access user information via the web? For
example, to query the current user, to find a user by name, etc. I note
there is a service
service/com.ibm.team.repository.common.internal.IContributorRestService
that seems to return the current user, but I cannot call that service.
There is another service,
com.ibm.team.workitem.common.internal.rest.IWorkItemRestService, that I
*can* call to access lists of users.
Both of these are marked internal, so presumably I should not call them.
Is the current recommended approach that I should provide my own service
that implements the user access I need in my web UI?
Hi Frank -
Those methods are marked internal to note that they are subject to
change without warning - they're not API, in other words, and so you
shouldn't use them as such. When you say "via the web", I'm assuming
that you're referring to a RESTful resource-oriented architecture?
We will have REST services, URIs and representations that will be
treated as API, but we're not there yet, and I'm not in a position to
say when we will be. An example - on a server that I have access to,
putting the following into a browser will yield XML:
http://jazzdev.torolab.ibm.com:9980/jazz/service/com.ibm.team.repository.common.internal.IItemRestService/com.ibm.team.repository/itemName/Contributor/lainhart
The returned schema is exploratory and will change. If you have a tool
that will allow you to specify text/json as the Accept header value
(take a look at HttpUtil.MediaType, when M3 is deployed), you'll get
back some JSON that's closer to what we'll release in M4 (I hope, but
I'm not in a position to commit to).
The syntax of the URI will most likely change as well (for the better :-)).
-- Todd
fmcgrath wrote:
Those methods are marked internal to note that they are subject to
change without warning - they're not API, in other words, and so you
shouldn't use them as such. When you say "via the web", I'm assuming
that you're referring to a RESTful resource-oriented architecture?
We will have REST services, URIs and representations that will be
treated as API, but we're not there yet, and I'm not in a position to
say when we will be. An example - on a server that I have access to,
putting the following into a browser will yield XML:
http://jazzdev.torolab.ibm.com:9980/jazz/service/com.ibm.team.repository.common.internal.IItemRestService/com.ibm.team.repository/itemName/Contributor/lainhart
The returned schema is exploratory and will change. If you have a tool
that will allow you to specify text/json as the Accept header value
(take a look at HttpUtil.MediaType, when M3 is deployed), you'll get
back some JSON that's closer to what we'll release in M4 (I hope, but
I'm not in a position to commit to).
The syntax of the URI will most likely change as well (for the better :-)).
-- Todd
fmcgrath wrote:
Just a minor update - I can call the IContributorRestService successfully.
But my question still stands, "should I, and if not what is the
alternative?"
"fmcgrath" <fmcgrath@us.ibm.com> wrote in message
news:fdc0c6$mbm$1@localhost.localdomain...
What is the sanctioned way to access user information via the web? For
example, to query the current user, to find a user by name, etc. I note
there is a service
service/com.ibm.team.repository.common.internal.IContributorRestService
that seems to return the current user, but I cannot call that service.
There is another service,
com.ibm.team.workitem.common.internal.rest.IWorkItemRestService, that I
*can* call to access lists of users.
Both of these are marked internal, so presumably I should not call them.
Is the current recommended approach that I should provide my own service
that implements the user access I need in my web UI?