Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

typeValue must be: ProjectMandatory, string
pidThe project id. See projects/list to enumerate or find projects.Mandatory, int

Filter task type and languages
tskThe task code such as "TR", "RV" etc. Only such jobs are considered.Mandatory, string
srcOptional source language. Filters jobs with this source language. If not specified, the system will sample jobs (and their suppliers) in any source language.Optional, string
trgs

Optional list of target languages. Filters jobs with this target language. If not specified, the system will sample jobs (and their suppliers) in any source project target language.

Note: If you specify trgs you must also specify src.

Optional, string[]?
jobsdoneOptional boolean. Default is true. If true, sampling considers completed supplier jobs only. Optional, bool?

Filter suppliers

suppliers

Optional array of suppliers to sample. To restrict sampling to these suppliers only. Each array element is:

  • cid: The supplier company id. See companies/list to enumerate companies.
  • pid: The supplier person id (internal suppliers only)


Optional, object[]?



size

The expected sample size. Default is 10.

This must be a value between 1 and 50.

Optional, int?
layout

Optionally specify the segments' fields to include in the results. This is done using a layout JSON object.

If not specified, the system will include:

  • Segment level properties such as all IDs, custom fields and labels
  • Source language text, flags, custom fields and labels
  • Source text related comments
  • Target language text, flags, custom fields and labels
  • Target text related comments
  • Target text revisions.
Optional, object?
persist

Optional boolean. Default is false.

Only set to true if required. If true, then the results are temporarily saved and assigned a token (see sampletoken in results).
You need this token when using the QA workflow API methods in order to create a workflow/jobs for the sample.


Optional, bool?
includeresults

Optional boolean. Default is true. If true then the returned JSON includes the result node. Otherwise only the summary statistics are returned.

If you further process results using the sampletoken you may not need the results with this call.

Optional, bool?

...