APIs in Category: UserReportProfile | API version 5.0

UserFavoriteReportDelete UserFavoriteReportListInfoIterEnd UserFavoriteReportListInfoIterNext UserFavoriteReportListInfoIterStart UserRecentReportDelete UserRecentReportListInfoIterEnd UserRecentReportListInfoIterNext UserRecentReportListInfoIterStart | These APIs facilitate the management of Favorites and recently viewed Reports of a user.

NetApp Manage ONTAP API version 5.0

UserFavoriteReportDelete (supported) | [top]

> Deletes favorite Reports of a user or all users.

> Input Name | Type
> UserFavoriteReportDelete | UserFavoriteReportDelete
> Output Name | Type
> UserFavoriteReportDeleteResult | UserFavoriteReportDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> ENOFAVORITES |  |

UserFavoriteReportListInfoIterEnd (supported) | [top]

> The UserFavoriteReportListInfoIter* set of APIs are used To retrieve the list of user favorite counts. UserFavoriteReportListInfoIterEnd is used To tell the DFM station that the temporary store used by DFM To support the UserFavoriteReportListInfoIterNext API for the particular Tag is no longer necessary.

> Input Name | Type
> UserFavoriteReportListInfoIterEnd | UserFavoriteReportListInfoIterEnd
> Output Name | Type
> UserFavoriteReportListInfoIterEndResult | UserFavoriteReportListInfoIterEndResult

> Error Name | Description
> EACCESSDENIED |  |
> EINVALIDTAG |  |

UserFavoriteReportListInfoIterNext (supported) | [top]

> For more documentation please check UserFavoriteReportListInfoIterStart. The UserFavoriteReportListInfoIterNext API is used To iterate over the Members of user favorite report counts stored in the temporary store created by the UserFavoriteReportListInfoIterStart API.

> Input Name | Type
> UserFavoriteReportListInfoIterNext | UserFavoriteReportListInfoIterNext
> Output Name | Type
> UserFavoriteReportListInfoIterNextResult | UserFavoriteReportListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

UserFavoriteReportListInfoIterStart (supported) | [top]

> The UserFavoriteReportListInfoIter* 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 UserFavoriteReportListInfoIterStart is invoked twice, then two distinct temporary stores are created.

> Input Name | Type
> UserFavoriteReportListInfoIterStart | UserFavoriteReportListInfoIterStart
> Output Name | Type
> UserFavoriteReportListInfoIterStartResult | UserFavoriteReportListInfoIterStartResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> ENOFAVORITES |  |

UserRecentReportDelete (supported) | [top]

> Deletes recently viewed Reports of a user or all users.

> Input Name | Type
> UserRecentReportDelete | UserRecentReportDelete
> Output Name | Type
> UserRecentReportDeleteResult | UserRecentReportDeleteResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> ENORECENTVIEWED |  |

UserRecentReportListInfoIterEnd (supported) | [top]

> The UserRecentReportListInfoIter* set of APIs are used To retrieve the list of user's recently viewed report counts. UserRecentReportListInfoIterEnd is used To tell the DFM station that the temporary store used by DFM To support the UserRecentReportListInfoIterNext API for the particular Tag is no longer necessary.

> Input Name | Type
> UserRecentReportListInfoIterEnd | UserRecentReportListInfoIterEnd
> Output Name | Type
> UserRecentReportListInfoIterEndResult | UserRecentReportListInfoIterEndResult

> Error Name | Description
> EACCESSDENIED |  |
> EINVALIDTAG |  |

UserRecentReportListInfoIterNext (supported) | [top]

> For more documentation please check UserRecentReportListInfoIterStart. The UserRecentReportListInfoIterNext API is used To iterate over the Members of user's recently viewed report counts stored in the temporary store created by the UserRecentReportListInfoIterStart API.

> Input Name | Type
> UserRecentReportListInfoIterNext | UserRecentReportListInfoIterNext
> Output Name | Type
> UserRecentReportListInfoIterNextResult | UserRecentReportListInfoIterNextResult

> Error Name | Description
> EACCESSDENIED |  |
> EINVALIDINPUT |  |
> EINVALIDTAG |  |

UserRecentReportListInfoIterStart (supported) | [top]

> The UserRecentReportListInfoIter* 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 UserRecentReportListInfoIterStart is invoked twice, then two distinct temporary stores are created.

> Input Name | Type
> UserRecentReportListInfoIterStart | UserRecentReportListInfoIterStart
> Output Name | Type
> UserRecentReportListInfoIterStartResult | UserRecentReportListInfoIterStartResult

> Error Name | Description
> EACCESSDENIED |  |
> EDATABASEERROR |  |
> EINVALIDINPUT |  |
> ENORECENTVIEWED |  |

Element definition: UserFavoriteReportDelete | [top]

