resources/segments/finder/properties

scope

The scope object. It delimits the total range of segments and related resources that can be operated on.

resources

An array of resource. The searchable translation memories, project memories and term bases linked to the scope.

If your scope is for a project or job, then this is the list of resources attached to the project by the project manager.

If the scope is a memory, then this will contain the memory only.

token

A newly created finder token. You can use this for subsequent searches if you did not yet obtain a token earlier in a session.

dsid

The document set id.

ctype

Content type of resource: 0 = Documents, 1 = Translation memory, 2 = Terminology database

name

Name of resource.

workedon

Boolean. True if the scope is part of the resource. For example if you are editing a document of a project, the list of resources will contain the corresponding project memory with workedon equals true.

rating

A user given rating for the resource. Value between 0 (no rating), 1 (lowest)... 5 (highest)

scopeDocumentSet

A scope to access the resource in a view. Null if you have no access right to viewing the complete resource.

scopeProject

If the ctype is Documents then it is a document of a project. This is the scope to view the segments in the scope of a project.

A scope  to access the project in a view. Null if you have no access right to viewing the complete resource.

segments

Total number of segments.

canEdit

Null/True/False. Tells if you have the right to edit segments of the resource. Null if you need to first create a scope to see if you have this right or not.

canAdd

Null/True/False. Tells if you have the right to add new segments to the resource. Null if you need to first create a scope to see if you have this right or not.

canDelete

Null/True/False. Tells if you have the right to remove segments from the resource. Null if you need to first create a scope to see if you have this right or not.

localesSource

The source locales of the resource that you can search. Depending on your access rights you may not have access to all locales.

locales

The list of all locales of the resource to which you have access.

lbls

Array of all labels of the resource (and which you are allowed to view). The array may be empty. Each array element is an object with label id and label value. Example:

cfs

Array of all custom fields of the resource (and which you are allowed to view). The array may be empty. Each array element is an object with custom field id and value. Example:

params

 Advanced search parameters that can be configured individually per resource:

 params.strict

Boolean. True if resource is configured for strict language mode. I.e. if you search in "en-UK" and the resource uses "en-US" then it will consider the language variants as distinct languages.

params.pretrans

Boolean. True if you can use this resource for automated pre-translation purposes. If false, then the PM probably considers the contents not reliable enough.

params.skipprob

Boolean. True if segments with red status shall never be searched.

params.skipsame

Boolean. True if segments where the source text equals the target text shall never be searched.

params.pen

Number. Absolute downgrade of match percentage. 0, 1, ... 100  (0 = no downgrade)

params.penum

Number. Absolute downgrade of unreliable exact matches. 0, 1, ... 100  (0 = no downgrade)

params.penformat

String. Penalty mode applied to format differences: None, Lowest, Low, Average, High, Highest

params.penfuzzy

String. Penalty mode applied to fuzzy matches: None, Lowest, Low, Average, High, Highest

params.penplace

String. Penalty mode applied to placeables: Default, None, Maximum

params.white

String. Whitespace handling mode: Default, IgnoreType, IgnoreTypeAndLength, SpecialCYK1