/profile
Searches all users in the system and returning the metadata for all matches against the given search filter. Optionally provide before and after params to specify a time range [after, before] for last-logged-in profiles matching in that range (inclusive). If before is not specified (or a negative number is provided) but after is valid, the query will return all records successive to the given after timestamp. Similarly, if after is not specified (or a negative number is provided) but before is valid, the query will return all records preceding the given before timestamp. Note that search and time range parameters currently cannot be combined in the same query.
020GET /api/rest/profile HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Supplying the create profile request, this will update the profile with the new information supplied in the body of the request. This will fire an event, dev.getelements.elements.service.profile.created, from the event manifest.
Represents a request to create a profile for a user.
The user id this profile belongs to.
The application id this profile belongs to.
A URL to the image of the profile. (ie the User's Avatar).
A non-unique display name for this profile.
A map of arbitrary metadata.
POST /api/rest/profile HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 87
{
"userId": null,
"applicationId": null,
"imageUrl": null,
"displayName": null,
"metadata": null
}{
"code": "text",
"message": "text"
}Supplying an update request will attempt to update the profile. The call will return the profile as it was written to the database.
Represents a request to update a profile.
A URL to the image of the profile. (ie the User's Avatar).
A non-unique display name for this profile.
A map of arbitrary metadata.
PUT /api/rest/profile/{profileId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 52
{
"imageUrl": null,
"displayName": null,
"metadata": null
}{
"code": "text",
"message": "text"
}Deletes and permanently removes the Profile from the server. The server maykeep some record around to preserve relationships and references, but this profile will not be accessible again until it is recreated.
DELETE /api/rest/profile/{profileId} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}This is a special endpoing which fetches the current Profile based on current auth credentials. This considers the currently loggged-in Dser as well as the Application or Application Configuration against which the User is operating. This may not be availble, in which case the appopraite error is rasied.
GET /api/rest/profile/current HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Gets a specific profile by profile ID.
GET /api/rest/profile/{name} HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Accept: */*
{
"code": "text",
"message": "text"
}Represents a request to update an image profile.
MimeType of image
PUT /api/rest/profile/{profileId}/image HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 17
{
"mimeType": null
}{
"code": "text",
"message": "text"
}Last updated