BulkCreateJobsRequest

Returns bulk job creation requests

This call will return a list bulk job creation requests for the specified business unit id, batch id(s) or created between a date range.

Securitybearer
Request
Request Body schema:

The filter request.

businessUnitId
string <uuid>

The business unit Id.

batchRequestIds
Array of strings or null <uuid>

List of batch ids.

startDate
string or null <date-time>

Start from date

endDate
string or null <date-time>

End date

analyzeFromSingleJobData
boolean

Analyzed From Single Job Data

Responses
post/api/v1/bulkCreateJobsRequest/search
Request samples
{
  • "businessUnitId": "885fcc1b-a726-4545-8a6d-e7e149102e22",
  • "batchRequestIds": [
    ],
  • "startDate": "2019-01-01T00:00:00",
  • "endDate": "2019-01-01T00:00:00",
  • "analyzeFromSingleJobData": true
}
Response samples
application/json
[
  • {
    }
]

Returns single job creation requests.

This endpoint will return information about individual jobs that were part of a bulk create request.

Securitybearer
Request
Request Body schema:

The criteria used to search for the job creation information. If both bulk request IDs and single request IDs are provided, all the single IDs must be part of one of the bulk requests provided.

bulkRequestIds
Array of strings or null <uuid>

The id of the batch job creation request.

singleRequestIds
Array of strings or null <uuid>

The id of the batch job creation request.

Responses
200

Success

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

404

The specified resource is not found.

post/api/v1/singleCreateJobsRequest/search
Request samples
{
  • "bulkRequestIds": [
    ],
  • "singleRequestIds": [
    ]
}
Response samples
application/json
[
  • {
    }
]