> 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-log-lookup.md).

# Batch Log Lookup

## Process Batch Status Change

> \## Function Description\
> \* Changes the status of an in-progress batch to failed.\
> \---\
> \## Detailed Description\
> \* Sets the status of an in-progress batch to FAILED, making it eligible for re-execution.\
> \* Changes the batch log message to 'Status changed by administrator'.<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":{"StBatchLogRequest":{"type":"object","description":"Batch Result Modification Request DTO","properties":{"jobExecutionId":{"type":"integer","format":"int64","description":"JOB Execution ID"}}},"ResponseString":{"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":"string","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/batchLog/modifyBatchLogStatus":{"post":{"tags":["Batch Log Lookup"],"summary":"Process Batch Status Change","description":"## Function Description\n* Changes the status of an in-progress batch to failed.\n---\n## Detailed Description\n* Sets the status of an in-progress batch to FAILED, making it eligible for re-execution.\n* Changes the batch log message to 'Status changed by administrator'.\n","operationId":"modifyBatchLogStatus","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StBatchLogRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Batch Log List

> \## Function Description\
> \* Retrieves the batch log list matching the reference date, batch program, and batch result.\
> \---\
> \## Detailed Description\
> \* Retrieves the batch log list matching the reference date, batch program, and batch result.\
> \---\
> \## Revision History\
> \* Release v2.00\_240530: Changed date query\
> \---\
> \## Notes\
> \* Batch result codes: COMPLETED, FAILED, STARTED<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":{"StBatchLogRequest":{"type":"object","description":"Batch Result Modification Request DTO","properties":{"jobExecutionId":{"type":"integer","format":"int64","description":"JOB Execution ID"}}},"RealGridListResponseStBatchLogResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/StBatchLogResponse"}}}},"StBatchLogResponse":{"type":"object","description":"Batch Log Retrieval Response DTO","properties":{"batchLogSeq":{"type":"string","description":"Batch Log Sequence No."},"batchNo":{"type":"string","description":"Batch No."},"stdDt":{"type":"string","description":"Reference Date"},"batchPgmNm":{"type":"string","description":"Batch Program Name"},"batchRsltCd":{"type":"string","description":"Batch Result Code"},"batchLogCont":{"type":"string","description":"Batch Log"},"batchStrDtm":{"type":"string","format":"date-time","description":"Batch Start Date/Time"},"batchEndDtm":{"type":"string","format":"date-time","description":"Batch End Date/Time"},"jobExecutionId":{"type":"integer","format":"int64","description":"JOB Execution ID"},"batchStatusUpdate":{"type":"string","description":"Batch Result Change 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"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/batchLog/getBatchLogList":{"get":{"tags":["Batch Log Lookup"],"summary":"Retrieve Batch Log List","description":"## Function Description\n* Retrieves the batch log list matching the reference date, batch program, and batch result.\n---\n## Detailed Description\n* Retrieves the batch log list matching the reference date, batch program, and batch result.\n---\n## Revision History\n* Release v2.00_240530: Changed date query\n---\n## Notes\n* Batch result codes: COMPLETED, FAILED, STARTED\n","operationId":"getBatchList","parameters":[{"name":"stBatchLogRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/StBatchLogRequest"}},{"name":"stdDt","in":"query","description":"Reference Date","schema":{"type":"LocalDate"}},{"name":"batchPgmNm","in":"query","description":"Batch Program Name","schema":{"type":"string"}},{"name":"batchRsltCd","in":"query","description":"Batch Result","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/RealGridListResponseStBatchLogResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```