List System Job Events for a System Job
/api/v2/system_jobs/{id}/events/
Make a GET request to this resource to retrieve a list of system job events associated with the selected system job.
The resulting data structure contains:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
The count
field indicates the total number of system job events
found for the given query. The next
and previous
fields provides links to
additional results if there are more than will fit on a single page. The
results
list contains zero or more system job event records.
Results
Each system job event data structure includes the following fields:
id
: Database ID for this system job event. (integer)type
: Data type for this system job event. (choice)url
: URL for this system job event. (string)related
: Data structure with URLs of related resources. (object)summary_fields
: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)created
: Timestamp when this system job event was created. (datetime)modified
: Timestamp when this system job event was last modified. (datetime)event
: (field)counter
: (integer)event_display
: (string)event_data
: (json)failed
: (field)changed
: (field)uuid
: (string)stdout
: (string)start_line
: (integer)end_line
: (integer)verbosity
: (integer)system_job
: (id)
Sorting
To specify that system job events are returned in a particular
order, use the order_by
query string parameter on the GET request.
?order_by=name
Prefix the field name with a dash -
to sort in reverse:
?order_by=-name
Multiple sorting fields may be specified by separating the field names with a
comma ,
:
?order_by=name,some_other_field
Pagination
Use the page_size
query string parameter to change the number of results
returned for each request. Use the page
query string parameter to retrieve
a particular page of results.
?page_size=100&page=2
The previous
and next
links returned with the results will set these query
string parameters automatically.
Searching
Use the search
query string parameter to perform a case-insensitive search
within all designated text fields of a model.
?search=findme
(Added in Ansible Tower 3.1.0) Search across related fields:
?related__search=findme
Request
- application/json
-
page: integer
A page number within the paginated result set.
-
page_size: integer
Number of results to return per page.
-
search: string
A search term.
Response
- application/json
200 Response
object
-
changed:
string
Title:
Changed
Read Only:true
-
counter:
integer
Title:
Counter
Read Only:true
Minimum Value:0
-
created:
string
Title:
Created
Read Only:true
-
end_line:
integer
Title:
End line
Read Only:true
Minimum Value:0
-
event:
string
Title:
Event
Read Only:true
-
event_data:
object Event data
Title:
Event data
-
event_display:
string
Title:
Event display
Read Only:true
Minimum Length:1
-
failed:
string
Title:
Failed
Read Only:true
-
id:
integer
Title:
ID
Read Only:true
-
modified:
string
Title:
Modified
Read Only:true
- related: string
-
start_line:
integer
Title:
Start line
Read Only:true
Minimum Value:0
-
stdout:
string
Title:
Stdout
Read Only:true
Minimum Length:1
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
system_job:
string
Title:
System job
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
uuid:
string
Title:
Uuid
Read Only:true
Minimum Length:1
-
verbosity:
integer
Title:
Verbosity
Read Only:true
Minimum Value:0
object
Event data