validate folder
/members/{member}/groups/{group}/uris/{uri}/foldervalidate [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 4.9500 | 5.9900 | xml |
Description
Performs a validation on all documents in a folder.
Invoking this service starts an Asynchronous process.
Archived documents will not be validated.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| schema | The name of the schematron to use for validation (e.g. myschema.sch) | yes | string | |
| documenttype | The document type of PSML documents to validate | no | string | |
| extension | The file extension of documents to validate | no | string | |
| failuresonly | Whether to only include results with failed assertions | no | boolean | false |
| include-descendants | Whether to also validate documents in descendant folders | no | boolean | false |
| shared | Whether report should be visible to all group members (manager only) | no | boolean | false |
Permission
This service requires contributor or higher.
Response
This service returns the following XML:
<folder-validation> <thread ...> ... </thread> </folder-validation>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1205 | The URI selected is not a folder |
| 0x1207 | No URIs to validate |