Retrieve the Profiles Administration API service document
The first step perform if you plan to update resources made available through the Profiles Administration APIs is to retrieve the Profiles Administration service document. It lists all of the fields that you can write to using the Profiles Administration API.The Profiles Administration service document defines a single workspace containing one collection. The collection defines a list of people with profiles in the Profiles application. The Web address in the href attribute of the collection provides a reference to a feed of all users.
The collection contains an <snx:editableFields> element that lists the profile fields that can be written to.
The person authenticating this request must have administrator level privileges to the Profiles application in order to be able to retrieve the service document and perform actions using the administration APIs. See Roles for more details.
Table 1. Atom API request details
Method Resource URI GET Service Document /admin/atom/profileService.do
Returned HTTP headers
HTTP/1.1 200 OK: Indicates that the request was received successfully.
- HTTP/1.1 400 Bad Request. Returned when no matching user record can be found.
- HTTP/1.1 401 Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.
Example
Request:
> GET /profiles/admin/atom/profileService.do HTTP/1.1 > Authorization: xxx > Host: enterprise.example.com > Accept: */*Response:
< HTTP/1.1 200 OKThe service document for Profiles is returned by the server. For example:
<service> <atom:generator version="3.0" uri="http://www.ibm.com/xmlns/prod/sn"> IBM Connections - Profiles </atom:generator> <workspace> <atom:title type="text">Profiles Administration Workspace</atom:title> <collection href="https://lc30linux4.swg.usma.ibm.com/profiles/admin/atom/profiles.do"> <atom:title type="text">All User Profiles</atom:title> <accept>application/atom+xml;type=entry</accept> <atom:category term="profiles-admin" scheme="http://www.ibm.com/xmlns/prod/sn/workspace"/> <atom:category term="connections-users" scheme="http://www.ibm.com/xmlns/prod/sn/collection"/> <snx:editableFields> <snx:editableField name="com.ibm.snx_profiles.base.groupwareEmail"/> <snx:editableField name="com.ibm.snx_profiles.base.shift"/> <snx:editableField name="com.ibm.snx_profiles.base.pagerServiceProvider"/> <snx:editableField name="com.ibm.snx_profiles.base.profileType"/> <snx:editableField name="com.ibm.snx_profiles.base.nativeFirstName"/> <snx:editableField name="com.ibm.snx_profiles.base.guid"/> <snx:editableField name="com.ibm.snx_profiles.base.mobileNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.floor"/> <snx:editableField name="com.ibm.snx_profiles.base.employeeTypeCode"/> <snx:editableField name="com.ibm.snx_profiles.base.employeeNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.courtesyTitle"/> <snx:editableField name="com.ibm.snx_profiles.base.email"/> <snx:editableField name="com.ibm.snx_profiles.base.pagerType"/> <snx:editableField name="com.ibm.snx_profiles.base.orgId"/> <snx:editableField name="com.ibm.snx_profiles.base.countryCode"/> <snx:editableField name="com.ibm.snx_profiles.base.isManager"/> <snx:editableField name="com.ibm.snx_profiles.base.givenName"/> <snx:editableField name="com.ibm.snx_profiles.base.freeBusyUrl"/> <snx:editableField name="com.ibm.snx_profiles.base.jobResp"/> <snx:editableField name="com.ibm.snx_profiles.base.alternateLastname"/> <snx:editableField name="com.ibm.snx_profiles.base.pagerId"/> <snx:editableField name="com.ibm.snx_profiles.base.ipTelephoneNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.faxNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.bldgId"/> <snx:editableField name="com.ibm.snx_profiles.base.uid"/> <snx:editableField name="com.ibm.snx_profiles.base.calendarUrl"/> <snx:editableField name="com.ibm.snx_profiles.base.sourceUrl"/> <snx:editableField name="com.ibm.snx_profiles.base.title"/> <snx:editableField name="com.ibm.snx_profiles.base.preferredFirstName"/> <snx:editableField name="com.ibm.snx_profiles.base.surname"/> <snx:editableField name="com.ibm.snx_profiles.base.key"/> <snx:editableField name="com.ibm.snx_profiles.base.preferredLastName"/> <snx:editableField name="com.ibm.snx_profiles.base.managerUid"/> <snx:editableField name="com.ibm.snx_profiles.base.loginId"/> <snx:editableField name="com.ibm.snx_profiles.base.officeName"/> <snx:editableField name="com.ibm.snx_profiles.base.experience"/> <snx:editableField name="com.ibm.snx_profiles.base.pagerNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.displayName"/> <snx:editableField name="com.ibm.snx_profiles.base.telephoneNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.blogUrl"/> <snx:editableField name="com.ibm.snx_profiles.base.deptNumber"/> <snx:editableField name="com.ibm.snx_profiles.base.distinguishedName"/> <snx:editableField name="com.ibm.snx_profiles.base.workLocationCode"/> <snx:editableField name="com.ibm.snx_profiles.base.nativeLastName"/> <snx:editableField name="com.ibm.snx_profiles.base.secretaryUid"/> <snx:editableField name="com.ibm.snx_profiles.base.preferredLanguage"/> <snx:editableField name="com.ibm.snx_profiles.base.timezone"/> <snx:editableField name="com.ibm.snx_profiles.base.description"/> <snx:editableField name="com.ibm.snx_profiles.base.lastUpdate"/> <snx:editableField name="com.ibm.snx_profiles.ext.profileLinks"/> <snx:editableField name="com.ibm.snx_profiles.sys.orgMem"/> <snx:editableField name="com.ibm.snx_profiles.sys.orgAcl"/> <snx:editableField name="com.ibm.snx_profiles.sys.usrState"/> </snx:editableFields> </collection> </workspace> </service>
Parent topic
Profiles Administration API
Related tasks
Customize the Profiles user interfaceRelated reference
Roles
});