Versions Compared

Key

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

Creates a new random sample for jobs of a specific supplier. Use cases:

...

(POST) /resources/segments/randomsamplesampling/new

PARAMETERS

The parameters are a JSON object included in the request body:

...

segmentsTotal segments in sample. Note that this number will be less than the expected sample count if there is no or not enough data or the filter is too restrictive.int
wordsTotal source text words in sample.int
tskThe task code such as "TR", "RV" etc. of the sample.string
srcThe source language of the samplestring
trgThe target language of the samplestring
cidThe supplier company idint
uidThe internal supplier person id. Null with external suppliers.int?
dtfrom, dtto

The date range of the sampled jobs. We recommend that you format dates with a timezone indication or "Z" for UTC. For example:

  • 2018-06-12T18:45:15.0000000-05:00
  • 2009-04-14T16:19:58.0785000Z

You can however also provide simpler dates such as "2018-10-10".

datetime?



result

Contains all the segments in the sample, information on the resources to which the segments belong as well as worker names.

object[]
result.rows

The list of segments.

Includes main segment properties as well as the data columns specified in the layout parameter.

The format is explained further down in this page.

object[]
result.docs

A dictionary with all documents that appear in the results.

This permits to show document names and more information per segment (see the did property of a segment).

The format is explained further down in this page.

object
result.users

A dictionary with all users/persons that are referenced by the segments included with the results.

A segment references the persons that have last changed a text, a status, a bookmark etc.

The format is explained further down in this page.

object
columnsAn array with the columns in the result.rows property. Each array element describes one column, see here: Spreadsheet Column (Object)object[]

...