Retrieves the sharing configuration of a dynamic report.
Use this endpoint to populate a share dialog before calling PUT /dynamicReporting/{reportId}/share.
Only the report’s creator (with Shared Reports Create permission) or a report administrator may view sharing details.
To find out whether a report is shared at all without these permissions, read the Shared flag on GET /api/v202607/dynamicReporting/{reportId} instead.
Returns 404 if the report does not exist or the caller cannot see it; returns 403 if the caller can see it but may not view its sharing details.
Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| reportId | Unique numeric identifier of the dynamic report. | integer (int32) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
ShareResponse
| Property | Description | Type | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| sharedUserGroups | The list of user groups an item has been assigned to be shared with | UserGroupChild[] | ||||||||||||
|
UserGroupChild properties
|
||||||||||||||
| sharedUsers | The list of individual users an item has been assigned to be shared with This does NOT take into account users that are in a shared user group | UserChild[] | ||||||||||||
|
UserChild properties
|
||||||||||||||
| sharedWithEveryone | True if the item is shared with everyone | boolean | ||||||||||||
Example Response
{ "sharedUserGroups": [
{ "userGroupId": 1, "userGroupName": "string"
}
], "sharedUsers": [
{ "fullName": "string", "userCode": "string", "userId": 1
}
], "sharedWithEveryone": false
}
403
Forbidden
You do not have permission to access this resource. Check your user role and permissions.
404
Not Found
The requested resource was not found. Verify the ID or path is correct.