Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Flag a Targeted PBN to Users

    Use this API to flag targeted PBNs to users.

    URI

    https://[host]/api/juniper/serviceinsight/pbn-management/targeted-pbns/{id}/flagToUsers (HTTP method = PUT)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of targeted PBN to be flagged to users

    Consumes

    • application/vnd.juniper.serviceinsight.pbn-management.flagToUsers+xml;version=1
    • application/vnd.juniper.serviceinsight.pbn-management.flagToUsers+json;version=1

    Request Elements

    Element

    Type

    Description

    users

    user

    Collection of users to whom the targeted PBN is to be flagged

    user

    user

    A user

    id

    Integer

    ID of the user

    emailPBNToAssignedOwner

    Boolean

    Flag to specify if the targeted PBN is to be e-mailed to owner assigned for the PBN

    Possible values:

    • true—Targeted PBN is e-mailed to assigned owner
    • false—Targeted PBN is not e-mailed to assigned owner

    Produces

    • application/vnd.juniper.space.task-management.task+xml;version=1;
    • application/vnd.juniper.space.task-management.task+json;version=1;

    Response Elements

    Element

    Type

    Description

    msg

    String

    Message indicating that the targeted PBN is successfully flagged to users

    Sample Input

    Sample XML Input

    <flagToUsers>
    	<users>
    		<user>
    			<id>12345</id>
    		</user>
    	</users>
    	<emailPBNToAssignedOwner>true</emailPBNToAssignedOwner>
    </flagToUsers>
    

    Sample JSON Input

    {
      "flagToUsers": {
        "users": {
          "user": { "id": "12345" }
        },
        "emailPBNToAssignedOwner": "true"
      }
    }
    

    Sample Output

    Sample XML Output

    <serviceinsightmsg>
    <msg>Targeted PBN flagged to users successfull</msg>
    </serviceinsightmsg>
    
    
    

    Sample JSON Output

    {
      "serviceinsightmsg": {
        "msg": "Targeted PBN flagged to users successfull"
      }
    }

    Modified: 2016-08-11