How can we help?

Searching:

0 results found
backBack

Reports/[id]/share

POST /odata/Reports/[id]/share

Description

Shares one or more specific reports (as specified by the report id(s) in the request) with the Users of specific Applications, Tenants or Sub‑tenants so that those Users can subscribe to this report in the Axonize Portal, as described below. The id of a report is returned in the response to the Reports/Post and Reports/Get endpoints. The following provides more details.

Axonize Users can subscribe to automatically receive periodic Axonize reports by email.

To do so, either –

  • Use the Reports/[id]/subscribe

– OR –

  • In the Axonize Portal – A User can click the Reports option in the left pane and then select the Subscription tab. A list of reports to which they can subscribe is displayed. That User can then mark the Subscribed checkbox in order to start automatically receiving periodic reports by email.

The list of reports that appear for selection is determined by those that are shared by the report creator, Application User or Tenant User, as follows –

  • Application Users can share with Users of the same Application.
  • Tenant Users can share with all the Users of all the Applications of that Tenant or with specific Users of that Tenant.
  • Sub-tenants can share with Users of all the Applications of the same Sub-tenant.

Note ‒ Tenant Users who want to share this report with all the Users of a Tenant’s Applications should select to share with the Tenant itself (and not by selecting each of the Applications of the Tenant). By selecting to share with the Tenant itself, this report will also be shared with all the new Applications added to this Tenant or to its Sub-tenants.

See the following for request and response details ‒

See Also

Request ‒ Reports/{id}/share

Property Type Description Mandatory
id String This is the unique identifier automatically assigned by Axonize when a Report is created. This ID is returned in the response of the Reports/Post. Y
tenants Array of Strings The unique identifier of one or more Axonize Tenants with whom to share this report with its Users. This identifier is automatically generated by Axonize and is returned in response to the Tenants/Post request.
applicationId Array of Strings The unique identifier of one or more Axonize Applications with whom to share this report with its Users. This identifier is automatically added by Axonize when the Applications/Post request is used.

Example JSON Reports/[id]/share Request

curl -X POST \

https://api.stg.axonize.com/odata/reports/5b682f64e5cdcf20a87788d8/share/\

-H ‘Content-Type: application/json’ \

-H ‘Authorization: Token’ \

-H ‘appId: be517433-c4b8-4748-9258-1b1234567890’ \

-d ‘ {“applicationsIds”:[“8f71b610-34ab-1234-5674-7228d5f68a08″,”e8f2873f-1234-5674-8a08-02f884853960″],”tenants”:[“e8f2873f-0cab-4fa2-8a08-8a0884858a08”]}’

Response ‒ Reports/[id]/share

All the same properties in the request are returned in the response.

Example JSON Reports/[id]/share Response

Status 200 – OK