Process and Enriched Event Searches - new recommended calls for job status

Posted on January 16, 2023

---

When checking the status of the following calls, the Job ID endpoint is no longer supported. Instead, use the query ?start=0&rows=0 with the appropriate results request and the jobs status is available in the result by comparing contacted to completed.

The job will be complete when contacted == completed in the response. However during high usage a searcher may fail leaving a difference of 1. To prevent an infinite loop, ensure you add a timeout of 3 minutes as a job’s maximum active time is limited to 3 minutes.

Affected calls are:

• Get the Status of a Process Search
  • Use:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/processes/search_jobs/{job_id}/results?start=0&rows=0
    

  • Instead of:

    GET {cbc-hostname}/api/investigate/v1/orgs/{org_key}/processes/search_jobs/{job_id}
    

• Get the Status of a Process Detail Search
  • Use:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/processes/detail_jobs/{job_id}/results?start=0&rows=0
    

  • Instead of:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/processes/detail_jobs/{job_id}
    

• Get the Status of Process Summary Search
  • Use:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/processes/summary_jobs/{job_id}/results?start=0&rows=0
    

  • Instead of:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/processes/summary_jobs/{job_id}
    

• Get the Enriched Events Search Status
  • Use:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/enriched_events/search_jobs/{job_id}/results?start=0&rows=0
    

  • Instead of:

    GET {cbc-hostname}/api/investigate/v1/orgs/{org_key}/enriched_events/search_jobs/{job_id}
    

• Get the Enriched Events Detail Search Status
  • Use:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/enriched_events/detail_jobs/{job_id}/results?start=0&rows=0
    

  • Instead of:

    GET {cbc-hostname}/api/investigate/v2/orgs/{org_key}/enriched_events/detail_jobs/{job_id}
    

If there are any concerns about this change, please reach out to us.