Informational API Calls for WebReports

The WebReports informational API calls allow external applications to retrieve WebReports configuration and management information.

These calls can return information about:

• User Defined Fields (UDFs)
• Connection Profiles
• Roles
• Users
• Report Assignments

Use this article as a reference for the available informational API endpoints and examples.

Before You Begin

Before using these API calls:

• Confirm that WebReports is accessible.
• Confirm that the account has the API role or that a valid API key is available.
• Establish an authenticated WebReports connection.
• Store the authentication cookie required for subsequent API requests.

See:

Establish Connection & Store Cookie

These API calls retrieve information from WebReports. They do not create, update, or delete users, roles, UDFs, or report assignments.

Informational API Endpoints

The following informational endpoints are available:

Get User Defined Fields

Use the following endpoint to retrieve the available WebReports UDFs:

/extapi/APIWebReport/UserDefinedFields

The response returns UDF information including the Name, Description, and Query Identifier.

Example

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject("", Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/UserDefinedFields", Params).GetAwaiter().GetResult()

Get Connection Profiles

Use the following endpoint to retrieve the available WebReports connections:

/extapi/APIWebReport/Connections

Example

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject("", Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/Connections", Params).GetAwaiter().GetResult()

The response returns a list of available WebReports connections.

Get Roles

Use the following endpoint to retrieve the available WebReports roles:

/extapi/APIWebReport/Roles

Example

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject("", Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/Roles", Params).GetAwaiter().GetResult()

The response returns a list of roles configured in WebReports.

Get Users

Use the following endpoint to retrieve the WebReports user list:

/extapi/APIWebReport/GetUsersList

Example

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject("", Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/GetUsersList", Params).GetAwaiter().GetResult()

The response returns a list of WebReports usernames.

Get Report Assignments

Use the following endpoint to retrieve WebReports report assignments:

/extapi/APIWebReport/GetReportAssignments

The response returns a list of ReportAssignment objects.

ReportAssignment Structure

public class ReportAssignment
{
    public string Id { get; set; }
    public string Name { get; set; }
    public string ViewId { get; set; }
    public string ConnectionName { get; set; }
    public string Role { get; set; }
    public string Category { get; set; }
    public string Description { get; set; }
    public string Type { get; set; }
}

Example

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject("", Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/extapi/APIWebReport/GetReportAssignments", Params).GetAwaiter().GetResult()

Using the API Key Controller

The informational endpoints can also be used with the API Key Controller.

Available endpoints include:

/extapi/APIWebReport/UserDefinedFields
/extapi/APIWebReport/Connections
/extapi/APIWebReport/Roles
/extapi/APIWebReport/GetUsersList

Use the authentication method required by your WebReports API integration.

Troubleshooting

API Call Is Not Authorized

If an informational API call returns an authorization error:

• Confirm that the account has the required API role.
• Confirm that the API key is valid if one is being used.
• Verify that the WebReports connection was successfully established.
• Confirm that the stored authentication session is still valid.

API Call Returns No Results

If the API call succeeds but returns no data:

• Confirm that the requested information exists in WebReports.
• Verify that you are connected to the correct WebReports environment.
• Confirm that the endpoint is entered correctly.

API Call Cannot Reach WebReports

• Confirm that the WebReports server URL is correct.
• Confirm that WebReports is running and accessible.
• Verify the endpoint path.
• Confirm that the calling application can communicate with the WebReports server.

If the issue continues, contact BridgeWorks Support.

Related Articles

• WebReports API Calls
• Establish Connection & Store Cookie
• API Calls for Report Assignments in WebReports
• API Calls for Managing UDFs in WebReports
• API Calls for Managing Roles in WebReports