• State Verified Answer
  • Replies 2 replies
  • Subscribers 18 subscribers
  • Views 709 views
  • Users 0 members are here
Options
Related

Documentation issue for application subscription REST API?

Robert Hanson

Hi all,

I reviewed the Application Subscription REST API, and it seems to be missing a lot.  For example, there is no Delete Application Subscription endpoint, and the Set Application Subscription endpoint documentation doesn't have any documented parameters.

When I looked at the Application Subscription Widget API there is a lot more functionality (get, delete, set, canDelete, etc.).

Q: My question is, is this a case that the REST documentation not being complete, or is it that the REST functionality does not currently match what is in the Widget API?

Q2: If there is more functionality in the REST API, can you provide info on Creating and Deleting subscriptions?

Thanks.

Parents
  • Former Member
    +1 Former Member

    There does seem to be an issue with the documentation of the available parameters for those endpoints.  Those are all the endpoints that are available.  CanDeleteSubscription, CanSubscribe and  SupportsSubscriptions are functions related to the UI, probably why they were not duplicated to the REST Api.

    The Set endpoint handles both create and delete.  ApplicationId (guid), ApplicationTypeId (guid), IsSubscribed (bool) are the required fields, TypeId (guid) is optional.

    The List endpoint has options: ContainerId(guid), ApplicationTypeId (guid), TypeId (guid), IncludeSubContainers (bool), PageSize (int), PageIndex (int)

    The Get endpoint has options: ApplicationId (guid) is required, TypeId (guid) is optional.

    I also added a bug to review the documentation and determine why the parameter documentation is not being generated properly.

Reply
  • Former Member
    +1 Former Member

    There does seem to be an issue with the documentation of the available parameters for those endpoints.  Those are all the endpoints that are available.  CanDeleteSubscription, CanSubscribe and  SupportsSubscriptions are functions related to the UI, probably why they were not duplicated to the REST Api.

    The Set endpoint handles both create and delete.  ApplicationId (guid), ApplicationTypeId (guid), IsSubscribed (bool) are the required fields, TypeId (guid) is optional.

    The List endpoint has options: ContainerId(guid), ApplicationTypeId (guid), TypeId (guid), IncludeSubContainers (bool), PageSize (int), PageIndex (int)

    The Get endpoint has options: ApplicationId (guid) is required, TypeId (guid) is optional.

    I also added a bug to review the documentation and determine why the parameter documentation is not being generated properly.

Children

About
Privacy Policy
Terms of use
Copyright 2024 Verint, Inc.
Powered by Verint Community