Skip to content

Commit bee6984

Browse files
rmrayarmraya
committed
Updated docs
1 parent 1f14c38 commit bee6984

32 files changed

Lines changed: 747 additions & 17 deletions

‎WebContent/docs/remotetm.pdf‎

48.6 KB
Binary file not shown.

‎docs/remotetm.ditamap‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,26 @@
6060
<topicref href="rest/exportTMX.dita">
6161
<topicref href="rest/downloadFile.dita"/>
6262
</topicref>
63-
</topicref>
64-
<topicref href="rest/permissions.dita">
65-
<topicref href="rest/getPermissions.dita"/>
66-
<topicref href="rest/setPermissions.dita"/>
63+
<topicref href="rest/permissions.dita">
64+
<topicref href="rest/getPermissions.dita"/>
65+
<topicref href="rest/setPermissions.dita"/>
66+
</topicref>
67+
<topicref href="rest/openMemory.dita"/>
68+
<topicref href="rest/closeMemory.dita"/>
69+
<topicref href="rest/closeMemories.dita"/>
70+
<topicref href="rest/storeTu.dita"/>
71+
<topicref href="rest/removeTu.dita"/>
72+
<topicref href="rest/commit.dita"/>
73+
<topicref href="rest/searchTranslations.dita"/>
74+
<topicref href="rest/searchAll.dita"/>
75+
<topicref href="rest/concordanceSearch.dita"/>
76+
<topicref href="rest/batchTranslate.dita"/>
77+
<topicref href="rest/getProjects.dita"/>
78+
<topicref href="rest/getSubjects.dita"/>
79+
<topicref href="rest/getClients.dita"/>
80+
<topicref href="rest/memoryProjects.dita"/>
81+
<topicref href="rest/memorySubjects.dita"/>
82+
<topicref href="rest/memoryClients.dita"/>
6783
</topicref>
6884
<topicref href="rest/usersManagement.dita">
6985
<topicref href="rest/getUsers.dita"/>

‎docs/rest/batchTranslate.dita‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="batchTranslate">
4+
<title>Batch Translation</title>
5+
<body>
6+
<p></p>
7+
</body>
8+
</topic>

‎docs/rest/closeMemories.dita‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="closeMemories">
4+
<title>Close Memories</title>
5+
<body>
6+
<p>End point: <tt>[RemoteTM URL]/memories</tt><tt> </tt></p>
7+
<p>Send a <tt>POST</tt> request with these headers:</p>
8+
<simpletable>
9+
<sthead>
10+
<stentry>Header</stentry>
11+
<stentry>Value</stentry>
12+
</sthead>
13+
<strow>
14+
<stentry><tt>Session</tt> </stentry>
15+
<stentry>The ticket received from <xref href="authorizationRequest.dita"
16+
>Authorization Request</xref></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><tt>Content-Type</tt></stentry>
20+
<stentry><tt>application/json</tt></stentry>
21+
</strow>
22+
</simpletable>
23+
<p>Include this parameter in a JSON body:</p>
24+
<simpletable>
25+
<sthead>
26+
<stentry>Parameter</stentry>
27+
<stentry>Value</stentry>
28+
</sthead>
29+
<strow>
30+
<stentry><tt>command</tt></stentry>
31+
<stentry><tt>closeMemories</tt></stentry>
32+
</strow>
33+
</simpletable>
34+
<p>Example:</p>
35+
<codeblock>{
36+
"command": "closeMemories"
37+
}</codeblock>
38+
<p>RemoteTM closes all open memories.</p>
39+
</body>
40+
</topic>

