Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Get Import Event Profiles Job Details

 

Use this API to retrieve the details of an import event profiles job. The details about tasks involved within the import event profiles job can be obtained from detail-link output by this API.

URI

http://{host-ip}/api/space/job-management/jobs/{job-id} (HTTP method = GET)

URI Parameters

Parameter

Type

Required

Description

job-id

Integer

Yes

ID of the import event profiles job to be retrieved

Consumes

None

Produces

None

Response Element

Element

Type

Description

uri

String

Link to the import event profiles job details

id

Integer

ID of the import event profiles job

name

String

Name of the job

job-type

String

Type of the job

The value is always Import event profile.

detail-link

String

Link to obtain details of the tasks involved in the import event profiles job

job-state

String

Current state of the job

The values are:

  • Scheduled—The import event profiles job has been scheduled.

  • Inprogress—The import event profiles job is in progress.

  • Done—The import event profiles job is completed.

job-status

String

Current status of the import event profiles job

The values are:

  • Success—Event profiles were successfully imported to Service Now.

  • Failed—Importing event profiles to Service Now failed.

percent-complete

Integer

Percentage of the import event profiles job completed

scheduled-start-time

Date

Date and time the import event profiles job was scheduled to start

start-time

Date

Date and time the import event profiles job actually started

end-time

Date

Date and time the import event profiles job actually ended

owner

String

User executing the import event profiles job

summary

String

Summary of the import event profiles job

Includes information about number of profiles imported successfully and the number of profiles that failed to import

supports-recurrence

Boolean

Flat to specify whether or not the import event profiles job should reoccur

  • true—The import event profile job reoccurs

  • false—The import event profile job does not reoccur

schedule-string

String

String representation of the job schedule

domain-name

String

Domain to which the event profiles are imported

domain-id

Integer

ID of the domain to which the event profiles are imported

domain-href

String

URL of the domain to which the event profiles are imported

Sample Output

Sample XML Output

Sample JSON Output