Jump to

• Request
• Response

List Job Host Summaries for a Job

get

/api/v2/jobs/{id}/job_host_summaries/

Make a GET request to this resource to retrieve a list of job host summaries associated with the selected job.

The resulting data structure contains:

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

The count field indicates the total number of job host summaries 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 job host summary records.

Results

Each job host summary data structure includes the following fields:

• id: Database ID for this job host summary. (integer)
• type: Data type for this job host summary. (choice)
• url: URL for this job host summary. (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 job host summary was created. (datetime)
• modified: Timestamp when this job host summary was last modified. (datetime)
• job: (id)
• host: (id)
• constructed_host: Only for jobs run against constructed inventories, this links to the host inside the constructed inventory. (id)
• host_name: (string)
• changed: (integer)
• dark: (integer)
• failures: (integer)
• ok: (integer)
• processed: (integer)
• skipped: (integer)
• failed: (boolean)
• ignored: (integer)
• rescued: (integer)

Sorting

To specify that job host summaries 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

Supported Media Types

• application/json

Path Parameters

• id(required): string

Query Parameters

• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : schema

Type: object

Show Source

• count(required): integer
• next: string(uri)
• previous: string(uri)
• results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/JobHostSummary"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

Nested Schema : results

Type: array

Show Source

• Array of: object JobHostSummary

{
    "items":{
        "$ref":"#/definitions/JobHostSummary"
    },
    "type":"array"
}

Nested Schema : JobHostSummary

Type: object

Show Source

• changed: integer
  Title: Changed

  Read Only: true

  Minimum Value: 0
• constructed_host: integer
  Title: Constructed host

  Read Only: true

  Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.
• created: string
  Title: Created

  Read Only: true
• dark: integer
  Title: Dark

  Read Only: true

  Minimum Value: 0
• failed: boolean
  Title: Failed

  Read Only: true
• failures: integer
  Title: Failures

  Read Only: true

  Minimum Value: 0
• host: integer
  Title: Host

  Read Only: true
• host_name: string
  Title: Host name

  Read Only: true

  Minimum Length: 1
• id: integer
  Title: ID

  Read Only: true
• ignored: integer
  Title: Ignored

  Read Only: true

  Minimum Value: 0
• job: string
  Title: Job

  Read Only: true
• modified: string
  Title: Modified

  Read Only: true
• ok: integer
  Title: Ok

  Read Only: true

  Minimum Value: 0
• processed: integer
  Title: Processed

  Read Only: true

  Minimum Value: 0
• related: string
  Title: Related

  Read Only: true
• rescued: integer
  Title: Rescued

  Read Only: true

  Minimum Value: 0
• skipped: integer
  Title: Skipped

  Read Only: true

  Minimum Value: 0
• summary_fields: string
  Title: Summary fields

  Read Only: true
• type: string
  Title: Type

  Read Only: true
• url: string
  Title: Url

  Read Only: true

{
    "properties":{
        "changed":{
            "minimum":"0",
            "readOnly":true,
            "title":"Changed",
            "type":"integer"
        },
        "constructed_host":{
            "description":"Only for jobs run against constructed inventories, this links to the host inside the constructed inventory.",
            "readOnly":true,
            "title":"Constructed host",
            "type":"integer",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "dark":{
            "minimum":"0",
            "readOnly":true,
            "title":"Dark",
            "type":"integer"
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "failures":{
            "minimum":"0",
            "readOnly":true,
            "title":"Failures",
            "type":"integer"
        },
        "host":{
            "readOnly":true,
            "title":"Host",
            "type":"integer",
            "x-nullable":true
        },
        "host_name":{
            "minLength":"1",
            "readOnly":true,
            "title":"Host name",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "ignored":{
            "minimum":"0",
            "readOnly":true,
            "title":"Ignored",
            "type":"integer"
        },
        "job":{
            "readOnly":true,
            "title":"Job",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "ok":{
            "minimum":"0",
            "readOnly":true,
            "title":"Ok",
            "type":"integer"
        },
        "processed":{
            "minimum":"0",
            "readOnly":true,
            "title":"Processed",
            "type":"integer"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "rescued":{
            "minimum":"0",
            "readOnly":true,
            "title":"Rescued",
            "type":"integer"
        },
        "skipped":{
            "minimum":"0",
            "readOnly":true,
            "title":"Skipped",
            "type":"integer"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

Back to Top