| Property | Description | Returns |
|---|---|---|
| interrupted | Check whether the batch execution should be interrupted | bool |
| folderPath | Get the folder to use when working with files (in the files module) for this batch | string |
| stopped | Check whether the execution has been stopped | bool |
| hateoasLinks | Get the HATEOAS links for the record | array |
| id | int | |
| status | string | |
| customData | array | |
| batchEvent | BatchEvent | |
| created | DateTime | |
| modified | DateTime | |
| site | Site | |
| hook | Hook | |
| batchActions | Collection |
Hooks\Models\Api\Batch
Batch Entity