Page History

...

<?php $url = 'http://yourTranslate5app.com/editor/languageresourceinstance/xlsxexport?collectionId=XXX'; $cookie = __DIR__ . '/cookies.txt'; // 1. First request – simulate progress curl_setopt_array($ch1 = curl_init(), [ CURLOPT_URL => $url, CURLOPT_COOKIEJAR => $cookie, CURLOPT_RETURNTRANSFER => true, CURLOPT_WRITEFUNCTION => function($ch, $data) { // Print immediately during progress echo $data; // Tell curl all is ok for now, as otherwise curl will stop the execution return strlen($data); }, ]); curl_exec($ch1); curl_close($ch1); // 2. Second request – simulate reload to start download curl_setopt_array($ch2 = curl_init(), [ CURLOPT_URL => $url, CURLOPT_COOKIEFILE => $cookie, CURLOPT_RETURNTRANSFER => true, ]); $response = curl_exec($ch2); curl_close($ch2); // Save downloaded file locally file_put_contents('file.xlsx', $response);

responses with 'Content-Disposition: attachment' header and raw file data as response body, which is saved into file.xlsx on your local computer from where you call the curl-command

Export TermCollection as XLSX

Request

GET editor/languageresourceinstance/xlsxexport

Params

collectionId Required. Id of a TermCollection to be exported.

Important: XSLX export is a two-step operation consisting of prepare-step and download-step.

Prepare-step may take a while depending on TermCollection size, and is implemented in a way that allows to track the preparation progress measured in percents of already exported term entries vs total term entries in that TermCollection, so progress is printed during the export.

Code Block

language	js
title	Response
collapse	true

Total number of term entries: 1
Starting export...
Progress: 0%
..
Progress: 95%
Progress: 100%
Preparing the download...
Done in 2.35 sec

Once export is Done, browser page is reloaded with javascript and the download is started - so yes - all this is intended to work via browser.
For getting the same result via REST API some important things need to be considered:

Example 1: REST API request via curl-command

Step 1: curl -c cookies.txt --no-buffer -H "Cookie: zfExtended=your_translate_session_coookie" http://yourTranslate5app.com/editor/languageresourceinstance/xlsxexport?collectionId=XXX

This is the first needed request, that starts and keeps session and shows the progress as pure HTML code during execution (see below)

Code Block

language	js
title	Response
collapse	true

<pre>Total number of term entries: 1</pre><pre>Starting export...</pre><pre>Progress: 100%</pre><pre>Preparing the download...</pre><pre>Done in 0.078 sec</pre><script>window.location=window.location</script>

Step 2: curl -c cookies.txt H "Cookie: zfExtended=your_translate_session_coookie" -o file.xlsx http://yourTranslate5app.com/editor/languageresourceinstance/xlsxexport?collectionId=XXX

This is the second needed request that preserves the session and responses with 'Content-Disposition: attachment' header and raw file data as response body, which is saved into file.xlsx on your local computer from where you call the curl-command

Example 2: REST API request via php curl - see both steps below

Code Block

language	php
title	PHP curl example
linenumbers	true
collapse	true

Proposals export for a TermCollection, as XLSX

Request

GET editor/languageresourceinstance/export

Params

collectionId Required. Id of a TermCollection to be exported.

exportDate Optional.If given, should be a date in YYYY-MM-DD (or YYYY-MM-DD HH:MM:SS) format, so that only proposals happened after that date will be exported.

Important: response for this endpoint comes with 'Content-Disposition: attachment' HTTP header to provide a direct download of an exported file.

Code Block

language	js
title	Response
collapse	true

raw binary contents of an exported XLSX file

Important: If no proposals found, then the endpoint will respond with the following XML text

Code Block

language	js
title	Response
collapse	true

<?xml version="1.0"?>
<response><message>No results where found.</message></response>

...

Detect non-existing terms among the given ones - in any of accessible TermCollections

Request

GET editor/termcollection/searchtermexists

Params

searchTerms Required. Should be given as JSON-encoded array structured in the following way:

Code Block

language	js
title	JSON structure
collapse	true

[
    {
        "termtext": "Some existing term 1",
		"anyOtherProp1": "Some other value 1",
 		"anyOtherProp2": "Some other value 2", 
     },
     {
        "termtext": "Some non-existing term 1",
		"anyOtherProp1": "Some other value 3",
 		"anyOtherProp2": "Some other value 4", 
     },
     {
        "termtext": "Some non-existing term 2",
		"anyOtherProp1": "Some other value 5",
 		"anyOtherProp2": "Some other value 6", 
     }
 ]

targetLang Required. Should be given as RFC5646 language code representing a major language (e.g. 'en') or with sublanguage (e.g. 'en-US'), but keep in mind that sublanguage will be ignored.

Important: this endpoint is currently used internally by Translate5's InstantTranslate plugin only - to show 'Propose as new term in TermPortal'-button for translations that are not existing in terminology so far

Code Block

language	js
title	Response
collapse	true

{
    "rows: [
	     {
    	    "termtext": "Some non-existing term 1",
			"anyOtherProp1": "Some other value 3",
	 		"anyOtherProp2": "Some other value 4", 
    	 },
 	     {
    	    "termtext": "Some non-existing term 2",
			"anyOtherProp1": "Some other value 5",
	 		"anyOtherProp2": "Some other value 6", 
    	 }
     ]
}

...

Page tree

Versions Compared

Old Version 59

New Version Current

Key

Export TermCollection as XLSX

Proposals export for a TermCollection, as XLSX

Detect non-existing terms among the given ones - in any of accessible TermCollections