Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Import Event Profiles from a File

 

Use this API to import event profiles to a device from an XML file.

The XML file must be sent as part of the import event profile request. Currently, this API can import event profiles from only one file. However, the input file can contain any number of event profiles in it. Once the request is validated, a job is scheduled and the job-id is returned to the consumer for tracking the job. A queue has to be created before invoking this API.

URI

https://[host]/api/juniper/servicenow/event-profile-management/eventProfiles/import? queue= https://[host]/api/hornet-q/queues/queue-name (HTTP method = POST)

URI Parameters

Parameter

Type

Required

Description

queue-name

string

Yes

Name of the queue for import event profiles job

Consumes

Multipart form data. The XML file containing the event profiles must be sent as a part of the request.

Request Elements

Element

Type

Description

profileName

String

Name of the event profile

description

String

Description of the event profile

scriptsEnabledCount

Integer

Number of scripts enabled in the event profile

scriptsDisabledCount

Integer

Number of scripts disabled in the event profile

createdBy

String

Entity that created the event profile.

The value is always set to Service Now.

bundle

String

Specifies details such as name and version of the script bundle to which the event profile belongs

event

String

Specifies details such as description, category, KB article, and AI-Scripts bundle ID associated with the event profile

Produces

Import event profile job ID to track the import event profile job.

Response Elements

Element

Type

Description

href

String

Link to the import event profiles job.

id

Integer

ID of the import event profiles job.

Sample Input

Sample XML Input

Sample XML Output