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 Incident to Users

    Use this API to flag an incident to users.

    URI

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

    URI Parameters

    Parameter

    Type

    Required

    Description

    id

    Integer

    Yes

    ID of the incident to be flagged

    Consumes

    • application/vnd.juniper.servicenow.incident-management.incident.flagToUsers +xml;version=1;charset=UTF-8
    • application/vnd.juniper.servicenow.incident-management.incident.flagToUsers +json;version=1;charset=UTF-8

    Request Elements

    Element

    Type

    Description

    users

    users

    Collection of users to whom the incident must be flagged

    user

    user

    A user to whom the incident must be flagged

    id

    Integer

    Id of the user

    isEmailMessageToFlaggedUsers

    Boolean

    Flag to specify if the incident is to be flagged to users

    Possible values:

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

    Produces

    • application/vnd.juniper.servicenow.incident-management.servicenowmsg +xml;version=1
    • application/vnd.juniper.servicenow.incident-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>Incident flagged successfully</msg>
    </ serviceNowMsg>
    
    

    Sample JSON Output

    {
      "serviceNowMsg": { "msg": "Incidentflagged successfully" }
    }
    

    Modified: 2016-08-11