User profile data

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > OData services > Services index > Data services >

User profile data

Overview

Bizagi features an OData service which handles aspects of the Experience design, as described at Data services.

Through the UserProfile URI, you may query data related to the authenticated user.

 

note_pin

This resource is available for all users, regardless of being Stakeholders or not.

 

Resource URL

Start off from the following URL:

[your_bizagi_project_url]/odata/data/userProfile

 

Consider:

[your_bizagi_project_url]: Corresponds to the URL where end users access the Bizagi Work portal.

For instance for an on-premise Bizagi project, such URL would be:

https://[your_server]/[your_project]/odata/data/userProfile

While for Bizagi PaaS projects, such URL would be:

https://[project_environment]-[your_project]-[your_company].bizagi.com/odata/data/userProfile

 

note_pin

This resource is available through an HTTP GET action.

 

Example

The following image illustrates how you can send an HTTP GET for this resource:

 

OData_Profile

 

 

 

Querying this resource yields the following structure of information:

{

 "@odata.context": "[your_bizagi_project_url]/odata/data/$metadata#userProfile",

 "@odata.id": "[your_bizagi_project_url]/odata/data/userProfile",

 "userName": "tomh",

 "domain": "agilityCorp",

 "fullName": "Tom Hall",

 "email": "tomh@agilityCorp.com",

 "picture": "[your_bizagi_project_url]/odata/image?code=ew0KICAiaWRVc2VyIjogNg0KfQ==",

 "userInits": "TH"

}