Develop > Application Programming Interface > Legacy APIs > User API > List subscriptions for user

List subscriptions for user

Details

URI /user/mysubscription
Method GET
Parameters

userIdentifier=<user_id>

Required; this user must be in the same organization as requestor, and must have the necessary permissions for the data you want to work with.See Get userIdentifier for the steps required to get the userIdentifier value.

scope=[base|view]

    Optional; default is base.

detail=basic

    Optional; The only valid value is basic.

requestor=<user_name>

Required; user name must be valid, and is the user whose subscription list will be returned by this call. requestor must be in the same organization as the user specified by userIdentifier.

returnRetired=[true|false]

Optional; default is false.

creationStartDate=<yyyy-MM-ddTHH:mm:ss>

Optional; subscriptions created on or after start date and time will be included in the return.

creationEndDate=<yyyy-MM-ddTHH:mm:ss>

Optional; subscriptions created before end date and time will be included in the return. Note that creationStartDate must also be specified.

modificationStartDate=<yyyy-MM-ddTHH:mm:ss>

Optional; subscriptions updated on or after specified start date and time will be included in the return.

modificationEndDate=<yyyy-MM-ddTHH:mm:ss>

Optional; subscriptions updated before specified end date and time will be included in the return. Note that modificationStartDate must also be specified.

Note that in all date parameters:

  • T serves as a separator between date and time.
  • Time will default to 00:00:00 if not specified.
  • Date and time are assumed to be in the time zone of the CSA server.

restrict=[true|false]

 Optional; default is true. If the value is true, then the output fields of the REST response are restricted. By default, the following fields are not displayed: createdBy, updatedBy, createdOn, updatedOn, description, iconUrl, and categoryType. If the value is false, then the output fields are displayed.

For more information, see Values for the restrict parameter
Returns 200 - Ok
401 - Not authorized
404 - Not found
500 - Server exception

Examples

The following URL was sent:

https://<host>:<port>/csa/rest/user/mysubscription?userIdentifier=90d9652b67ss6a930135f35b327e00a0 &requestor=RnDUser

The following XML was returned:


<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ServiceSubscriptionList>
    <count>6</count>
    <limit>0</limit>
    <ServiceSubscription>
        <id>90d957ea3806fa7e013807acc79000b3</id>
        <iconUrl>
            /csa/images/library/serviceOfferingDefault58.png
        </iconUrl>
        <name>MY SR</name>
        <displayName>MY SR</displayName>
        <state>...</state>
        <artifactType>
            <name>SUBSCRIPTION</name>
            ...
        </artifactType>
        <disabled>false</disabled>
        <serviceOffering>...</serviceOffering>
        <subscriptionStatus>...</subscriptionStatus>
        <initiatingServiceRequest>...</initiatingServiceRequest>
        ...
    </ServiceSubscription>
     ...
</ServiceSubscriptionList>

Send Help Center feedback