Page tree

Versions Compared

Key

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

Provides access to the data of the configured match resources (TM and MT systems).

URL:

/editor/plugins_matchresource_tmmt/[ID]

Available Methods:

GET / POST / PUT / DELETE

Specialities:

Non filebased match resources can only be added by the "admin" role. Users with the role "pm" can add filebased entries.

Availability:


Note
Only available for supporters of the crowdfunding until the crowdfunding is fully financed.


Special URLs

URLMethodsParametersDescription

/editor/plugins_matchresource_tmmt/[ID]/query

GET

segmentId: integer; the id of the segment to be queried

returns a list with query results, format see below
/editor/plugins_matchresource_tmmt/[ID]/searchGET / POST

query: string; the string to be searched in the underlying service
field: string; source or target, determines which field should be searched in a TM
limit: integer; how many results should be returned

returns a list with search results, format see below
/editor/plugins_matchresource_tmmt/[ID]/downloadGET-Returns the uploaded TM file - if any.
/editor/plugins_matchresource_tmmt/[ID]/importPOSTtmUpload: TM file uploaded as multipart/form-dataImports the given TM file into the chosen TMMT instance
/editor/plugins_matchresource_tmmt/[ID]/tasksGET / POST

GET:
id: ID of the task tmmt assocation
taskGuid: TaskGuid of the associated task
taskName: name of the associated task
state: status of the associated task
lockingUser: user who is locking of the associated task - if any
taskNr: task nr of the associated task
tmmtId: associated TM ID

POST:
toReImport: an array of taskGuids. The chosen tasks segment data is reimported into the selected TM.

Gives some status information about the tasks associated to a specific TMMT.

Triggers a reimport of the chosen tasks into the TM.

Search / Query result format

Name

Type

Info

attributes

string

Additional meta data of the returned match/search result, empty if not available.

createddateMeta data, creation time stamp of the returned match/search result

creator

string

Meta data, creator of the returned match/search result

lastEditeddateMeta data, last edited time stamp of the returned match/search result
lastEditorstringMeta data, last editor of the returned match/search result

matchrate

integer

matchrate of a found match, 0 for search results.

source

string

The found source text.

state

string

"loaded" wenn all is OK, "servererror" when we got an error in the queried service.

target

string

The found target text.

tmmtidstring

The queried tmmtid, just for reference.

 

Tmmt Resource Layout

Name

Type

Info

id

integer

GET only

entityVersionintegerGET only, set by server

name

string

Custom name of the match resource.

sourceLangintegerGET / POST, non editable after creation; numeric DB id of the language
targetLangintegerGET / POST, non editable after creation; numeric DB id of the language

color

string

Custom color of the match resource in hexadecimal form, used in the GUI.

resourceId

string

POST / GET, non editable after creation

serviceType

string

GET only, set by setting a resourceId

serviceName

string

GET only, set by setting a resourceId

fileNamestring

POST / GET, can not be changed

filebasedbooleanGET only, set by setting a resourceId
searchablebooleanGET only, set by setting a resourceId