User profile data

<< Click to Display Table of Contents >>

Navigation:  Application integration > Bizagi RESTful API > Bizagi API examples > Data services examples >

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 can query data related to the authenticated user.

 

note_pin

This resource is available for all users, not just Stakeholders.

 

Resource URL

Start with the following URL:

[your_bizagi_project_url]/odata/data/userProfile

 

Customizations:

[your_bizagi_project_url]: The URL where end users access the Bizagi Work Portal.

For an on-premises Bizagi project, the URL would be:

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

For Automation Service projects, the 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 information structure:

{

 "@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"

}