Get Information Message Details
Use this API to retrieve details about a specific information message.
URI
https://[host]/api/juniper/servicenow/information-management/informationMessage/{id} (HTTP method = GET)
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | String | Yes | ID of the message whose details are to be retrieved |
Consumes
None
Produces
- application/vnd.juniper.servicenow.information-management.informationMessage +xml;version=1
- application/vnd.juniper.servicenow.information-management.informationMessage +json;version=1
Response Elements
Element | Type | Description |
---|---|---|
uri | String | URI of the information message |
id | String | ID of the message |
siteID | Integer | Site ID in Juniper CRM associated with the message |
organizationName | Integer | Name of the organization that received the message |
title | String | Title of the message |
issueDate | String | Date the message was issued |
summary | String | Summary of the message |
keywords | String | Keywords present in the message |
instructions | String | Instructions included in the message |
relevances | String | Platforms and devices that could be impacted by the problem described in the message |
flaggedUsers | String | Users to whom the message is flagged |
owner | String | User to whom the message is assigned for ownership |
informId | String | ID of the message |
assignedEndCustomer | String | End customers to whom the message is assigned |
unAssignedEndCustomer | String | End customers to whom the message is not assigned |
method | String | Method relevant to the message |
Sample Output
Sample XML Output
<informationMessageuri="/api/juniper/servicenow/information-management/ informationMessage/1"> <id>1</id> <siteID>1</siteID> <organizationName/> <title>Sample</title> <issueDate>2014-12-30 16:10:08 PST</issueDate> <summary>Sample Summary</summary> <keywords>Key1, Key2, Key3</keywords> <instructions>Sample Instructions</instructions> <relevances>Sample Relevances</relevances> <flaggedUsers>super, juniper</flaggedUsers> <owner>super</owner> <assignedEndCustomer>Member</assignedEndCustomer> <method href= "/api/juniper/servicenow/information-management/informationMessage/1 /assignToMembers" /> <method href= "/api/juniper/servicenow/information-management/informationMessage/1 /flagToUsers" /> <method href= "/api/juniper/servicenow/information-management/informationMessage/1 /assignOwnership" /> </informationMessage>
Sample JSON Output
{ "informationMessage": { "@uri": "/api/juniper/servicenow/information-management/informationMessages/2", "id": 2, "siteID": 1, "organizationName": "", "title": "Info", "issueDate": "2015-03-24 11:15:30 IST", "summary": "Summary", "keywords": "Keywords", "instructions": "Instruction", "relevances": "Relevances", "flaggedUsers": "super", "owner": "super", "method": [ { "@href": "/api/juniper/servicenow/information-management/informationMessages/2/assignMessage ToConnectedMembers" }, { "@href": "/api/juniper/servicenow/information-management/informationMessages/2/flagToUsers" }, { "@href": "/api/juniper/servicenow/information-management/informationMessages/2/assignOwnership" }, { "@href": "/api/juniper/servicenow/information-management/informationMessages/2" } ] } }