JobExecutionSearch resource (Data API 19.1)

Summary

Http Method Resource Description
POST /job_execution_search Searches for job executions.

The query attribute specifies a complex query that can be used to narrow down the search. This is the list of searchable attributes:
  • id - String
  • job_id - String
  • start_time - Date
  • end_time - Date
  • status - String
This is the list of sortable attributes:
  • job_id - String
  • start_time - Date
  • end_time - Date
  • status - String

Search Job Executions

Searches for job executions.

The query attribute specifies a complex query that can be used to narrow down the search. This is the list of searchable attributes: This is the list of sortable attributes:

Url

POST https://hostname:port/dw/data/v19_1/job_execution_search

Formats

json, xml

Authentication

Name Description
OAuth Authentication via OAuth token.

Request Document

SearchRequest

Response Document

JobExecutionSearchResult

Sample

REQUEST:
POST /s/-/dw/data/v19_1/job_execution_search HTTP/1.1
Host: example.com
Authorization: Bearer a5b6eb0d-8312-41a3-88f3-2c53c4507367
Content-Type: application/json; charset=UTF-8
{ 
  "query" : 
  {
    "term_query": { "fields": ["job_id"], "operator": "is", "values": ["ImportProducts_stg", "VerifyPromotions_stg"] }
  },
  "sorts":[{"field":"start_time", "sort_order":"asc"}]
}

# in case of success:

RESPONSE:
HTTP/1.1 200 OK
Expires: Thu, 01-Jan-1970 00:00:00 GMT
{
  "_v" : "19.1",
  "_type" : "job_execution_search_result",
  "count" : 3,
  "hits" : [{
    "_type" : "job_execution",
    "domain_names" : [
      "Sites-Site",
      "Sites-SiteGenesis-Site"
    ],
    "duration" : 3000,
    "end_time" : "2015-12-16T09:49:11.905Z",
    "exit_status" : {
      "_type" : "status",
      "code" : "OK",
      "message" : "OK",
      "status" : "ok"
    },
    "id" : "cdYS39aaabttcaaadpCLYBAOMV",
    "is_restart" : true,
    "job_id" : "ImportProducts_stg",
    "log_file_name" : "[email protected]",
    "is_log_file_existing" : true,
    "modification_time" : "2015-12-16T09:49:11.617Z",
    "start_time" : "2015-12-16T09:49:08.905Z",
    "status" : "finished",
    "step_executions" : 
    ...
}

# in case of failure:
 
RESPONSE:
HTTP/1.1 400 Bad Request
Expires: Thu, 01-Jan-1970 00:00:00 GMT
Content-Type: application/json;charset=UTF-8
Cache-Control: max-age=0,no-cache,no-store,must-revalidate
{
   "_v" : "19.1",
   "fault" :
   {
      "arguments" :
      {
         "field" : "not_searchable"
      },
      "type" : "UnqueryableFieldException",
      "message" : "The field 'not_searchable' cannot be queried.
   }
}