Go to documentation repository
General request format:
POST http://IP-address:port/createarchivetask
Content Type: application/json
Content:
{
"CameraId": "{CameraId}",
"From": "{From}",
"To": "{To}",
"Format":"format"
}
Request parameters:
Parameter | Required | Description |
|---|---|---|
| CameraId | Yes | Camera ID |
| From | Yes | The start time of the archive fragment in the UTC format: YYYY-MM-DDTHH:MM:SS |
| To | No | The end time of the archive fragment in the UTC format: YYYY-MM-DDTHH:MM:SS (if not specified, the entire archive will be given to the last record) |
| Format | No | The format to which the archive will be exported. Format options: mp4, avi, flv, mov, asf. If the format is not specified in the request body, then the value of the ExportContainerFormat registry key is used (see Registry keys reference guide). If the key is not specified, then the archive is exported in mp4 format |
Request example:
POST http://127.0.0.1:80/createarchivetask
Content Type: application/json
Content:
{
"CameraId": "1",
"From": "2022-06-27T15:10:00.00Z",
"To": "2022-06-27T15:20:00.00Z"
}
Response example:
The response will contain the export request identifier (in the example below, it is 084b56a5-bd49-4327-82db-9bc911f7ff96), which must be used in the request to get the export status and download the file. Also, a folder with a temporary file will be created in the path C:\Users\User\Documents, and the name of this folder will contain the export task identifier.
{
"CameraId" : "1",
"From" : "2016-06-27T15:10:00.00Z",
"To" : "2016-06-27T15:20:00.00Z",
"ArchiveTaskId" : "084b56a5-bd49-4327-82db-9bc911f7ff96",
"ErrorMessage" : null,
"State" : "Created"
}
Response example:
Parameter | Description |
|---|---|
| CameraId | Camera ID |
| From | The start time of the archive fragment in the UTC format: YYYY-MM-DDTHH:MM:SS |
| To | The end time of the archive fragment in the UTC format: YYYY-MM-DDTHH:MM:SS |
| ArchiveTaskId | Task ID |
| ErrorMessage | Error messages |
| State | Task creation result |
Overview
Content Tools