MIJobs resource
Use the MIJobs resource to get a list of the available streaming ingestion jobs.
GET request
To request a list of the available streaming ingestion jobs, use the following URL:
<server URI>/mijobmonitor/api/v1/MIJobs
You can include the following query parameters in the URI:
Parameter | Type | Required | Description |
---|
$count | Boolean | No | Displays the number of ingestion jobs in the database. |
$filter | String | No | Filters the job based on the input. You can filter using one of the following fields: - - assetName
- - assetType
- - startedBy
- - status
You can filter jobs using single or multiple fields. |
$orderby | String | No | Sorts the order of the jobs. You can sort the jobs using the following fields: - - assetName
- - assetType
- - status
- - runtimeEnv
- - startTime
You can sort jobs using single or multiple fields. |
$skip | Integer | No | Skips the number of streaming ingestion jobs that you specify. For example, you might want to skip the first five streaming ingestion jobs. Consider the $filter and $orderby parameter values, if specified. |
$top | Integer | No | Displays the number of top streaming ingestion jobs that you specify. For example, you might want to view the top ten streaming ingestion jobs. Consider the $filter and $orderby parameter values, if specified. |
GET request example
To get a list of the available streaming ingestion jobs, you might send a request similar to the following example:
POST https://usw1-ing.dm2-us.informaticacloud.com/mijobmonitor/api/v1/MIJobs?$count=true&$filter=(startedBy eq 'siqa_new')&$orderby=deployTime desc&$skip=0&$top=25
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT
GET response
Returns the MIjobs object if successful or an error object if an error occurs.
If successful, the response includes the following information about the streaming ingestion job:
Parameter | Type | Description |
---|
assetName | String | Name of the streaming ingestion job. |
runId | Integer | Run ID of the streaming ingestion job. The ID changes for every deployment. |
orgId | String | ID of the organization the logged in user belongs to. |
runtimeEnv | String | ID of the Secure Agent that deployed the streaming ingestion job. |
startTime | Integer | Date and start time of deploying the job, in UTC time. |
endTime | Integer | Date and end time of deploying the job, in UTC time. |
deployTime | Integer | Date and time of deploying the job, in UTC time. |
undeployTime | Integer | Date and time of undeploying the job, in UTC time. |
startedBy | Integer | Name of the user who created the streaming ingestion task. |
status | String | The status of the streaming ingestion job. A job can be in one of the following status: - - Deploying. The job is being deployed.
- - Up and Running. The job is running.
- - Running with Warning. The job is running with warnings.
- - Running with Error. The job is running with error.
- - Undeployed. The job is undeployed.
- - Stopped. The job was intentionally stopped.
|
extraData | String | Additional information including the task ID, the location of the streaming ingestion job, and the Secure Agent ID. |
GET response example
If the request to get a list of available streaming ingestion jobs is successful, you might receive a response similar to the following example:
{
"@odata.context": "$metadata#Collection(OData.MI.JobMonitor.MIJob)",
"@odata.count": 421,
"value": [
{
"assetId": "7ce6bbc7-f0e2-4278-bd6d-d1187f4a1420",
"assetName": "SIdeployJms",
"assetType": "SI_DATAFLOW",
"runId": 33015,
"duration": 300000,
"orgId": "1Pm6cSfPcAqfgeV57Fn3u4",
"runtimeEnv": "011U5M08000000000003",
"startTime": "2021-04-29T13:09:48.000+0000",
"endTime": "2021-04-29T13:14:48.000+0000",
"deployTime": "2021-04-29T13:09:48.000+0000",
"undeployTime": "2021-04-29T13:14:48.000+0000",
"startedBy": "siqa_new",
"status": "Undeployed",
"outOfSync": true,
"extraData": "{\"taskId\":\"7Z4ZZjXc9QViT4t2okiHuz\",\"runtimeEnv\":\"011U5M25000000000002\",\"location\":\"RestAutomation\"}",
"deployedVersion": 1,
"replace": null,
"lastUpdateTime": 0
},
{
"assetId": "a03b9aa1-4a4a-47ee-808d-ddc0ee7b3a4a",
"assetName": "kafka to kafka test",
"assetType": "SI_DATAFLOW",
"runId": 33527,
"duration": 204988000,
"orgId": "1Pm6cSfPcAqfgeV57Fn3u4",
"runtimeEnv": "011U5M08000000000002",
"startTime": "2021-05-04T05:41:39.000+0000",
"endTime": "2021-05-06T14:38:07.000+0000",
"deployTime": "2021-05-04T05:41:39.000+0000",
"undeployTime": "2021-05-06T14:38:07.000+0000",
"startedBy": "siqa_new",
"status": "Undeployed",
"outOfSync": true,
"extraData": "{\"taskId\":\"8V21nib7Sqgiw3QoDRi5uK\",\"runtimeEnv\":\"011U5M25000000000002\",\"location\":\"Default\"}",
"deployedVersion": 1,
"replace": null,
"lastUpdateTime": 0
}
]
}