Report - Shares a report with a user

Share the requested report to the specified user.

post

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

reportIdstring · uuidRequired

Enter ID of the report to share.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Body

application/jsontext/jsonapplication/*+json

Class for share and revoke access of the report.

notifyByEmailbooleanOptional

A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the NotifyByEmail property.

Responses

200

Success: The report was successfully shared with the specified user.

text/plainapplication/jsontext/json

Class for representing response.

messagestring · nullableOptional

A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the Message property.

Default: Success Message

statusCodeinteger · int32Optional

A public property of type integer that has both a getter and a setter method, which allows for getting and setting the value of the StatusCode property.

Default: 200

400

Bad Request: The request was invalid or missing required parameters.

text/plainapplication/jsontext/json

403

Forbidden: Permission denied to share the report.

text/plainapplication/jsontext/json

404

Not Found: The specified report does not exist or report is not accessible with the user.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected server error occurred.

text/plainapplication/jsontext/json

post

/reports/{reportId}/share

HTTPcURLJavaScriptPython

POST /reports/{reportId}/share HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "sharedWith": [
    {
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "email": "text"
    }
  ],
  "notifyByEmail": true
}

application/jsontext/jsonapplication/*+json

{
  "message": "Success Message",
  "statusCode": 200
}