|
APIs in Category: user_report_profile |
API version 5.0 |
user-favorite-report-delete |
These APIs facilitate the management of favorites and recently viewed reports of a user. |
| user-favorite-report-delete | [top] |
Deletes favorite reports of a user or all users.
Input Name Range Type Description user-name string
optional
Name of user whose favorite reports are to be deleted. If not specified then favorite reports of all users will be deleted. Domain name\user name is required for windows.
Errno Description EACCESSDENIED EDATABASEERROR EINVALIDINPUT ENOFAVORITES
| user-favorite-report-list-info-iter-end | [top] |
The user-favorite-report-list-info-iter-* set of APIs are used to retrieve the list of user favorite counts. user-favorite-report-list-info-iter-end is used to tell the DFM station that the temporary store used by DFM to support the user-favorite-report-list-info-iter-next API for the particular tag is no longer necessary.
Input Name Range Type Description tag string
An internal opaque handle used by the DFM station
Errno Description EACCESSDENIED EINVALIDTAG
| user-favorite-report-list-info-iter-next | [top] |
For more documentation please check user-favorite-report-list-info-iter-start. The user-favorite-report-list-info-iter-next API is used to iterate over the members of user favorite report counts stored in the temporary store created by the user-favorite-report-list-info-iter-start API.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. Range: [1..2^31-1] tag string
Tag from a previous user-favorite-report-list-info-iter-start. It's an opaque handle used by the DFM station to identify the temporary store created by user-favorite-report-list-info-iter-start. Output Name Range Type Description favorites user-report-info[]
Number of favorite reports per user. records integer
The number of records actually returned. Range: [1..2^31-1]
Errno Description EACCESSDENIED EINVALIDINPUT EINVALIDTAG
| user-favorite-report-list-info-iter-start | [top] |
The user-favorite-report-list-info-iter-* set of APIs are used to retrieve the number of favorite reports of specified user or all users. It loads the list of user favorite report counts into a temporary store. The API returns a tag that identifies that temporary store so that subsequent APIs can be used to iterate over the list in the temporary store. If user-favorite-report-list-info-iter-start is invoked twice, then two distinct temporary stores are created.
Input Name Range Type Description user-name string
optional
Name of user. User can be a dfm or non-dfm user. If not specified then all users. Domain name\user name is required for windows. Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with user-favorite-report-list-info-iter-next. Range: [1..2^31-1] tag string
Tag to be used in subsequent calls to user-favorite-report-list-info-iter-next. It is an opaque handle used by the DFM station to identify a temporary store.
Errno Description EACCESSDENIED EDATABASEERROR EINVALIDINPUT ENOFAVORITES
| user-recent-report-delete | [top] |
Deletes recently viewed reports of a user or all users.
Input Name Range Type Description user-name string
optional
Name of user whose recenlty viewed reports are to be deleted. If not specified then recently viewed reports of all users will be deleted. Domain name\user name is required for windows.
Errno Description EACCESSDENIED EDATABASEERROR EINVALIDINPUT ENORECENTVIEWED
| user-recent-report-list-info-iter-end | [top] |
The user-recent-report-list-info-iter-* set of APIs are used to retrieve the list of user's recently viewed report counts. user-recent-report-list-info-iter-end is used to tell the DFM station that the temporary store used by DFM to support the user-recent-report-list-info-iter-next API for the particular tag is no longer necessary.
Input Name Range Type Description tag string
An internal opaque handle used by the DFM station
Errno Description EACCESSDENIED EINVALIDTAG
| user-recent-report-list-info-iter-next | [top] |
For more documentation please check user-recent-report-list-info-iter-start. The user-recent-report-list-info-iter-next API is used to iterate over the members of user's recently viewed report counts stored in the temporary store created by the user-recent-report-list-info-iter-start API.
Input Name Range Type Description maximum integer
The maximum number of entries to retrieve. Range: [1..2^31-1] tag string
Tag from a previous user-recent-report-list-info-iter-start. It's an opaque handle used by the DFM station to identify the temporary store created by user-recent-report-list-info-iter-start. Output Name Range Type Description recent-viewed user-report-info[]
Number of recently viewed reports per user. records integer
The number of records actually returned. Range: [1..2^31-1]
Errno Description EACCESSDENIED EINVALIDINPUT EINVALIDTAG
| user-recent-report-list-info-iter-start | [top] |
The user-recent-report-list-info-iter-* set of APIs are used to retrieve the number of recently viewed report count of specified user or all users. It loads the list of user's recently viewed report counts into a temporary store. The API returns a tag that identifies that temporary store so that subsequent APIs can be used to iterate over the list in the temporary store. If user-recent-report-list-info-iter-start is invoked twice, then two distinct temporary stores are created.
Input Name Range Type Description user-name string
optional
Name of user. User can be a dfm or non-dfm user. If not specified then all users. Domain name\user name is required for windows. Output Name Range Type Description records integer
Number which tells you how many items have been saved for future retrieval with user-recent-report-list-info-iter-next. Range: [1..2^31-1] tag string
Tag to be used in subsequent calls to user-recent-report-list-info-iter-next. It is an opaque handle used by the DFM station to identify a temporary store.
Errno Description EACCESSDENIED EDATABASEERROR EINVALIDINPUT ENORECENTVIEWED
| Element definition: user-report-info | [top] |
Report count of users.
Name Range Type Description count integer
Number of reports of a user. user-name string
Name of the user.