> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/batch-management-lookup.md).

# Batch Management Lookup

## Retrieve Batch Management List

> \## Function Description\
> \* Retrieves the batch management list matching the batch name, batch type code, and execution type.\
> \---\
> \## Detailed Description\
> \* Retrieves the batch management list matching the batch name, batch type code, and execution type.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StMgrBatchBaseRequest":{"type":"object","properties":{"batchNo":{"type":"string"},"batchNm":{"type":"string"},"batchGbCd":{"type":"string"},"batchExeTypCd":{"type":"string"},"exeCycleYyVal":{"type":"string"},"exeCycleMmVal":{"type":"string"},"exeCycleWkVal":{"type":"string"},"exeCycleWdayVal":{"type":"string"},"exeCycleHhVal":{"type":"string"},"exeCycleMinVal":{"type":"string"},"exeCmdw":{"type":"string"},"mainAempId":{"type":"string"},"scndAempId":{"type":"string"},"batchStatCd":{"type":"string"}}},"ResponseListStMgrBatchBaseResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"array","description":"payload","items":{"$ref":"#/components/schemas/StMgrBatchBaseResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"StMgrBatchBaseResponse":{"type":"object","description":"Batch Management Retrieval Response DTO","properties":{"batchNo":{"type":"string","description":"Batch No."},"batchNm":{"type":"string","description":"Batch Name"},"batchGbCd":{"type":"string","description":"Batch Type Code (CM007)"},"batchExeTypCd":{"type":"string","description":"Batch Execution Type Code (CM011)"},"exeCycleYyVal":{"type":"string","description":"Execution Cycle Year Value"},"exeCycleMmVal":{"type":"string","description":"Execution Cycle Month Value"},"exeCycleWkVal":{"type":"string","description":"Execution Cycle Week Value"},"exeCycleWdayVal":{"type":"string","description":"Execution Cycle Day of Week Value"},"exeCycleHhVal":{"type":"string","description":"Execution Cycle Hour Value"},"exeCycleMinVal":{"type":"string","description":"Execution Cycle Minute Value"},"exeCmdw":{"type":"string","description":"Execution Command"},"batchStatCd":{"type":"string","description":"Batch Status Code (CM024)"},"mainAempNm":{"type":"string","description":"Primary Manager Name"},"scndAempNm":{"type":"string","description":"Secondary Manager Name"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/batchMgmt/getBatchList":{"get":{"tags":["Batch Management Lookup"],"summary":"Retrieve Batch Management List","description":"## Function Description\n* Retrieves the batch management list matching the batch name, batch type code, and execution type.\n---\n## Detailed Description\n* Retrieves the batch management list matching the batch name, batch type code, and execution type.\n","operationId":"getBatchList_1","parameters":[{"name":"stMgrBatchBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StMgrBatchBaseRequest"}},{"name":"batchNm","in":"query","description":"Batch Name","schema":{"type":"string"}},{"name":"batchGbCd","in":"query","description":"Batch Type Code (CM007)","schema":{"type":"string"}},{"name":"batchExeTypCd","in":"query","description":"Batch Execution Type Code (CM011)","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListStMgrBatchBaseResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Batch Management Count

> \## Function Description\
> \* Retrieves the batch management count matching the batch name, batch type code, and execution type.\
> \---\
> \## Detailed Description\
> \* Retrieves the batch management count matching the batch name, batch type code, and execution type.<br>

```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"StMgrBatchBaseRequest":{"type":"object","properties":{"batchNo":{"type":"string"},"batchNm":{"type":"string"},"batchGbCd":{"type":"string"},"batchExeTypCd":{"type":"string"},"exeCycleYyVal":{"type":"string"},"exeCycleMmVal":{"type":"string"},"exeCycleWkVal":{"type":"string"},"exeCycleWdayVal":{"type":"string"},"exeCycleHhVal":{"type":"string"},"exeCycleMinVal":{"type":"string"},"exeCmdw":{"type":"string"},"mainAempId":{"type":"string"},"scndAempId":{"type":"string"},"batchStatCd":{"type":"string"}}},"ResponseInteger":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"integer","format":"int32","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/system/batchMgmt/getBatchListCount":{"get":{"tags":["Batch Management Lookup"],"summary":"Retrieve Batch Management Count","description":"## Function Description\n* Retrieves the batch management count matching the batch name, batch type code, and execution type.\n---\n## Detailed Description\n* Retrieves the batch management count matching the batch name, batch type code, and execution type.\n","operationId":"getBatchListCount","parameters":[{"name":"stMgrBatchBaseRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StMgrBatchBaseRequest"}},{"name":"batchNm","in":"query","description":"Batch Name","schema":{"type":"string"}},{"name":"batchGbCd","in":"query","description":"Batch Type Code (CM007)","schema":{"type":"string"}},{"name":"batchExeTypCd","in":"query","description":"Batch Execution Type Code (CM011)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```