...
token | The token obtained on connection | Required |
projectid | The project to get documents for | Required |
from | The first record to show starting with index 0. Default is 0 | Optional |
count | The number of records to show, up to 100 at a time. Default is 100. | Optional |
reference | Only show documents with this reference. Document references are not unique. | Optional |
name | Only show documents with this path/name. This will select a single document as the name is unique. | Optional |
locale | Return documents in this language only. This can be the source or a target language. | Optional |
srctrg | Optional. Use these values if you want to apply a filter: - original : show the original documents only - translation: show the translated documents only | Optional |
taskstatus | Optional. Use with Codyt projects only: Permits to filter documents by their workflow status. The numeric values can be: /// <summary> /// If not Finished then: /// At least one task is in progress /// COLOR = BLUE /// </summary> InProgress = 0 /// <summary> /// Means that the workflow does not need to go further. /// All tasks are Completed or Cancelled. At least one is Completed. /// COLOR = GREEN/// </summary> Finished = 1 /// <summary>/// Workflow is not yet kicked off. /// - Some tasks are Not Started /// - Some tasks are On Hold /// COLOR = ORANGE /// </summary> Waiting = 2 /// <summary> /// Workflow is in on hold position and can't proceed. Or all tasks are cancelled. /// Condition: all must be true: /// - LocaleStatus != Finished /// - LocaleStatus != Waiting /// - LocaleStatus != Waiting /// COLOR = RED /// </summary> Blocked = 3 | Optional |
filter | Free filter on any project property. Please see Filtering results for details. | Optional |
RESULTS
...