> Deletes favorite Reports of a user or all users.

> Name | Type | Description
> UserName | xsd: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.

Element definition: UserFavoriteReportDeleteResult | [top]

> [none]

Element definition: UserFavoriteReportListInfoIterEnd | [top]

> The UserFavoriteReportListInfoIter* set of APIs are used To retrieve the list of user favorite counts. UserFavoriteReportListInfoIterEnd is used To tell the DFM station that the temporary store used by DFM To support the UserFavoriteReportListInfoIterNext API for the particular Tag is no longer necessary.

> Name | Type | Description
> Tag | xsd:string | An internal opaque handle used by the DFM station

Element definition: UserFavoriteReportListInfoIterEndResult | [top]

> [none]

Element definition: UserFavoriteReportListInfoIterNext | [top]

> For more documentation please check UserFavoriteReportListInfoIterStart. The UserFavoriteReportListInfoIterNext API is used To iterate over the Members of user favorite report counts stored in the temporary store created by the UserFavoriteReportListInfoIterStart API.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..2^31-1]
> Tag | xsd:string | Tag From a previous UserFavoriteReportListInfoIterStart. It's an opaque handle used by the DFM station To identify the temporary store created by UserFavoriteReportListInfoIterStart.

Element definition: UserFavoriteReportListInfoIterNextResult | [top]

> Name | Type | Description
> Favorites | ArrayOfUserReportInfo | Number of favorite Reports per user.
> Records | xsd:integer | The number of Records actually returned. Range: [1..2^31-1]

Element definition: UserFavoriteReportListInfoIterStart | [top]

> The UserFavoriteReportListInfoIter* 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 UserFavoriteReportListInfoIterStart is invoked twice, then two distinct temporary stores are created.

> Name | Type | Description
> UserName | xsd: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.

Element definition: UserFavoriteReportListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number which tells you how many items have been saved for future retrieval with UserFavoriteReportListInfoIterNext. Range: [1..2^31-1]
> Tag | xsd:string | Tag To be used in subsequent calls To UserFavoriteReportListInfoIterNext. It is an opaque handle used by the DFM station To identify a temporary store.

Element definition: UserRecentReportDelete | [top]

> Deletes recently viewed Reports of a user or all users.

> Name | Type | Description
> UserName | xsd: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.

Element definition: UserRecentReportDeleteResult | [top]

> [none]

Element definition: UserRecentReportListInfoIterEnd | [top]

> The UserRecentReportListInfoIter* set of APIs are used To retrieve the list of user's recently viewed report counts. UserRecentReportListInfoIterEnd is used To tell the DFM station that the temporary store used by DFM To support the UserRecentReportListInfoIterNext API for the particular Tag is no longer necessary.

> Name | Type | Description
> Tag | xsd:string | An internal opaque handle used by the DFM station

Element definition: UserRecentReportListInfoIterEndResult | [top]

> [none]

Element definition: UserRecentReportListInfoIterNext | [top]

> For more documentation please check UserRecentReportListInfoIterStart. The UserRecentReportListInfoIterNext API is used To iterate over the Members of user's recently viewed report counts stored in the temporary store created by the UserRecentReportListInfoIterStart API.

> Name | Type | Description
> Maximum | xsd:integer | The Maximum number of entries To retrieve. Range: [1..2^31-1]
> Tag | xsd:string | Tag From a previous UserRecentReportListInfoIterStart. It's an opaque handle used by the DFM station To identify the temporary store created by UserRecentReportListInfoIterStart.

Element definition: UserRecentReportListInfoIterNextResult | [top]

> Name | Type | Description
> RecentViewed | ArrayOfUserReportInfo | Number of recently viewed Reports per user.
> Records | xsd:integer | The number of Records actually returned. Range: [1..2^31-1]

Element definition: UserRecentReportListInfoIterStart | [top]

> The UserRecentReportListInfoIter* 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 UserRecentReportListInfoIterStart is invoked twice, then two distinct temporary stores are created.

> Name | Type | Description
> UserName | xsd: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.

Element definition: UserRecentReportListInfoIterStartResult | [top]

> Name | Type | Description
> Records | xsd:integer | Number which tells you how many items have been saved for future retrieval with UserRecentReportListInfoIterNext. Range: [1..2^31-1]
> Tag | xsd:string | Tag To be used in subsequent calls To UserRecentReportListInfoIterNext. It is an opaque handle used by the DFM station To identify a temporary store.

Element definition: ArrayOfUserReportInfo | [top]

> Name | Type | Description
> UserReportInfo | UserReportInfo[] |

Element definition: UserReportInfo | [top]

> Report Count of users.

> Name | Type | Description
> Count | xsd:integer | Number of Reports of a user.
> UserName | xsd:string | Name of the user.