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 an Information Message to Users

    Use this API to flag an information message to users.

    URI

    /api/juniper/servicenow/information-management/informationMessage/{id}/flagToUsers (HTTP method = PUT)

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the information message to be flagged to users

    Consumes

    • application/vnd.juniper.servicenow.information-management.informationMessage.flagTo Users+xml;version=1
    • application/vnd.juniper.servicenow.information-management.informationMessage.flagTo Users+json;version=1

    Request Elements

    Element

    Type

    Description

    users

    users

    Collection of users to whom the message is to be flagged

    user

    user

    A user to whom the message is to be flagged

    id

    Integer

    ID of the user to whom the message is to be flagged

    isEmailMessageToFlaggedUsers

    Boolean

    Flag to indicate if the message is flagged to users or not

    Possible values:

    • true—Message is flagged to users
    • false—Message is not flagged to users

    Produces

    • application/vnd.juniper.servicenow.information-management.servicenowmsg +xml;version=1
    • application/vnd.juniper.servicenow.information-management.servicenowmsg +json;version=1

    Response Elements

    Element

    Type

    Description

    msg

    String

    Status message of the flag to users job

    Sample Input

    Sample XML Input

    <flagToUsers>
    <users>
    <user>
    <id>845</id>
    </user>
    </users>
    <isEmailMessageToFlaggedUsers> false</isEmailMessageToFlaggedUsers>
    </flagToUsers>
    

    Sample JSON Input

    {
      "flagToUsers": {
        "users": {
          "user": { "id": "845" }
        },
        "isEmailMessageToFlaggedUsers": "true/false"
      }
    }
    

    Sample Output

    Sample XML Output

    <serviceNowMsg>
    	<msg>Message flagged successfully </msg>
    </ serviceNowMsg>
    

    Sample JSON Output

    {
      "serviceNowMsg": { "msg": "Message flagged successfully " }
    }
    

    Modified: 2016-08-11