getToDolist
This command returns the list of currently processing assets with their status and possibly progress, using the Result sub-elements ToDolistItem
and ReEncryptToDolistItem
. Only assets whose name matches the regular expression are returned. An empty regular expression returns the complete list.
Input Parameters
Fields | Values | Description |
---|---|---|
#PCDATA | Reg Ex | Regular Expression |
Output Result
Fields | Values | Description |
---|---|---|
Command | getToDolist | Echo of the command element name |
Code | 0 -1 1 | 0 = success -1 = DTD Violation 1 = Processing Error |
AssetName | Name of an asset in the todolist | The name of the asset |
Status | NEW/EXIST | Status of the asset |
Progress | 0% to 100% or absent | The scrambling progress |
Processing Errors
- A regular expression error as reported by regcomp.
Examples
Request
<getToDolist/>
Response On Success
<Result Command="getToDolist" Code="0">
<ToDolistitem AssetName="...." STATUS="SCRAMBLING" Progress="25%" />
<ReEncryptToDolistitem AssetName="...." STATUS="SCRAMBLING" Progress="25%" />
</Result>
Response On Failure
<Result Command="getToDoList" Code="0"> <Description>Directory '/assets': no such file or directory</Description> </Result>