Report Management API

Set share information for report

post/api/2.0/reports/{objectId}/shares

Request

  • Base URL: https://app.agenticbi.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.agenticbi.com/api/2.0/reports/{objectId}/shares
  • Auth: HTTP bearer

Path parameters

objectIdinteger required

Report ID to set sharing information for

Response

Success

idinteger

ID of user or group to be shared to

typestring required

Share type

accessLevelinteger required

Share access level

namestring

Username + name or group name to be shared to. When sharing to a user, either id field or the combination of name, externalAuthId, and ssoUser have to be specified

externalAuthIdinteger

External authenticate ID to be shared to

ssoUserboolean

Whether or not user is SSO user

external_auth_idinteger
access_levelinteger
sso_userboolean

Example response

[
  {
    "type": "Users,Groups"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.