Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Information About an Event Profile

 

Use this API to retrieve information about an event profile.

URI

https://[host]/api/juniper/servicenow/event-profile-management/eventProfiles/{id} (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

id

Integer

Yes

ID of the event profile for which information is to be retrieved

Consumes

None

Produces

  • application/vnd.juniper.servicenow.event-profile-management.eventprofile+xml;version=3

  • application/vnd.juniper.servicenow.event-profile-management.eventprofile+json;version=3

Response

Element

Type

Description

uri

String

URI of the event profile

id

Integer

Unique ID of this event profile

profileName

String

Event profile name

scriptBundleName

String

Name of the script bundle from which this profile is created

scriptBundleVersion

String

Version number of the script bundle

method

String

Method applicable to the event profile

installed-device

installed-device

Collection of devices on which the event profile is installed

device

device

A device on whieh the event profile is installed

id

Integer

ID of the device

profileId

Integer

Unique ID of this event profile (same as the id element)

hostName

String

Hostname of the device on which this profile is installed

events

event

Collection of events in the event profile

uri

String

URI of the events in the event profile

size

Integer

Number of events in this profile

event

event

An event in the event profile

name

String

Name of each event in this profile

category

String

Category of each event in this profile

type

String

Event type of each event in this profile

subType

String

Subtype of each event in this profile

priority

String

Event priority

KBArticle

String

Link to KB article related for that event

briefDescription

String

Terse description of the event

eventDescription

String

Detailed description of the event

domainId

Integer

ID of the domain in which the event profile is created

Sample Output

Sample XML Output

Sample JSON Output

Response Status Code

Message

Description

404 Not Found

Invalid event profile ID specified.