‎docs/rest/closeMemory.dita‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="closeMemory">
4+
<title>Close Memory</title>
5+
<body>
6+
<p>End point: <tt>[RemoteTM URL]/memories</tt><tt> </tt></p>
7+
<p>Send a <tt>POST</tt> request with these headers:</p>
8+
<simpletable>
9+
<sthead>
10+
<stentry>Header</stentry>
11+
<stentry>Value</stentry>
12+
</sthead>
13+
<strow>
14+
<stentry><tt>Session</tt> </stentry>
15+
<stentry>The ticket received from <xref href="authorizationRequest.dita"
16+
>Authorization Request</xref></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><tt>Content-Type</tt></stentry>
20+
<stentry><tt>application/json</tt></stentry>
21+
</strow>
22+
</simpletable>
23+
<p>Include these parameters in a JSON body:</p>
24+
<simpletable>
25+
<sthead>
26+
<stentry>Parameter</stentry>
27+
<stentry>Value</stentry>
28+
</sthead>
29+
<strow>
30+
<stentry><tt>command</tt></stentry>
31+
<stentry><tt>closeMemory</tt></stentry>
32+
</strow>
33+
<strow>
34+
<stentry><tt>memory</tt> </stentry>
35+
<stentry>ID of the memory to close</stentry>
36+
</strow>
37+
</simpletable>
38+
<p>Example:</p>
39+
<codeblock>{
40+
"command": "closeMemory",
41+
"memory": "1617963861912"
42+
}</codeblock>
43+
<p>RemoteTM responds with a JSON object.</p>
44+
<p>On success, field 'status' is set to 'OK'. Example:</p>
45+
<codeblock translate="no">{
46+
"status": "OK"
47+
}</codeblock>
48+
<p>On error, field 'status' is set to 'Error' and field 'reason' contains the error cause.
49+
Example:</p>
50+
<codeblock translate="no">{
51+
"status": "Error",
52+
"reason": "Access denied"
53+
}</codeblock>
54+
</body>
55+
</topic>

‎docs/rest/commit.dita‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="commit">
4+
<title>Commit</title>
5+
<body>
6+
<p></p>
7+
</body>
8+
</topic>

‎docs/rest/concordanceSearch.dita‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="concordanceSearch">
4+
<title>Concordance Search</title>
5+
<body>
6+
<p></p>
7+
</body>
8+
</topic>

‎docs/rest/exportTMX.dita‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@
3535
<stentry>ID of the memory to export</stentry>
3636
</strow>
3737
<strow>
38-
<stentry><tt>srcLang</tt>></stentry>
39-
<stentry>The code of the language to set as source or '*all*' if any languages is to
40-
be considered as source language</stentry>
38+
<stentry><tt>srcLang</tt></stentry>
39+
<stentry>The code of the language to set as source or '*all*' if any language is to
40+
be treated as source language</stentry>
4141
</strow>
4242
<strow>
4343
<stentry><tt>close</tt></stentry>
@@ -46,7 +46,7 @@
4646
</simpletable>
4747
<p>Example:</p>
4848
<codeblock translate="no">{
49-
"command": "exportMemory",
49+
"command": "exportMemory",
5050
"memory": "1617053861912",
5151
"srcLang": "*all*",
5252
"close": false

‎docs/rest/getClients.dita‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
3+
<topic id="getClients">
4+
<title>Get Clients</title>
5+
<body>
6+
<p></p>
7+
</body>
8+
</topic>

‎docs/rest/getEmailServer.dita‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,42 @@
33
<topic id="getEmailServer">
44
<title>Get Email Server</title>
55
<body>
6-
<p></p>
6+
<p>End point: <tt>[RemoteTM URL]/email</tt><tt> </tt></p>
7+
<p>Send a <tt>GET</tt> request with these headers:</p>
8+
<simpletable>
9+
<sthead>
10+
<stentry>Header</stentry>
11+
<stentry>Value</stentry>
12+
</sthead>
13+
<strow>
14+
<stentry><tt>Session</tt> </stentry>
15+
<stentry>The ticket received from <xref href="authorizationRequest.dita"
16+
>Authorization Request</xref></stentry>
17+
</strow>
18+
<strow>
19+
<stentry><tt>Content-Type</tt></stentry>
20+
<stentry><tt>application/json</tt></stentry>
21+
</strow>
22+
</simpletable>
23+
<p>RemoteTM responds with a JSON object.</p>
24+
<p>On success, field 'status' is set to 'OK' and server configuration is returned.
25+
Example:</p>
26+
<codeblock>{
27+
"server": "smtp.mydomain.com",
28+
"password": "pass123$",
29+
"instance": "https://tm.mydomain.com:8443/RemoteTM",
30+
"authenticate": true,
31+
"port": "465",
32+
"from": "remotetm@mydomain.com",
33+
"tls": false,
34+
"user": "postmaster",
35+
"status": "OK"
36+
}</codeblock>
37+
<p>On error, field 'status' is set to 'Error' and field 'reason' contains the error cause.
38+
Example:</p>
39+
<codeblock translate="no">{
40+
"status": "Error",
41+
"reason": "Access denied"
42+
}</codeblock>
743
</body>
844
</topic>

0 commit comments

Comments
 (0)