{{^_disableToc}} {{>partials/toc}} @@ -30,7 +33,7 @@ {{/_disableToc}} {{#_disableToc}}
- {{/_disableToc}} + {{/_disableToc}} {{#_disableAffix}}
{{/_disableAffix}} @@ -52,4 +55,5 @@
{{>partials/scripts}} - + {{/redirect_url}} + \ No newline at end of file diff --git a/RWSDocsTemplate/logo.svg b/RWSTemplate/logo.svg similarity index 100% rename from RWSDocsTemplate/logo.svg rename to RWSTemplate/logo.svg diff --git a/RWSDocsTemplate/partials/affix.tmpl.partial b/RWSTemplate/partials/affix.tmpl.partial similarity index 77% rename from RWSDocsTemplate/partials/affix.tmpl.partial rename to RWSTemplate/partials/affix.tmpl.partial index 3e55e8a..92d5d31 100644 --- a/RWSDocsTemplate/partials/affix.tmpl.partial +++ b/RWSTemplate/partials/affix.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} diff --git a/RWSTemplate/partials/breadcrumb.tmpl.partial b/RWSTemplate/partials/breadcrumb.tmpl.partial new file mode 100644 index 0000000..5e9367c --- /dev/null +++ b/RWSTemplate/partials/breadcrumb.tmpl.partial @@ -0,0 +1,9 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + +
+ +
diff --git a/RWSDocsTemplate/partials/class.header.tmpl.partial b/RWSTemplate/partials/class.header.tmpl.partial similarity index 87% rename from RWSDocsTemplate/partials/class.header.tmpl.partial rename to RWSTemplate/partials/class.header.tmpl.partial index a8ed088..d743484 100644 --- a/RWSDocsTemplate/partials/class.header.tmpl.partial +++ b/RWSTemplate/partials/class.header.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

{{>partials/title}}

{{{summary}}}
@@ -16,7 +16,7 @@
{{/inClass}} {{#implements.0}} -
+
{{__global.implements}}
{{/implements.0}} {{#implements}} @@ -46,11 +46,11 @@
{{__global.assembly}}: {{assemblies.0}}.dll
{{__global.syntax}}
- 
{{syntax.content.0.value}}
+ 
{{syntax.content.0.value}}
{{#syntax.parameters.0}}
{{__global.parameters}}
- +
@@ -73,7 +73,7 @@ {{/syntax.parameters.0}} {{#syntax.return}}
{{__global.returns}}
-
{{__global.type}}
+
@@ -90,7 +90,7 @@ {{/syntax.return}} {{#syntax.typeParameters.0}}
{{__global.typeParameters}}
-
{{__global.type}}
+
diff --git a/RWSTemplate/partials/class.memberpage.tmpl.partial b/RWSTemplate/partials/class.memberpage.tmpl.partial new file mode 100644 index 0000000..54ce161 --- /dev/null +++ b/RWSTemplate/partials/class.memberpage.tmpl.partial @@ -0,0 +1,59 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + +{{>partials/class.header}} +{{#children}} +{{#overload}} + +{{/overload}} +

{{>partials/classSubtitle}}

+{{#children.0}} +
{{__global.name}}
+ + + + + + + + {{/children.0}} + {{#children}} + + + + + {{/children}} + {{#children.0}} + +
{{__global.name}}{{__global.description}}
+ + {{{summary}}}
+{{/children.0}} +{{/children}} +{{#extensionMethods.0}} +

{{__global.extensionMethods}}

+{{/extensionMethods.0}} +{{#extensionMethods}} +
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+{{/extensionMethods}} +{{#seealso.0}} +

{{__global.seealso}}

+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} diff --git a/RWSDocsTemplate/partials/class.tmpl.partial b/RWSTemplate/partials/class.tmpl.partial similarity index 87% rename from RWSDocsTemplate/partials/class.tmpl.partial rename to RWSTemplate/partials/class.tmpl.partial index 7490fbe..6b61910 100644 --- a/RWSDocsTemplate/partials/class.tmpl.partial +++ b/RWSTemplate/partials/class.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{>partials/class.header}} {{#children}} @@ -21,14 +21,14 @@

{{name.0.value}}

{{{summary}}}
{{{conceptual}}}
-
{{__global.declaration}}
+
{{__global.declaration}}
{{#syntax}}
- 
{{syntax.content.0.value}}
+ 
{{syntax.content.0.value}}
{{#parameters.0}}
{{__global.parameters}}
- +
@@ -51,7 +51,7 @@ {{/parameters.0}} {{#return}}
{{__global.returns}}
-
{{__global.type}}
+
@@ -68,7 +68,7 @@ {{/return}} {{#typeParameters.0}}
{{__global.typeParameters}}
-
{{__global.type}}
+
@@ -89,7 +89,7 @@ {{/typeParameters.0}} {{#fieldValue}}
{{__global.fieldValue}}
-
{{__global.name}}
+
@@ -106,7 +106,7 @@ {{/fieldValue}} {{#propertyValue}}
{{__global.propertyValue}}
-
{{__global.type}}
+
@@ -123,7 +123,7 @@ {{/propertyValue}} {{#eventType}}
{{__global.eventType}}
-
{{__global.type}}
+
@@ -155,7 +155,7 @@ {{/example}} {{#exceptions.0}}
{{__global.exceptions}}
-
{{__global.type}}
+
diff --git a/RWSDocsTemplate/partials/classSubtitle.tmpl.partial b/RWSTemplate/partials/classSubtitle.tmpl.partial similarity index 76% rename from RWSDocsTemplate/partials/classSubtitle.tmpl.partial rename to RWSTemplate/partials/classSubtitle.tmpl.partial index 5caea36..1c17e00 100644 --- a/RWSDocsTemplate/partials/classSubtitle.tmpl.partial +++ b/RWSTemplate/partials/classSubtitle.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{#inConstructor}} {{__global.constructorsInSubtitle}} {{/inConstructor}} @@ -25,4 +25,4 @@ {{/inFunction}} {{#inMember}} {{__global.membersInSubtitle}} -{{/inMember}} \ No newline at end of file +{{/inMember}} diff --git a/RWSTemplate/partials/collection.tmpl.partial b/RWSTemplate/partials/collection.tmpl.partial new file mode 100644 index 0000000..7e573f8 --- /dev/null +++ b/RWSTemplate/partials/collection.tmpl.partial @@ -0,0 +1,234 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + +

{{>partials/title}}

+
{{{summary}}}
+
{{{conceptual}}}
+ +{{#children}} +{{#children}} +{{^_disableContribution}} +{{#docurl}} + + | + {{__global.improveThisDoc}} +{{/docurl}} +{{#sourceurl}} + + {{__global.viewSource}} +{{/sourceurl}} +{{/_disableContribution}} +{{#overload}} + +{{/overload}} +

{{name.0.value}}

+
{{{summary}}}
+
{{{conceptual}}}
+
{{__global.declaration}}
+{{#syntax}} +
+ 
{{syntax.content.0.value}}
+
+{{#parameters.0}} +
{{__global.parameters}}
+
{{__global.type}}
+ + + + + + + + +{{/parameters.0}} +{{#parameters}} + + + + + +{{/parameters}} +{{#parameters.0}} + +
{{__global.type}}{{__global.name}}{{__global.description}}
{{{type.specName.0.value}}}{{{id}}}{{{description}}}
+{{/parameters.0}} +{{#return}} +
{{__global.returns}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/return}} +{{#typeParameters.0}} +
{{__global.typeParameters}}
+ + + + + + + + +{{/typeParameters.0}} +{{#typeParameters}} + + + + +{{/typeParameters}} +{{#typeParameters.0}} + +
{{__global.name}}{{__global.description}}
{{{id}}}{{{description}}}
+{{/typeParameters.0}} +{{#fieldValue}} +
{{__global.fieldValue}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/fieldValue}} +{{#propertyValue}} +
{{__global.propertyValue}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/propertyValue}} +{{#eventType}} +
{{__global.eventType}}
+ + + + + + + + + + + + + +
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
+{{/eventType}} +{{/syntax}} +{{#overridden}} +
{{__global.overrides}}
+
+{{/overridden}} +{{#implements.0}} +
{{__global.implements}}
+{{/implements.0}} +{{#implements}} + {{#definition}} +
+ {{/definition}} + {{^definition}} +
+ {{/definition}} +{{/implements}} +{{#remarks}} +
{{__global.remarks}}
+
{{{remarks}}}
+{{/remarks}} +{{#example.0}} +
{{__global.examples}}
+{{/example.0}} +{{#example}} +{{{.}}} +{{/example}} +{{#exceptions.0}} +
{{__global.exceptions}}
+ + + + + + + + +{{/exceptions.0}} +{{#exceptions}} + + + + +{{/exceptions}} +{{#exceptions.0}} + +
{{__global.type}}{{__global.condition}}
{{{type.specName.0.value}}}{{{description}}}
+{{/exceptions.0}} +{{#seealso.0}} +
{{__global.seealso}}
+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} +{{/children}} +{{/children}} +{{#extensionMethods.0}} +

{{__global.extensionMethods}}

+{{/extensionMethods.0}} +{{#extensionMethods}} +
+ {{#definition}} + + {{/definition}} + {{^definition}} + + {{/definition}} +
+{{/extensionMethods}} +{{#seealso.0}} +

{{__global.seealso}}

+
+{{/seealso.0}} +{{#seealso}} + {{#isCref}} +
{{{type.specName.0.value}}}
+ {{/isCref}} + {{^isCref}} +
{{{url}}}
+ {{/isCref}} +{{/seealso}} +{{#seealso.0}} +
+{{/seealso.0}} diff --git a/RWSTemplate/partials/customMREFContent.tmpl.partial b/RWSTemplate/partials/customMREFContent.tmpl.partial new file mode 100644 index 0000000..abb7b6f --- /dev/null +++ b/RWSTemplate/partials/customMREFContent.tmpl.partial @@ -0,0 +1,10 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{!Add your own custom template for the content for ManagedReference here}} +{{#_splitReference}} +{{#isCollection}} +{{>partials/collection}} +{{/isCollection}} +{{#isItem}} +{{>partials/item}} +{{/isItem}} +{{/_splitReference}} diff --git a/RWSDocsTemplate/partials/dd-li.tmpl.partial b/RWSTemplate/partials/dd-li.tmpl.partial similarity index 100% rename from RWSDocsTemplate/partials/dd-li.tmpl.partial rename to RWSTemplate/partials/dd-li.tmpl.partial diff --git a/RWSDocsTemplate/partials/enum.tmpl.partial b/RWSTemplate/partials/enum.tmpl.partial similarity index 83% rename from RWSDocsTemplate/partials/enum.tmpl.partial rename to RWSTemplate/partials/enum.tmpl.partial index b5584ad..7afb282 100644 --- a/RWSDocsTemplate/partials/enum.tmpl.partial +++ b/RWSTemplate/partials/enum.tmpl.partial @@ -1,9 +1,9 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{>partials/class.header}} {{#children}}

{{>partials/classSubtitle}}

- +
diff --git a/RWSDocsTemplate/partials/footer.tmpl.partial b/RWSTemplate/partials/footer.tmpl.partial similarity index 68% rename from RWSDocsTemplate/partials/footer.tmpl.partial rename to RWSTemplate/partials/footer.tmpl.partial index f4b9a7e..cff40ee 100644 --- a/RWSDocsTemplate/partials/footer.tmpl.partial +++ b/RWSTemplate/partials/footer.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
diff --git a/RWSTemplate/partials/head.tmpl.partial b/RWSTemplate/partials/head.tmpl.partial new file mode 100644 index 0000000..c801f7e --- /dev/null +++ b/RWSTemplate/partials/head.tmpl.partial @@ -0,0 +1,34 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + + + + {{#_googleAnalyticsTagId}} + + + {{/_googleAnalyticsTagId}} + {{#redirect_url}} + + {{/redirect_url}} + {{^redirect_url}} + + {{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}} {{#_appTitle}}| {{_appTitle}} {{/_appTitle}} + + + {{#_description}}{{/_description}} + {{#description}}{{/description}} + + + + + + + {{#_noindex}}{{/_noindex}} + {{#_enableSearch}}{{/_enableSearch}} + {{#_enableNewTab}}{{/_enableNewTab}} + {{/redirect_url}} + diff --git a/RWSTemplate/partials/item.tmpl.partial b/RWSTemplate/partials/item.tmpl.partial new file mode 100644 index 0000000..547889a --- /dev/null +++ b/RWSTemplate/partials/item.tmpl.partial @@ -0,0 +1,3 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + +{{>partials/class.header}} diff --git a/RWSDocsTemplate/partials/li.tmpl.partial b/RWSTemplate/partials/li.tmpl.partial similarity index 84% rename from RWSDocsTemplate/partials/li.tmpl.partial rename to RWSTemplate/partials/li.tmpl.partial index 7e2d689..c6e0b4a 100644 --- a/RWSDocsTemplate/partials/li.tmpl.partial +++ b/RWSTemplate/partials/li.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
    {{#items}} diff --git a/RWSTemplate/partials/logo.tmpl.partial b/RWSTemplate/partials/logo.tmpl.partial new file mode 100644 index 0000000..1d30a2c --- /dev/null +++ b/RWSTemplate/partials/logo.tmpl.partial @@ -0,0 +1,5 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + + + + diff --git a/RWSDocsTemplate/partials/namespace.tmpl.partial b/RWSTemplate/partials/namespace.tmpl.partial similarity index 76% rename from RWSDocsTemplate/partials/namespace.tmpl.partial rename to RWSTemplate/partials/namespace.tmpl.partial index e8b6b14..f52f692 100644 --- a/RWSDocsTemplate/partials/namespace.tmpl.partial +++ b/RWSTemplate/partials/namespace.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

    {{>partials/title}}

    {{{summary}}}
    diff --git a/RWSDocsTemplate/partials/namespaceSubtitle.tmpl.partial b/RWSTemplate/partials/namespaceSubtitle.tmpl.partial similarity index 75% rename from RWSDocsTemplate/partials/namespaceSubtitle.tmpl.partial rename to RWSTemplate/partials/namespaceSubtitle.tmpl.partial index b3a30d8..823597b 100644 --- a/RWSDocsTemplate/partials/namespaceSubtitle.tmpl.partial +++ b/RWSTemplate/partials/namespaceSubtitle.tmpl.partial @@ -1,9 +1,8 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} -{{^isNamespace}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + {{#inNamespace}} {{__global.namespacesInSubtitle}} {{/inNamespace}} -{{/isNamespace}} {{#inClass}} {{__global.classesInSubtitle}} {{/inClass}} diff --git a/RWSDocsTemplate/partials/navbar.tmpl.partial b/RWSTemplate/partials/navbar.tmpl.partial similarity index 78% rename from RWSDocsTemplate/partials/navbar.tmpl.partial rename to RWSTemplate/partials/navbar.tmpl.partial index be0dc46..995c57a 100644 --- a/RWSDocsTemplate/partials/navbar.tmpl.partial +++ b/RWSTemplate/partials/navbar.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{__global.name}}
+
- + @@ -41,7 +41,18 @@ {{#parameters}} - + @@ -53,10 +64,11 @@ {{#responses.0}}
Responses
-
Name TypeValueDefault Notes
{{#required}}*{{/required}}{{name}}{{type}} + {{^schema.cType}} + {{schema.type}} + {{#schema.format}} + ({{schema.format}}) + {{/schema.format}} + {{/schema.cType}} + + {{#schema.cType}} + {{{schema.cType}}}{{#schema.cTypeIsArray}}[]{{/schema.cTypeIsArray}} + {{/schema.cType}} + {{default}} {{{description}}}
+
+ @@ -66,6 +78,15 @@ {{#responses}} +
Status CodeType Description Samples
{{statusCode}} + {{^schema.cType}} + {{schema.type}} + {{/schema.cType}} + + {{#schema.cType}} + {{{schema.cType}}}{{#schema.cTypeIsArray}}[]{{/schema.cTypeIsArray}} + {{/schema.cType}} + {{{description}}} {{#examples}} @@ -84,4 +105,4 @@ {{/responses.0}} {{#footer}}
{{{footer}}}
-{{/footer}} \ No newline at end of file +{{/footer}} diff --git a/RWSTemplate/partials/rest.definition.tmpl.partial b/RWSTemplate/partials/rest.definition.tmpl.partial new file mode 100644 index 0000000..83cc77e --- /dev/null +++ b/RWSTemplate/partials/rest.definition.tmpl.partial @@ -0,0 +1,45 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} + +

{{{cType}}}

+{{#description}} +
{{{description}}}
+{{/description}} +{{#properties.0}} + + + + + + + + + + {{/properties.0}} + {{#properties}} + + + + + + {{/properties}} + {{#properties.0}} + +
NameTypeNotes
{{key}} + {{^value.cType}} + {{value.type}} + {{#value.format}} + ({{value.format}}) + {{/value.format}} + {{/value.cType}} + + {{#value.cType}} + {{{value.cType}}}{{#value.cTypeIsArray}}[]{{/value.cTypeIsArray}} + {{/value.cType}} + {{{value.description}}}
+{{/properties.0}} +{{#enum.0}} +
Enum Values
+{{#enum}} +{{.}}
+{{/enum}} +{{/enum.0}} diff --git a/RWSDocsTemplate/partials/rest.tmpl.partial b/RWSTemplate/partials/rest.tmpl.partial similarity index 78% rename from RWSDocsTemplate/partials/rest.tmpl.partial rename to RWSTemplate/partials/rest.tmpl.partial index a7c73ec..9ebedcc 100644 --- a/RWSDocsTemplate/partials/rest.tmpl.partial +++ b/RWSTemplate/partials/rest.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

{{name}}

{{#summary}} @@ -31,7 +31,12 @@ {{#children}} {{>partials/rest.child}} {{/children}} +{{#definitions.0}} +

Definitions

+{{/definitions.0}} +{{#definitions}} + {{>partials/rest.definition}} +{{/definitions}} {{#footer}}
{{{footer}}}
{{/footer}} - diff --git a/RWSDocsTemplate/partials/scripts.tmpl.partial b/RWSTemplate/partials/scripts.tmpl.partial similarity index 55% rename from RWSDocsTemplate/partials/scripts.tmpl.partial rename to RWSTemplate/partials/scripts.tmpl.partial index ab3204e..c3a28aa 100644 --- a/RWSDocsTemplate/partials/scripts.tmpl.partial +++ b/RWSTemplate/partials/scripts.tmpl.partial @@ -1,5 +1,5 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - + diff --git a/RWSDocsTemplate/partials/searchResults.tmpl.partial b/RWSTemplate/partials/searchResults.tmpl.partial similarity index 71% rename from RWSDocsTemplate/partials/searchResults.tmpl.partial rename to RWSTemplate/partials/searchResults.tmpl.partial index 26a2881..8858184 100644 --- a/RWSDocsTemplate/partials/searchResults.tmpl.partial +++ b/RWSTemplate/partials/searchResults.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{__global.searchResults}}
diff --git a/RWSTemplate/partials/title.tmpl.partial b/RWSTemplate/partials/title.tmpl.partial new file mode 100644 index 0000000..51f83cc --- /dev/null +++ b/RWSTemplate/partials/title.tmpl.partial @@ -0,0 +1,2 @@ +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} +{{#inPackage}}Package {{name.0.value}}{{/inPackage}}{{#isNamespace}}Namespace {{name.0.value}}{{/isNamespace}}{{#inClass}}Class {{name.0.value}}{{/inClass}}{{#inStruct}}Struct {{name.0.value}}{{/inStruct}}{{#inInterface}}Interface {{name.0.value}}{{/inInterface}}{{#inEnum}}Enum {{name.0.value}}{{/inEnum}}{{#inDelegate}}Delegate {{name.0.value}}{{/inDelegate}}{{#inConstructor}}Constructor {{name.0.value}}{{/inConstructor}}{{#inField}}Field {{name.0.value}}{{/inField}}{{#inProperty}}Property {{name.0.value}}{{/inProperty}}{{#inMethod}}Method {{name.0.value}}{{/inMethod}}{{#inEvent}}Event {{name.0.value}}{{/inEvent}}{{#inOperator}}Operator {{name.0.value}}{{/inOperator}}{{#inEii}}Explicit Interface Implementation {{name.0.value}}{{/inEii}}{{#inVariable}}Variable {{name.0.value}}{{/inVariable}}{{#inTypeAlias}}Type Alias {{name.0.value}}{{/inTypeAlias}} \ No newline at end of file diff --git a/RWSDocsTemplate/partials/toc.tmpl.partial b/RWSTemplate/partials/toc.tmpl.partial similarity index 66% rename from RWSDocsTemplate/partials/toc.tmpl.partial rename to RWSTemplate/partials/toc.tmpl.partial index 540543f..507a128 100644 --- a/RWSDocsTemplate/partials/toc.tmpl.partial +++ b/RWSTemplate/partials/toc.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
diff --git a/RWSDocsTemplate/partials/uref/class.header.tmpl.partial b/RWSTemplate/partials/uref/class.header.tmpl.partial similarity index 89% rename from RWSDocsTemplate/partials/uref/class.header.tmpl.partial rename to RWSTemplate/partials/uref/class.header.tmpl.partial index 8754c71..85aaf8f 100644 --- a/RWSDocsTemplate/partials/uref/class.header.tmpl.partial +++ b/RWSTemplate/partials/uref/class.header.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

{{>partials/title}}

{{{summary}}}
@@ -46,4 +46,4 @@ {{/example.0}} {{#example}} {{{.}}} -{{/example}} \ No newline at end of file +{{/example}} diff --git a/RWSDocsTemplate/partials/uref/class.tmpl.partial b/RWSTemplate/partials/uref/class.tmpl.partial similarity index 88% rename from RWSDocsTemplate/partials/uref/class.tmpl.partial rename to RWSTemplate/partials/uref/class.tmpl.partial index f4eb119..385cb93 100644 --- a/RWSDocsTemplate/partials/uref/class.tmpl.partial +++ b/RWSTemplate/partials/uref/class.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{>partials/uref/class.header}} {{#children}} @@ -21,14 +21,14 @@

{{name.0.value}}

{{{summary}}}
{{{conceptual}}}
-
{{__global.declaration}}
+
{{__global.declaration}}
{{#syntax}} 
{{syntax.content.0.value}}
{{#parameters.0}}
{{__global.parameters}}
- +
@@ -54,7 +54,7 @@ {{/parameters.0}} {{#return}}
{{__global.returns}}
-
{{__global.type}}
+
@@ -71,7 +71,7 @@ {{/return}} {{#typeParameters.0}}
{{__global.typeParameters}}
-
{{__global.type}}
+
@@ -92,7 +92,7 @@ {{/typeParameters.0}} {{#fieldValue}}
{{__global.fieldValue}}
-
{{__global.name}}
+
@@ -109,7 +109,7 @@ {{/fieldValue}} {{#propertyValue}}
{{__global.propertyValue}}
-
{{__global.type}}
+
@@ -126,7 +126,7 @@ {{/propertyValue}} {{#eventType}}
{{__global.eventType}}
-
{{__global.type}}
+
@@ -143,7 +143,7 @@ {{/eventType}} {{#variableValue}}
{{__global.variableValue}}
-
{{__global.type}}
+
@@ -160,7 +160,7 @@ {{/variableValue}} {{#typeAliasType}}
{{__global.typeAliasType}}
-
{{__global.type}}
+
@@ -203,7 +203,7 @@ {{/example}} {{#exceptions.0}}
{{__global.exceptions}}
-
{{__global.type}}
+
diff --git a/RWSDocsTemplate/partials/uref/enum.tmpl.partial b/RWSTemplate/partials/uref/enum.tmpl.partial similarity index 78% rename from RWSDocsTemplate/partials/uref/enum.tmpl.partial rename to RWSTemplate/partials/uref/enum.tmpl.partial index ef9fcb3..acbb412 100644 --- a/RWSDocsTemplate/partials/uref/enum.tmpl.partial +++ b/RWSTemplate/partials/uref/enum.tmpl.partial @@ -1,9 +1,9 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{>partials/uref/class.header}} {{#children}}

{{>partials/classSubtitle}}

-
{{__global.type}}
+
diff --git a/RWSDocsTemplate/partials/uref/inheritance.tmpl.partial b/RWSTemplate/partials/uref/inheritance.tmpl.partial similarity index 100% rename from RWSDocsTemplate/partials/uref/inheritance.tmpl.partial rename to RWSTemplate/partials/uref/inheritance.tmpl.partial diff --git a/RWSDocsTemplate/partials/uref/namespace.tmpl.partial b/RWSTemplate/partials/uref/namespace.tmpl.partial similarity index 89% rename from RWSDocsTemplate/partials/uref/namespace.tmpl.partial rename to RWSTemplate/partials/uref/namespace.tmpl.partial index 5891009..e1aa75d 100644 --- a/RWSDocsTemplate/partials/uref/namespace.tmpl.partial +++ b/RWSTemplate/partials/uref/namespace.tmpl.partial @@ -1,4 +1,4 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}

{{>partials/title}}

{{{summary}}}
@@ -34,14 +34,14 @@

{{name.0.value}}

{{{summary}}}
{{{conceptual}}}
-
{{__global.declaration}}
+
{{__global.declaration}}
{{#syntax}} 
{{syntax.content.0.value}}
{{#parameters.0}}
{{__global.parameters}}
-
{{__global.name}}
+
@@ -67,7 +67,7 @@ {{/parameters.0}} {{#return}}
{{__global.returns}}
-
{{__global.type}}
+
@@ -84,7 +84,7 @@ {{/return}} {{#typeParameters.0}}
{{__global.typeParameters}}
-
{{__global.type}}
+
@@ -105,7 +105,7 @@ {{/typeParameters.0}} {{#fieldValue}}
{{__global.fieldValue}}
-
{{__global.name}}
+
@@ -122,7 +122,7 @@ {{/fieldValue}} {{#propertyValue}}
{{__global.propertyValue}}
-
{{__global.type}}
+
@@ -139,7 +139,7 @@ {{/propertyValue}} {{#eventType}}
{{__global.eventType}}
-
{{__global.type}}
+
@@ -182,7 +182,7 @@ {{/example}} {{#exceptions.0}}
{{__global.exceptions}}
-
{{__global.type}}
+
diff --git a/RWSDocsTemplate/partials/uref/parameters.tmpl.partial b/RWSTemplate/partials/uref/parameters.tmpl.partial similarity index 68% rename from RWSDocsTemplate/partials/uref/parameters.tmpl.partial rename to RWSTemplate/partials/uref/parameters.tmpl.partial index 25feab9..74999df 100644 --- a/RWSDocsTemplate/partials/uref/parameters.tmpl.partial +++ b/RWSTemplate/partials/uref/parameters.tmpl.partial @@ -1,8 +1,8 @@ -{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}} +{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} {{#properties.0}}
Properties
-
{{__global.type}}
+
@@ -25,4 +25,4 @@ {{#properties.0}}
{{__global.type}}
-{{/properties.0}} \ No newline at end of file +{{/properties.0}} diff --git a/RWSDocsTemplate/search-stopwords.json b/RWSTemplate/search-stopwords.json similarity index 100% rename from RWSDocsTemplate/search-stopwords.json rename to RWSTemplate/search-stopwords.json diff --git a/RWSDocsTemplate/styles/docfx.css b/RWSTemplate/styles/docfx.css similarity index 85% rename from RWSDocsTemplate/styles/docfx.css rename to RWSTemplate/styles/docfx.css index 3c3780b..b02c64f 100644 --- a/RWSDocsTemplate/styles/docfx.css +++ b/RWSTemplate/styles/docfx.css @@ -66,33 +66,53 @@ h6 mark { .inheritance .level2:before, .inheritance .level3:before, .inheritance .level4:before, -.inheritance .level5:before { - content: '↳'; - margin-right: 5px; +.inheritance .level5:before, +.inheritance .level6:before, +.inheritance .level7:before, +.inheritance .level8:before, +.inheritance .level9:before { + content: '↳'; + margin-right: 5px; } .inheritance .level0 { - margin-left: 0em; + margin-left: 0em; } .inheritance .level1 { - margin-left: 1em; + margin-left: 1em; } .inheritance .level2 { - margin-left: 2em; + margin-left: 2em; } .inheritance .level3 { - margin-left: 3em; + margin-left: 3em; } .inheritance .level4 { - margin-left: 4em; + margin-left: 4em; } .inheritance .level5 { - margin-left: 5em; + margin-left: 5em; +} + +.inheritance .level6 { + margin-left: 6em; +} + +.inheritance .level7 { + margin-left: 7em; +} + +.inheritance .level8 { + margin-left: 8em; +} + +.inheritance .level9 { + margin-left: 9em; } .level0.summary { @@ -106,11 +126,10 @@ h6 mark { span.parametername, span.paramref, span.typeparamref { - font-style: italic; + font-style: italic; } - -span.languagekeyword { - font-weight: bold; +span.languagekeyword{ + font-weight: bold; } .hljs { @@ -118,25 +137,20 @@ span.languagekeyword { background-color: inherit; padding: 0; } - /* additional spacing fixes */ -.btn+.btn { +.btn + .btn { margin-left: 10px; } - .btn.pull-right { margin-left: 10px; margin-top: 5px; } - .table { margin-bottom: 10px; } - table p { margin-bottom: 0; } - table a { display: inline-block; } @@ -156,7 +170,6 @@ h3, margin-bottom: 10px; font-weight: 400; } - h4, .h4, h5, @@ -166,16 +179,13 @@ h6, margin-top: 10px; margin-bottom: 5px; } - .navbar { margin-bottom: 0; } - #wrapper { min-height: 100%; position: relative; } - /* blends header footer and content together with gradient effect */ .grad-top { /* For Safari 5.1 to 6.0 */ @@ -185,7 +195,6 @@ h6, /* Standard syntax */ height: 5px; } - .grad-bottom { /* For Safari 5.1 to 6.0 */ /* For Opera 11.1 to 12.0 */ @@ -194,16 +203,13 @@ h6, /* Standard syntax */ height: 5px; } - .divider { margin: 0 5px; color: #cccccc; } - hr { border-color: #cccccc; } - header { position: fixed; top: 0; @@ -211,23 +217,19 @@ header { right: 0; z-index: 1000; } - header .navbar { border-width: 0 0 1px 0; border-radius: 0; border-color: var(--accent-dim); border-style: solid; } - .navbar-brand { font-size: inherit; padding: 0; } - .navbar-collapse { margin: 0 -15px; } - .subnav { min-height: 40px; } @@ -256,13 +258,13 @@ article h4 { margin-top: 25px; } -article h4 { +article h4{ border: 0; font-weight: bold; margin-top: 2em; } -article span.small.pull-right { +article span.small.pull-right{ margin-top: 20px; } @@ -278,13 +280,10 @@ article section { padding: 10px 0; background-color: inherit; white-space: nowrap; - font-size: .8125rem; } .breadcrumb>li+li:before { content: "›"; - font-size: 1.2rem; - line-height: 1rem; color: var(--highlight-light); } @@ -295,58 +294,46 @@ article section { #autocollapse.collapsed .navbar-header { float: none; } - #autocollapse.collapsed .navbar-toggle { display: block; } - #autocollapse.collapsed .navbar-collapse { border-top: 1px solid transparent; box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1); } - #autocollapse.collapsed .navbar-collapse.collapse { display: none !important; } - #autocollapse.collapsed .navbar-nav { float: none !important; margin: 7.5px -15px; } - -#autocollapse.collapsed .navbar-nav>li { +#autocollapse.collapsed .navbar-nav > li { float: none; } - -#autocollapse.collapsed .navbar-nav>li>a { +#autocollapse.collapsed .navbar-nav > li > a { padding-top: 10px; padding-bottom: 10px; } - #autocollapse.collapsed .collapse.in, #autocollapse.collapsed .collapsing { display: block !important; } - #autocollapse.collapsed .collapse.in .navbar-right, #autocollapse.collapsed .collapsing .navbar-right { float: none !important; } - #autocollapse .form-group { position: relative; width: 100%; } - #autocollapse .form-control { width: 100%; } - #autocollapse .navbar-header { margin-left: 0; margin-right: 2rem; } - #autocollapse .navbar-brand { margin-left: 0; } @@ -374,61 +361,50 @@ article section { padding: 10px 15px; box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); } - .collapsed .collapse.in .navbar-form { margin: 0 auto; max-width: 400px; padding: 10px 15px; box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1); } - .navbar .navbar-nav { display: inline-block; } - .docs-search { background: white; vertical-align: middle; } - -.docs-search>.search-query { +.docs-search > .search-query { font-size: 14px; border: 0; width: 120%; color: #555; } - -.docs-search>.search-query:focus { +.docs-search > .search-query:focus { outline: 0; } - .search-results-frame { clear: both; display: table; width: 100%; } - .search-results.ng-hide { display: none; } - .search-results-container { padding-bottom: 1em; border-top: 1px solid #111; background: rgba(25, 25, 25, 0.5); } - .search-results-container .search-results-group { padding-top: 50px !important; padding: 10px; } - .search-results-group-heading { font-family: "Open Sans"; padding-left: 10px; color: white; } - .search-close { position: absolute; left: 50%; @@ -442,7 +418,6 @@ article section { width: 200px; box-shadow: 0 0 10px #111; } - #search { display: none; } @@ -578,20 +553,17 @@ body .toc { .sidetoggle.ng-hide { display: block !important; } - -.sidetoc-expand>.caret { +.sidetoc-expand > .caret { margin-left: 0px; margin-top: -2px; } - -.sidetoc-expand>.caret-side { +.sidetoc-expand > .caret-side { border-left: 4px solid; border-top: 4px solid transparent; border-bottom: 4px solid transparent; margin-left: 4px; margin-top: -4px; } - .sidetoc-heading { font-weight: 500; } @@ -611,31 +583,27 @@ body .toc { top: 0; left: 0; } - -.toc .nav>li>a { +.toc .nav > li > a { color: #666666; margin-left: 5px; display: block; padding: 0; } - -.toc .nav>li>a:hover, -.toc .nav>li>a:focus { +.toc .nav > li > a:hover, +.toc .nav > li > a:focus { color: #000000; background: none; text-decoration: inherit; } - -.toc .nav>li.active>a { +.toc .nav > li.active > a { color: #337ab7; } - -.toc .nav>li.active>a:hover, -.toc .nav>li.active>a:focus { +.toc .nav > li.active > a:hover, +.toc .nav > li.active > a:focus { color: #23527c; } -.toc .nav>li>.expand-stub { +.toc .nav > li> .expand-stub { cursor: pointer; } @@ -662,16 +630,16 @@ body .toc { transition: 350ms ease-out; } -.toc .nav>li.filtered>ul, -.toc .nav>li.in>ul { +.toc .nav > li.filtered > ul, +.toc .nav > li.in > ul { display: block; } -.toc .nav>li>ul { +.toc .nav > li > ul { display: none; } -.toc ul { +.toc ul{ font-size: 12px; margin: 0 auto 0 5%; max-width: 80%; @@ -761,7 +729,6 @@ body .toc { display: none; margin: 0 15px 0px 15px; } - .sidefilter { position: fixed; top: 90px; @@ -787,37 +754,47 @@ body .toc { margin: 0 5px 0 5px; } -.toc-filter>input { +.toc-filter > input { color: var(--input-text); padding-left: 2.3rem; padding-right: 1rem; width: 100%; + height: calc(1.5em + 8px); /* Adjust height by adding 5 pixels */ + line-height: calc(1.5em + 8px); /* Match line height for vertical centering */ + border: 1px solid #d0d0d0; /* Add gray border */ + border-radius: 5px; /* Round corners */ } -.toc-filter>input:focus { +.toc-filter > input:focus { outline: 0; } -.toc-filter>.filter-icon { +.toc-filter > .filter-icon { position: absolute; + top: 2px; + left: 5px; } + + .toc-filter>.clear-icon { position: absolute; text-align: center; height: 1rem; width: 1.5rem; - top: .9rem; + top: 1.2rem; right: 1.2rem; background-color: #fff; } + .article { margin-top: 120px; margin-bottom: 115px; } -#_content>a { + +#_content>a{ margin-top: 105px; } @@ -829,13 +806,11 @@ body .toc { margin-top: 5px; margin-bottom: 5px; } - .article img { max-width: 100%; margin-top: 2rem; margin-bottom: 2rem; } - .sideaffix { margin-top: 50px; font-size: 12px; @@ -845,53 +820,43 @@ body .toc { bottom: 10px; position: fixed; } - .sideaffix.shiftup { bottom: 70px; } - .affix { position: relative; height: 100%; } - -.sideaffix>div.contribution { +.sideaffix > div.contribution { margin-bottom: 20px; } - -.sideaffix>div.contribution>ul>li>a.contribution-link { +.sideaffix > div.contribution > ul > li > a.contribution-link { padding: 6px 10px; font-weight: bold; font-size: 14px; } - -.sideaffix>div.contribution>ul>li>a.contribution-link:hover { +.sideaffix > div.contribution > ul > li > a.contribution-link:hover { background-color: #ffffff; } - -.sideaffix ul.nav>li>a:focus { +.sideaffix ul.nav > li > a:focus { background: none; } - .affix h5 { font-weight: bold; text-transform: uppercase; padding-left: 10px; font-size: 12px; } - -.affix>ul.level1 { +.affix > ul.level1 { overflow: hidden; padding-bottom: 10px; height: calc(100% - 100px); } - -.affix ul>li>a:before { +.affix ul > li > a:before { color: #cccccc; position: absolute; } - -.affix ul>li>a:hover { +.affix ul > li > a:hover { background: none; color: var(--highlight-light); } @@ -910,55 +875,45 @@ body .toc { padding: 5px 12px; color: var(--font-color); } - -.affix>ul>li.active:last-child { +.affix > ul > li.active:last-child { margin-bottom: 50px; } - -.affix>ul>li>a:before { +.affix > ul > li > a:before { content: "|"; font-size: 16px; top: 1px; left: 0; } - -.affix>ul>li.active>a, -.affix>ul>li.active>a:before { +.affix > ul > li.active > a, +.affix > ul > li.active > a:before { color: #337ab7; font-weight: bold; } - -.affix ul ul>li>a { +.affix ul ul > li > a { padding: 2px 15px; } - -.affix ul ul>li>a:before { +.affix ul ul > li > a:before { content: ">"; font-size: 14px; top: -1px; left: 5px; } - -.affix ul>li>a:before, +.affix ul > li > a:before, .affix ul ul { display: none; } - -.affix ul>li.active>ul, -.affix ul>li.active>a:before, -.affix ul>li>a:hover:before { +.affix ul > li.active > ul, +.affix ul > li.active > a:before, +.affix ul > li > a:hover:before { display: block; white-space: nowrap; } - .codewrapper { position: relative; } - .trydiv { height: 0px; } - .tryspan { position: absolute; top: 0px; @@ -977,21 +932,17 @@ body .toc { display: none; color: #767676; } - .tryspan:hover { background-color: #3b8bd0; color: white; border-color: #3b8bd0; } - .codewrapper:hover .tryspan { display: block; } - -.sample-response .response-content { +.sample-response .response-content{ max-height: 200px; } - footer { position: absolute; left: 0; @@ -999,60 +950,49 @@ footer { bottom: 0; z-index: 1000; } - .footer { border-top: 1px solid #e7e7e7; background-color: #f8f8f8; padding: 15px 0; } - @media (min-width: 768px) { #sidetoggle.collapse { display: block; } - .topnav .navbar-nav { float: none; white-space: nowrap; } - - .topnav .navbar-nav>li { + .topnav .navbar-nav > li { float: none; display: inline-block; } } - @media only screen and (max-width: 768px) { #mobile-indicator { display: block; } - /* TOC display for responsive */ .article { margin-top: 30px !important; } - header { position: static; } - .topnav { text-align: center; } - .sidenav { padding: 15px 0; margin-left: -15px; margin-right: -15px; } - .sidefilter { position: static; width: auto; float: none; border: none; } - .sidetoc { position: static; width: auto; @@ -1060,54 +1000,44 @@ footer { padding-bottom: 0px; border: none; } - - .toc .nav>li>a { + .toc .nav > li, .toc .nav > li >a { display: inline-block; } - .toc li:after { margin-left: -3px; margin-right: 5px; - content: " "; + content: ", "; color: #666666; } - - .toc .level1>li { + .toc .level1 > li { display: block; } - .toc .level1>li:after { + .toc .level1 > li:after { display: none; } - .article.grid-right { margin-left: 0; } - .grad-top, .grad-bottom { display: none; } - .toc-toggle { display: block; } - .sidetoggle.ng-hide { display: none !important; } - /*.expand-all { display: none; }*/ .sideaffix { display: none; } - .mobile-hide { display: none; } - .breadcrumb { white-space: inherit; } @@ -1117,18 +1047,18 @@ footer { h2:before, h3:before, h4:before { - content: ''; - display: none; + content: ''; + display: none; } } /* For toc iframe */ @media (max-width: 260px) { - .toc .level2>li { + .toc .level2 > li { display: block; } - .toc .level2>li:after { + .toc .level2 > li:after { display: none; } } @@ -1149,7 +1079,7 @@ a code:hover { } .hljs-keyword { - color: rgb(86, 156, 214); + color: rgb(86,156,214); } .hljs-string { @@ -1161,73 +1091,70 @@ pre { } /* For code snippet line highlight */ -pre>code .line-highlight { +pre > code .line-highlight { background-color: #ffffcc; } /* Alerts */ .alert h5 { - text-transform: uppercase; - font-weight: bold; - margin-top: 0; + text-transform: uppercase; + font-weight: bold; + margin-top: 0; } .alert h5:before { - position: relative; - top: 1px; - display: inline-block; - font-family: 'Glyphicons Halflings'; - line-height: 1; - -webkit-font-smoothing: antialiased; - -moz-osx-font-smoothing: grayscale; - margin-right: 5px; - font-weight: normal; + position:relative; + top:1px; + display:inline-block; + font-family:'Glyphicons Halflings'; + line-height:1; + -webkit-font-smoothing:antialiased; + -moz-osx-font-smoothing:grayscale; + margin-right: 5px; + font-weight: normal; } .alert-info h5:before { - content: "\e086" + content:"\e086" } .alert-warning h5:before { - content: "\e127" + content:"\e127" } .alert-danger h5:before { - content: "\e107" + content:"\e107" } /* For Embedded Video */ div.embeddedvideo { - padding-top: 56.25%; - position: relative; - width: 100%; + padding-top: 56.25%; + position: relative; + width: 100%; } div.embeddedvideo iframe { - position: absolute; - top: 0; - left: 0; - right: 0; - bottom: 0; - width: 100%; - height: 100%; + position: absolute; + top: 0; + left: 0; + right: 0; + bottom: 0; + width: 100%; + height: 100%; } /* For printer */ -@media print { +@media print{ .article.grid-right { margin-top: 0px; margin-left: 0px; } - .sideaffix { display: none; } - .mobile-hide { display: none; } - .footer { display: none; } @@ -1328,4 +1255,10 @@ div.embeddedvideo iframe { #events { font-weight: bold; margin-top: 2em; -} \ No newline at end of file +} + +@media print { + @page { + margin: .4in; + } +} diff --git a/RWSDocsTemplate/styles/docfx.js b/RWSTemplate/styles/docfx.js similarity index 93% rename from RWSDocsTemplate/styles/docfx.js rename to RWSTemplate/styles/docfx.js index b095cf6..3994350 100644 --- a/RWSDocsTemplate/styles/docfx.js +++ b/RWSTemplate/styles/docfx.js @@ -1,4 +1,5 @@ -// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information. +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. $(function () { var active = 'active'; var expanded = 'in'; @@ -51,7 +52,7 @@ $(function () { // Styling for tables in conceptual documents using Bootstrap. // See http://getbootstrap.com/css/#tables function renderTables() { - $('table').addClass('table table-bordered table-striped table-condensed').wrap('
'); + $('table').addClass('table table-bordered table-condensed').wrap('
'); } // Styling for alerts. @@ -65,7 +66,7 @@ $(function () { (function () { anchors.options = { placement: 'left', - visible: 'touch' + visible: 'hover' }; anchors.add('article h2:not(.no-anchor), article h3:not(.no-anchor), article h4:not(.no-anchor)'); })(); @@ -82,7 +83,7 @@ $(function () { // Enable highlight.js function highlight() { $('pre code').each(function (i, block) { - hljs.highlightBlock(block); + hljs.highlightElement(block); }); $('pre code[highlight-lines]').each(function (i, block) { if (block.innerHTML === "") return; @@ -127,13 +128,10 @@ $(function () { return; } try { - var worker = new Worker(relHref + 'styles/search-worker.js'); - if (!worker && !window.worker) { - localSearch(); - } else { - webWorkerSearch(); + if(!window.Worker){ + return; } - + webWorkerSearch(); renderSearchBox(); highlightKeywords(); addSearchEvent(); @@ -163,50 +161,14 @@ $(function () { } } - // Search factory - function localSearch() { - console.log("using local search"); - var lunrIndex = lunr(function () { - this.ref('href'); - this.field('title', { boost: 50 }); - this.field('keywords', { boost: 20 }); - }); - lunr.tokenizer.seperator = /[\s\-\.]+/; - var searchData = {}; - var searchDataRequest = new XMLHttpRequest(); - - var indexPath = relHref + "index.json"; - if (indexPath) { - searchDataRequest.open('GET', indexPath); - searchDataRequest.onload = function () { - if (this.status != 200) { - return; - } - searchData = JSON.parse(this.responseText); - for (var prop in searchData) { - if (searchData.hasOwnProperty(prop)) { - lunrIndex.add(searchData[prop]); - } - } - } - searchDataRequest.send(); - } - - $("body").bind("queryReady", function () { - var hits = lunrIndex.search(query); - var results = []; - hits.forEach(function (hit) { - var item = searchData[hit.ref]; - results.push({ 'href': item.href, 'title': item.title, 'keywords': item.keywords }); - }); - handleSearchResults(results); - }); - } - function webWorkerSearch() { - console.log("using Web Worker"); var indexReady = $.Deferred(); + var worker = new Worker(relHref + 'styles/search-worker.min.js'); + worker.onerror = function (oEvent) { + console.error('Error occurred at search-worker. message: ' + oEvent.message); + } + worker.onmessage = function (oEvent) { switch (oEvent.data.e) { case 'index-ready': @@ -232,7 +194,7 @@ $(function () { // Highlight the searching keywords function highlightKeywords() { var q = url('?q'); - if (q !== null) { + if (q) { var keywords = q.split("%20"); keywords.forEach(function (keyword) { if (keyword !== "") { @@ -251,7 +213,7 @@ $(function () { $('#search-query').keyup(function () { query = $(this).val(); - if (query.length < 3) { + if (query === '') { flipContents("show"); } else { flipContents("hide"); @@ -288,6 +250,9 @@ $(function () { } function extractContentBrief(content) { + if (!content) { + return + } var briefOffset = 512; var words = query.split(/\s+/g); var queryIndex = content.indexOf(words[0]); @@ -306,7 +271,7 @@ $(function () { pagination.removeData("twbs-pagination"); if (hits.length === 0) { $('#search-results>.sr-items').html('

No results found

'); - } else { + } else { pagination.twbsPagination({ first: pagination.data('first'), prev: pagination.data('prev'), @@ -323,10 +288,10 @@ $(function () { var itemRawHref = relativeUrlToAbsoluteUrl(currentUrl, relHref + hit.href); var itemHref = relHref + hit.href + "?q=" + query; var itemTitle = hit.title; - var itemBrief = extractContentBrief(hit.keywords); + var itemBrief = extractContentBrief(hit.summary || ''); var itemNode = $('
').attr('class', 'sr-item'); - var itemTitleNode = $('
').attr('class', 'item-title').append($('').attr('href', itemHref).attr("target", "_blank").text(itemTitle)); + var itemTitleNode = $('
').attr('class', 'item-title').append($('').attr('href', itemHref).attr("target", "_blank").attr("rel", "noopener noreferrer").text(itemTitle)); var itemHrefNode = $('
').attr('class', 'item-href').text(itemRawHref); var itemBriefNode = $('
').attr('class', 'item-brief').text(itemBrief); itemNode.append(itemTitleNode).append(itemHrefNode).append(itemBriefNode); @@ -354,7 +319,7 @@ $(function () { renderBreadcrumb(); showSearch(); } - + function showSearch() { if ($('#search-results').length !== 0) { $('#search').show(); @@ -379,7 +344,7 @@ $(function () { navrel = navbarPath.substr(0, index + 1); } $('#navbar>ul').addClass('navbar-nav'); - var currentAbsPath = util.getAbsolutePath(window.location.pathname); + var currentAbsPath = util.getCurrentWindowAbsolutePath(); // set active item $('#navbar').find('a[href]').each(function (i, e) { var href = $(e).attr("href"); @@ -443,7 +408,7 @@ $(function () { function registerTocEvents() { var tocFilterInput = $('#toc_filter_input'); var tocFilterClearButton = $('#toc_filter_clear'); - + $('.toc .nav > li > .expand-stub').click(function (e) { $(e.target).parent().toggleClass(expanded); }); @@ -477,7 +442,7 @@ $(function () { parent.removeClass(show); parent.removeClass(filtered); }) - + // Get leaf nodes $('#toc li>a').filter(function (i, e) { return $(e).siblings().length === 0 @@ -518,7 +483,7 @@ $(function () { return false; } }); - + // toc filter clear button tocFilterClearButton.hide(); tocFilterClearButton.on("click", function(e){ @@ -556,7 +521,10 @@ $(function () { if (index > -1) { tocrel = tocPath.substr(0, index + 1); } - var currentHref = util.getAbsolutePath(window.location.pathname); + var currentHref = util.getCurrentWindowAbsolutePath(); + if(!currentHref.endsWith('.html')) { + currentHref += '.html'; + } $('#sidetoc').find('a[href]').each(function (i, e) { var href = $(e).attr("href"); if (util.isRelativePath(href)) { @@ -987,7 +955,7 @@ $(function () { } function readTabsQueryStringParam() { - var qs = parseQueryString(); + var qs = parseQueryString(window.location.search); var t = qs.tabs; if (t === undefined || t === '') { return []; @@ -996,7 +964,7 @@ $(function () { } function updateTabsQueryStringParam(state) { - var qs = parseQueryString(); + var qs = parseQueryString(window.location.search); qs.tabs = state.selectedTabs.join(); var url = location.protocol + "//" + location.host + location.pathname + "?" + toQueryString(qs) + location.hash; if (location.href === url) { @@ -1054,14 +1022,25 @@ $(function () { this.getAbsolutePath = getAbsolutePath; this.isRelativePath = isRelativePath; this.isAbsolutePath = isAbsolutePath; + this.getCurrentWindowAbsolutePath = getCurrentWindowAbsolutePath; this.getDirectory = getDirectory; this.formList = formList; function getAbsolutePath(href) { - // Use anchor to normalize href - var anchor = $('')[0]; - // Ignore protocal, remove search and query - return anchor.host + anchor.pathname; + if (isAbsolutePath(href)) return href; + var currentAbsPath = getCurrentWindowAbsolutePath(); + var stack = currentAbsPath.split("/"); + stack.pop(); + var parts = href.split("/"); + for (var i=0; i< parts.length; i++) { + if (parts[i] == ".") continue; + if (parts[i] == ".." && stack.length > 0) + stack.pop(); + else + stack.push(parts[i]); + } + var p = stack.join("/"); + return p; } function isRelativePath(href) { @@ -1075,6 +1054,9 @@ $(function () { return (/^(?:[a-z]+:)?\/\//i).test(href); } + function getCurrentWindowAbsolutePath() { + return window.location.origin + window.location.pathname; + } function getDirectory(href) { if (!href) return ''; var index = href.lastIndexOf('/'); @@ -1126,7 +1108,7 @@ $(function () { * If the jQuery element contains tags, this function will not change the element. */ $.fn.breakWord = function () { - if (this.html() == this.text()) { + if (!this.html().match(/(<\w*)((\s\/>)|(.*<\/\w*>))/g)) { this.html(function (index, text) { return breakPlainText(text); }) diff --git a/RWSTemplate/styles/docfx.vendor.min.css b/RWSTemplate/styles/docfx.vendor.min.css new file mode 100644 index 0000000..c19c2f9 --- /dev/null +++ b/RWSTemplate/styles/docfx.vendor.min.css @@ -0,0 +1,25 @@ +html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:none;text-decoration:underline;-webkit-text-decoration:underline dotted;-moz-text-decoration:underline dotted;text-decoration:underline dotted}b,strong{font-weight:700}dfn{font-style:italic}h1{font-size:2em;margin:.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-.5em}sub{bottom:-.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type=checkbox],input[type=radio]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:0}input[type=number]::-webkit-inner-spin-button,input[type=number]::-webkit-outer-spin-button{height:auto}input[type=search]{-webkit-appearance:textfield;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box}input[type=search]::-webkit-search-cancel-button,input[type=search]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:.35em .625em .75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:700}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}@media print{*,*:before,*:after{color:#000!important;text-shadow:none!important;background:transparent!important;-webkit-box-shadow:none!important;box-shadow:none!important}a,a:visited{text-decoration:underline}a[href]:after{content:" (" attr(href) ")"}abbr[title]:after{content:" (" attr(title) ")"}a[href^="#"]:after,a[href^="javascript:"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100%!important}p,h2,h3{orphans:3;widows:3}h2,h3{page-break-after:avoid}.navbar{display:none}.btn>.caret,.dropup>.btn>.caret{border-top-color:#000!important}.label{border:1px solid #000}.table{border-collapse:collapse!important}.table td,.table th{background-color:#fff!important}.table-bordered th,.table-bordered td{border:1px solid #ddd!important}}@font-face{font-family:Glyphicons Halflings;src:url("./glyphicons-halflings-regular-PIHUWCJO.eot");src:url("./glyphicons-halflings-regular-PIHUWCJO.eot?#iefix") format("embedded-opentype"),url("./glyphicons-halflings-regular-W4DYDFZM.woff2") format("woff2"),url("./glyphicons-halflings-regular-JOUF32XT.woff") format("woff"),url("./glyphicons-halflings-regular-ACNUA6UY.ttf") format("truetype"),url("./glyphicons-halflings-regular-QXYEM3FU.svg#glyphicons_halflingsregular") format("svg")}.glyphicon{position:relative;top:1px;display:inline-block;font-family:Glyphicons Halflings;font-style:normal;font-weight:400;line-height:1;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}.glyphicon-asterisk:before{content:"*"}.glyphicon-plus:before{content:"+"}.glyphicon-euro:before,.glyphicon-eur:before{content:"\20ac"}.glyphicon-minus:before{content:"\2212"}.glyphicon-cloud:before{content:"\2601"}.glyphicon-envelope:before{content:"\2709"}.glyphicon-pencil:before{content:"\270f"}.glyphicon-glass:before{content:"\e001"}.glyphicon-music:before{content:"\e002"}.glyphicon-search:before{content:"\e003"}.glyphicon-heart:before{content:"\e005"}.glyphicon-star:before{content:"\e006"}.glyphicon-star-empty:before{content:"\e007"}.glyphicon-user:before{content:"\e008"}.glyphicon-film:before{content:"\e009"}.glyphicon-th-large:before{content:"\e010"}.glyphicon-th:before{content:"\e011"}.glyphicon-th-list:before{content:"\e012"}.glyphicon-ok:before{content:"\e013"}.glyphicon-remove:before{content:"\e014"}.glyphicon-zoom-in:before{content:"\e015"}.glyphicon-zoom-out:before{content:"\e016"}.glyphicon-off:before{content:"\e017"}.glyphicon-signal:before{content:"\e018"}.glyphicon-cog:before{content:"\e019"}.glyphicon-trash:before{content:"\e020"}.glyphicon-home:before{content:"\e021"}.glyphicon-file:before{content:"\e022"}.glyphicon-time:before{content:"\e023"}.glyphicon-road:before{content:"\e024"}.glyphicon-download-alt:before{content:"\e025"}.glyphicon-download:before{content:"\e026"}.glyphicon-upload:before{content:"\e027"}.glyphicon-inbox:before{content:"\e028"}.glyphicon-play-circle:before{content:"\e029"}.glyphicon-repeat:before{content:"\e030"}.glyphicon-refresh:before{content:"\e031"}.glyphicon-list-alt:before{content:"\e032"}.glyphicon-lock:before{content:"\e033"}.glyphicon-flag:before{content:"\e034"}.glyphicon-headphones:before{content:"\e035"}.glyphicon-volume-off:before{content:"\e036"}.glyphicon-volume-down:before{content:"\e037"}.glyphicon-volume-up:before{content:"\e038"}.glyphicon-qrcode:before{content:"\e039"}.glyphicon-barcode:before{content:"\e040"}.glyphicon-tag:before{content:"\e041"}.glyphicon-tags:before{content:"\e042"}.glyphicon-book:before{content:"\e043"}.glyphicon-bookmark:before{content:"\e044"}.glyphicon-print:before{content:"\e045"}.glyphicon-camera:before{content:"\e046"}.glyphicon-font:before{content:"\e047"}.glyphicon-bold:before{content:"\e048"}.glyphicon-italic:before{content:"\e049"}.glyphicon-text-height:before{content:"\e050"}.glyphicon-text-width:before{content:"\e051"}.glyphicon-align-left:before{content:"\e052"}.glyphicon-align-center:before{content:"\e053"}.glyphicon-align-right:before{content:"\e054"}.glyphicon-align-justify:before{content:"\e055"}.glyphicon-list:before{content:"\e056"}.glyphicon-indent-left:before{content:"\e057"}.glyphicon-indent-right:before{content:"\e058"}.glyphicon-facetime-video:before{content:"\e059"}.glyphicon-picture:before{content:"\e060"}.glyphicon-map-marker:before{content:"\e062"}.glyphicon-adjust:before{content:"\e063"}.glyphicon-tint:before{content:"\e064"}.glyphicon-edit:before{content:"\e065"}.glyphicon-share:before{content:"\e066"}.glyphicon-check:before{content:"\e067"}.glyphicon-move:before{content:"\e068"}.glyphicon-step-backward:before{content:"\e069"}.glyphicon-fast-backward:before{content:"\e070"}.glyphicon-backward:before{content:"\e071"}.glyphicon-play:before{content:"\e072"}.glyphicon-pause:before{content:"\e073"}.glyphicon-stop:before{content:"\e074"}.glyphicon-forward:before{content:"\e075"}.glyphicon-fast-forward:before{content:"\e076"}.glyphicon-step-forward:before{content:"\e077"}.glyphicon-eject:before{content:"\e078"}.glyphicon-chevron-left:before{content:"\e079"}.glyphicon-chevron-right:before{content:"\e080"}.glyphicon-plus-sign:before{content:"\e081"}.glyphicon-minus-sign:before{content:"\e082"}.glyphicon-remove-sign:before{content:"\e083"}.glyphicon-ok-sign:before{content:"\e084"}.glyphicon-question-sign:before{content:"\e085"}.glyphicon-info-sign:before{content:"\e086"}.glyphicon-screenshot:before{content:"\e087"}.glyphicon-remove-circle:before{content:"\e088"}.glyphicon-ok-circle:before{content:"\e089"}.glyphicon-ban-circle:before{content:"\e090"}.glyphicon-arrow-left:before{content:"\e091"}.glyphicon-arrow-right:before{content:"\e092"}.glyphicon-arrow-up:before{content:"\e093"}.glyphicon-arrow-down:before{content:"\e094"}.glyphicon-share-alt:before{content:"\e095"}.glyphicon-resize-full:before{content:"\e096"}.glyphicon-resize-small:before{content:"\e097"}.glyphicon-exclamation-sign:before{content:"\e101"}.glyphicon-gift:before{content:"\e102"}.glyphicon-leaf:before{content:"\e103"}.glyphicon-fire:before{content:"\e104"}.glyphicon-eye-open:before{content:"\e105"}.glyphicon-eye-close:before{content:"\e106"}.glyphicon-warning-sign:before{content:"\e107"}.glyphicon-plane:before{content:"\e108"}.glyphicon-calendar:before{content:"\e109"}.glyphicon-random:before{content:"\e110"}.glyphicon-comment:before{content:"\e111"}.glyphicon-magnet:before{content:"\e112"}.glyphicon-chevron-up:before{content:"\e113"}.glyphicon-chevron-down:before{content:"\e114"}.glyphicon-retweet:before{content:"\e115"}.glyphicon-shopping-cart:before{content:"\e116"}.glyphicon-folder-close:before{content:"\e117"}.glyphicon-folder-open:before{content:"\e118"}.glyphicon-resize-vertical:before{content:"\e119"}.glyphicon-resize-horizontal:before{content:"\e120"}.glyphicon-hdd:before{content:"\e121"}.glyphicon-bullhorn:before{content:"\e122"}.glyphicon-bell:before{content:"\e123"}.glyphicon-certificate:before{content:"\e124"}.glyphicon-thumbs-up:before{content:"\e125"}.glyphicon-thumbs-down:before{content:"\e126"}.glyphicon-hand-right:before{content:"\e127"}.glyphicon-hand-left:before{content:"\e128"}.glyphicon-hand-up:before{content:"\e129"}.glyphicon-hand-down:before{content:"\e130"}.glyphicon-circle-arrow-right:before{content:"\e131"}.glyphicon-circle-arrow-left:before{content:"\e132"}.glyphicon-circle-arrow-up:before{content:"\e133"}.glyphicon-circle-arrow-down:before{content:"\e134"}.glyphicon-globe:before{content:"\e135"}.glyphicon-wrench:before{content:"\e136"}.glyphicon-tasks:before{content:"\e137"}.glyphicon-filter:before{content:"\e138"}.glyphicon-briefcase:before{content:"\e139"}.glyphicon-fullscreen:before{content:"\e140"}.glyphicon-dashboard:before{content:"\e141"}.glyphicon-paperclip:before{content:"\e142"}.glyphicon-heart-empty:before{content:"\e143"}.glyphicon-link:before{content:"\e144"}.glyphicon-phone:before{content:"\e145"}.glyphicon-pushpin:before{content:"\e146"}.glyphicon-usd:before{content:"\e148"}.glyphicon-gbp:before{content:"\e149"}.glyphicon-sort:before{content:"\e150"}.glyphicon-sort-by-alphabet:before{content:"\e151"}.glyphicon-sort-by-alphabet-alt:before{content:"\e152"}.glyphicon-sort-by-order:before{content:"\e153"}.glyphicon-sort-by-order-alt:before{content:"\e154"}.glyphicon-sort-by-attributes:before{content:"\e155"}.glyphicon-sort-by-attributes-alt:before{content:"\e156"}.glyphicon-unchecked:before{content:"\e157"}.glyphicon-expand:before{content:"\e158"}.glyphicon-collapse-down:before{content:"\e159"}.glyphicon-collapse-up:before{content:"\e160"}.glyphicon-log-in:before{content:"\e161"}.glyphicon-flash:before{content:"\e162"}.glyphicon-log-out:before{content:"\e163"}.glyphicon-new-window:before{content:"\e164"}.glyphicon-record:before{content:"\e165"}.glyphicon-save:before{content:"\e166"}.glyphicon-open:before{content:"\e167"}.glyphicon-saved:before{content:"\e168"}.glyphicon-import:before{content:"\e169"}.glyphicon-export:before{content:"\e170"}.glyphicon-send:before{content:"\e171"}.glyphicon-floppy-disk:before{content:"\e172"}.glyphicon-floppy-saved:before{content:"\e173"}.glyphicon-floppy-remove:before{content:"\e174"}.glyphicon-floppy-save:before{content:"\e175"}.glyphicon-floppy-open:before{content:"\e176"}.glyphicon-credit-card:before{content:"\e177"}.glyphicon-transfer:before{content:"\e178"}.glyphicon-cutlery:before{content:"\e179"}.glyphicon-header:before{content:"\e180"}.glyphicon-compressed:before{content:"\e181"}.glyphicon-earphone:before{content:"\e182"}.glyphicon-phone-alt:before{content:"\e183"}.glyphicon-tower:before{content:"\e184"}.glyphicon-stats:before{content:"\e185"}.glyphicon-sd-video:before{content:"\e186"}.glyphicon-hd-video:before{content:"\e187"}.glyphicon-subtitles:before{content:"\e188"}.glyphicon-sound-stereo:before{content:"\e189"}.glyphicon-sound-dolby:before{content:"\e190"}.glyphicon-sound-5-1:before{content:"\e191"}.glyphicon-sound-6-1:before{content:"\e192"}.glyphicon-sound-7-1:before{content:"\e193"}.glyphicon-copyright-mark:before{content:"\e194"}.glyphicon-registration-mark:before{content:"\e195"}.glyphicon-cloud-download:before{content:"\e197"}.glyphicon-cloud-upload:before{content:"\e198"}.glyphicon-tree-conifer:before{content:"\e199"}.glyphicon-tree-deciduous:before{content:"\e200"}.glyphicon-cd:before{content:"\e201"}.glyphicon-save-file:before{content:"\e202"}.glyphicon-open-file:before{content:"\e203"}.glyphicon-level-up:before{content:"\e204"}.glyphicon-copy:before{content:"\e205"}.glyphicon-paste:before{content:"\e206"}.glyphicon-alert:before{content:"\e209"}.glyphicon-equalizer:before{content:"\e210"}.glyphicon-king:before{content:"\e211"}.glyphicon-queen:before{content:"\e212"}.glyphicon-pawn:before{content:"\e213"}.glyphicon-bishop:before{content:"\e214"}.glyphicon-knight:before{content:"\e215"}.glyphicon-baby-formula:before{content:"\e216"}.glyphicon-tent:before{content:"\26fa"}.glyphicon-blackboard:before{content:"\e218"}.glyphicon-bed:before{content:"\e219"}.glyphicon-apple:before{content:"\f8ff"}.glyphicon-erase:before{content:"\e221"}.glyphicon-hourglass:before{content:"\231b"}.glyphicon-lamp:before{content:"\e223"}.glyphicon-duplicate:before{content:"\e224"}.glyphicon-piggy-bank:before{content:"\e225"}.glyphicon-scissors:before{content:"\e226"}.glyphicon-bitcoin:before{content:"\e227"}.glyphicon-btc:before{content:"\e227"}.glyphicon-xbt:before{content:"\e227"}.glyphicon-yen:before{content:"\a5"}.glyphicon-jpy:before{content:"\a5"}.glyphicon-ruble:before{content:"\20bd"}.glyphicon-rub:before{content:"\20bd"}.glyphicon-scale:before{content:"\e230"}.glyphicon-ice-lolly:before{content:"\e231"}.glyphicon-ice-lolly-tasted:before{content:"\e232"}.glyphicon-education:before{content:"\e233"}.glyphicon-option-horizontal:before{content:"\e234"}.glyphicon-option-vertical:before{content:"\e235"}.glyphicon-menu-hamburger:before{content:"\e236"}.glyphicon-modal-window:before{content:"\e237"}.glyphicon-oil:before{content:"\e238"}.glyphicon-grain:before{content:"\e239"}.glyphicon-sunglasses:before{content:"\e240"}.glyphicon-text-size:before{content:"\e241"}.glyphicon-text-color:before{content:"\e242"}.glyphicon-text-background:before{content:"\e243"}.glyphicon-object-align-top:before{content:"\e244"}.glyphicon-object-align-bottom:before{content:"\e245"}.glyphicon-object-align-horizontal:before{content:"\e246"}.glyphicon-object-align-left:before{content:"\e247"}.glyphicon-object-align-vertical:before{content:"\e248"}.glyphicon-object-align-right:before{content:"\e249"}.glyphicon-triangle-right:before{content:"\e250"}.glyphicon-triangle-left:before{content:"\e251"}.glyphicon-triangle-bottom:before{content:"\e252"}.glyphicon-triangle-top:before{content:"\e253"}.glyphicon-console:before{content:"\e254"}.glyphicon-superscript:before{content:"\e255"}.glyphicon-subscript:before{content:"\e256"}.glyphicon-menu-left:before{content:"\e257"}.glyphicon-menu-right:before{content:"\e258"}.glyphicon-menu-down:before{content:"\e259"}.glyphicon-menu-up:before{content:"\e260"}*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}*:before,*:after{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}html{font-size:10px;-webkit-tap-highlight-color:rgba(0,0,0,0)}body{font-family:Helvetica Neue,Helvetica,Arial,sans-serif;font-size:14px;line-height:1.42857143;color:#333;background-color:#fff}input,button,select,textarea{font-family:inherit;font-size:inherit;line-height:inherit}a{color:#337ab7;text-decoration:none}a:hover,a:focus{color:#23527c;text-decoration:underline}a:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}figure{margin:0}img{vertical-align:middle}.img-responsive,.thumbnail>img,.thumbnail a>img,.carousel-inner>.item>img,.carousel-inner>.item>a>img{display:block;max-width:100%;height:auto}.img-rounded{border-radius:6px}.img-thumbnail{padding:4px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:all .2s ease-in-out;-o-transition:all .2s ease-in-out;transition:all .2s ease-in-out;display:inline-block;max-width:100%;height:auto}.img-circle{border-radius:50%}hr{margin-top:20px;margin-bottom:20px;border:0;border-top:1px solid #eeeeee}.sr-only{position:absolute;width:1px;height:1px;padding:0;margin:-1px;overflow:hidden;clip:rect(0,0,0,0);border:0}.sr-only-focusable:active,.sr-only-focusable:focus{position:static;width:auto;height:auto;margin:0;overflow:visible;clip:auto}[role=button]{cursor:pointer}h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6{font-family:inherit;font-weight:500;line-height:1.1;color:inherit}h1 small,h2 small,h3 small,h4 small,h5 small,h6 small,.h1 small,.h2 small,.h3 small,.h4 small,.h5 small,.h6 small,h1 .small,h2 .small,h3 .small,h4 .small,h5 .small,h6 .small,.h1 .small,.h2 .small,.h3 .small,.h4 .small,.h5 .small,.h6 .small{font-weight:400;line-height:1;color:#777}h1,.h1,h2,.h2,h3,.h3{margin-top:20px;margin-bottom:10px}h1 small,.h1 small,h2 small,.h2 small,h3 small,.h3 small,h1 .small,.h1 .small,h2 .small,.h2 .small,h3 .small,.h3 .small{font-size:65%}h4,.h4,h5,.h5,h6,.h6{margin-top:10px;margin-bottom:10px}h4 small,.h4 small,h5 small,.h5 small,h6 small,.h6 small,h4 .small,.h4 .small,h5 .small,.h5 .small,h6 .small,.h6 .small{font-size:75%}h1,.h1{font-size:36px}h2,.h2{font-size:30px}h3,.h3{font-size:24px}h4,.h4{font-size:18px}h5,.h5{font-size:14px}h6,.h6{font-size:12px}p{margin:0 0 10px}.lead{margin-bottom:20px;font-size:16px;font-weight:300;line-height:1.4}@media (min-width: 768px){.lead{font-size:21px}}small,.small{font-size:85%}mark,.mark{padding:.2em;background-color:#fcf8e3}.text-left{text-align:left}.text-right{text-align:right}.text-center{text-align:center}.text-justify{text-align:justify}.text-nowrap{white-space:nowrap}.text-lowercase{text-transform:lowercase}.text-uppercase{text-transform:uppercase}.text-capitalize{text-transform:capitalize}.text-muted{color:#777}.text-primary{color:#337ab7}a.text-primary:hover,a.text-primary:focus{color:#286090}.text-success{color:#3c763d}a.text-success:hover,a.text-success:focus{color:#2b542c}.text-info{color:#31708f}a.text-info:hover,a.text-info:focus{color:#245269}.text-warning{color:#8a6d3b}a.text-warning:hover,a.text-warning:focus{color:#66512c}.text-danger{color:#a94442}a.text-danger:hover,a.text-danger:focus{color:#843534}.bg-primary{color:#fff;background-color:#337ab7}a.bg-primary:hover,a.bg-primary:focus{background-color:#286090}.bg-success{background-color:#dff0d8}a.bg-success:hover,a.bg-success:focus{background-color:#c1e2b3}.bg-info{background-color:#d9edf7}a.bg-info:hover,a.bg-info:focus{background-color:#afd9ee}.bg-warning{background-color:#fcf8e3}a.bg-warning:hover,a.bg-warning:focus{background-color:#f7ecb5}.bg-danger{background-color:#f2dede}a.bg-danger:hover,a.bg-danger:focus{background-color:#e4b9b9}.page-header{padding-bottom:9px;margin:40px 0 20px;border-bottom:1px solid #eeeeee}ul,ol{margin-top:0;margin-bottom:10px}ul ul,ol ul,ul ol,ol ol{margin-bottom:0}.list-unstyled{padding-left:0;list-style:none}.list-inline{padding-left:0;list-style:none;margin-left:-5px}.list-inline>li{display:inline-block;padding-right:5px;padding-left:5px}dl{margin-top:0;margin-bottom:20px}dt,dd{line-height:1.42857143}dt{font-weight:700}dd{margin-left:0}@media (min-width: 768px){.dl-horizontal dt{float:left;width:160px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}.dl-horizontal dd{margin-left:180px}}abbr[title],abbr[data-original-title]{cursor:help}.initialism{font-size:90%;text-transform:uppercase}blockquote{padding:10px 20px;margin:0 0 20px;font-size:17.5px;border-left:5px solid #eeeeee}blockquote p:last-child,blockquote ul:last-child,blockquote ol:last-child{margin-bottom:0}blockquote footer,blockquote small,blockquote .small{display:block;font-size:80%;line-height:1.42857143;color:#777}blockquote footer:before,blockquote small:before,blockquote .small:before{content:"\2014\a0"}.blockquote-reverse,blockquote.pull-right{padding-right:15px;padding-left:0;text-align:right;border-right:5px solid #eeeeee;border-left:0}.blockquote-reverse footer:before,blockquote.pull-right footer:before,.blockquote-reverse small:before,blockquote.pull-right small:before,.blockquote-reverse .small:before,blockquote.pull-right .small:before{content:""}.blockquote-reverse footer:after,blockquote.pull-right footer:after,.blockquote-reverse small:after,blockquote.pull-right small:after,.blockquote-reverse .small:after,blockquote.pull-right .small:after{content:"\a0\2014"}address{margin-bottom:20px;font-style:normal;line-height:1.42857143}code,kbd,pre,samp{font-family:Menlo,Monaco,Consolas,Courier New,monospace}code{padding:2px 4px;font-size:90%;color:#c7254e;background-color:#f9f2f4;border-radius:4px}kbd{padding:2px 4px;font-size:90%;color:#fff;background-color:#333;border-radius:3px;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.25);box-shadow:inset 0 -1px #00000040}kbd kbd{padding:0;font-size:100%;font-weight:700;-webkit-box-shadow:none;box-shadow:none}pre{display:block;padding:9.5px;margin:0 0 10px;font-size:13px;line-height:1.42857143;color:#333;word-break:break-all;word-wrap:break-word;background-color:#f5f5f5;border:1px solid #ccc;border-radius:4px}pre code{padding:0;font-size:inherit;color:inherit;white-space:pre-wrap;background-color:transparent;border-radius:0}.pre-scrollable{max-height:340px;overflow-y:scroll}.container{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}@media (min-width: 768px){.container{width:750px}}@media (min-width: 992px){.container{width:970px}}@media (min-width: 1200px){.container{width:1170px}}.container-fluid{padding-right:15px;padding-left:15px;margin-right:auto;margin-left:auto}.row{margin-right:-15px;margin-left:-15px}.row-no-gutters{margin-right:0;margin-left:0}.row-no-gutters [class*=col-]{padding-right:0;padding-left:0}.col-xs-1,.col-sm-1,.col-md-1,.col-lg-1,.col-xs-2,.col-sm-2,.col-md-2,.col-lg-2,.col-xs-3,.col-sm-3,.col-md-3,.col-lg-3,.col-xs-4,.col-sm-4,.col-md-4,.col-lg-4,.col-xs-5,.col-sm-5,.col-md-5,.col-lg-5,.col-xs-6,.col-sm-6,.col-md-6,.col-lg-6,.col-xs-7,.col-sm-7,.col-md-7,.col-lg-7,.col-xs-8,.col-sm-8,.col-md-8,.col-lg-8,.col-xs-9,.col-sm-9,.col-md-9,.col-lg-9,.col-xs-10,.col-sm-10,.col-md-10,.col-lg-10,.col-xs-11,.col-sm-11,.col-md-11,.col-lg-11,.col-xs-12,.col-sm-12,.col-md-12,.col-lg-12{position:relative;min-height:1px;padding-right:15px;padding-left:15px}.col-xs-1,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9,.col-xs-10,.col-xs-11,.col-xs-12{float:left}.col-xs-12{width:100%}.col-xs-11{width:91.66666667%}.col-xs-10{width:83.33333333%}.col-xs-9{width:75%}.col-xs-8{width:66.66666667%}.col-xs-7{width:58.33333333%}.col-xs-6{width:50%}.col-xs-5{width:41.66666667%}.col-xs-4{width:33.33333333%}.col-xs-3{width:25%}.col-xs-2{width:16.66666667%}.col-xs-1{width:8.33333333%}.col-xs-pull-12{right:100%}.col-xs-pull-11{right:91.66666667%}.col-xs-pull-10{right:83.33333333%}.col-xs-pull-9{right:75%}.col-xs-pull-8{right:66.66666667%}.col-xs-pull-7{right:58.33333333%}.col-xs-pull-6{right:50%}.col-xs-pull-5{right:41.66666667%}.col-xs-pull-4{right:33.33333333%}.col-xs-pull-3{right:25%}.col-xs-pull-2{right:16.66666667%}.col-xs-pull-1{right:8.33333333%}.col-xs-pull-0{right:auto}.col-xs-push-12{left:100%}.col-xs-push-11{left:91.66666667%}.col-xs-push-10{left:83.33333333%}.col-xs-push-9{left:75%}.col-xs-push-8{left:66.66666667%}.col-xs-push-7{left:58.33333333%}.col-xs-push-6{left:50%}.col-xs-push-5{left:41.66666667%}.col-xs-push-4{left:33.33333333%}.col-xs-push-3{left:25%}.col-xs-push-2{left:16.66666667%}.col-xs-push-1{left:8.33333333%}.col-xs-push-0{left:auto}.col-xs-offset-12{margin-left:100%}.col-xs-offset-11{margin-left:91.66666667%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-0{margin-left:0%}@media (min-width: 768px){.col-sm-1,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-10,.col-sm-11,.col-sm-12{float:left}.col-sm-12{width:100%}.col-sm-11{width:91.66666667%}.col-sm-10{width:83.33333333%}.col-sm-9{width:75%}.col-sm-8{width:66.66666667%}.col-sm-7{width:58.33333333%}.col-sm-6{width:50%}.col-sm-5{width:41.66666667%}.col-sm-4{width:33.33333333%}.col-sm-3{width:25%}.col-sm-2{width:16.66666667%}.col-sm-1{width:8.33333333%}.col-sm-pull-12{right:100%}.col-sm-pull-11{right:91.66666667%}.col-sm-pull-10{right:83.33333333%}.col-sm-pull-9{right:75%}.col-sm-pull-8{right:66.66666667%}.col-sm-pull-7{right:58.33333333%}.col-sm-pull-6{right:50%}.col-sm-pull-5{right:41.66666667%}.col-sm-pull-4{right:33.33333333%}.col-sm-pull-3{right:25%}.col-sm-pull-2{right:16.66666667%}.col-sm-pull-1{right:8.33333333%}.col-sm-pull-0{right:auto}.col-sm-push-12{left:100%}.col-sm-push-11{left:91.66666667%}.col-sm-push-10{left:83.33333333%}.col-sm-push-9{left:75%}.col-sm-push-8{left:66.66666667%}.col-sm-push-7{left:58.33333333%}.col-sm-push-6{left:50%}.col-sm-push-5{left:41.66666667%}.col-sm-push-4{left:33.33333333%}.col-sm-push-3{left:25%}.col-sm-push-2{left:16.66666667%}.col-sm-push-1{left:8.33333333%}.col-sm-push-0{left:auto}.col-sm-offset-12{margin-left:100%}.col-sm-offset-11{margin-left:91.66666667%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-0{margin-left:0%}}@media (min-width: 992px){.col-md-1,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-10,.col-md-11,.col-md-12{float:left}.col-md-12{width:100%}.col-md-11{width:91.66666667%}.col-md-10{width:83.33333333%}.col-md-9{width:75%}.col-md-8{width:66.66666667%}.col-md-7{width:58.33333333%}.col-md-6{width:50%}.col-md-5{width:41.66666667%}.col-md-4{width:33.33333333%}.col-md-3{width:25%}.col-md-2{width:16.66666667%}.col-md-1{width:8.33333333%}.col-md-pull-12{right:100%}.col-md-pull-11{right:91.66666667%}.col-md-pull-10{right:83.33333333%}.col-md-pull-9{right:75%}.col-md-pull-8{right:66.66666667%}.col-md-pull-7{right:58.33333333%}.col-md-pull-6{right:50%}.col-md-pull-5{right:41.66666667%}.col-md-pull-4{right:33.33333333%}.col-md-pull-3{right:25%}.col-md-pull-2{right:16.66666667%}.col-md-pull-1{right:8.33333333%}.col-md-pull-0{right:auto}.col-md-push-12{left:100%}.col-md-push-11{left:91.66666667%}.col-md-push-10{left:83.33333333%}.col-md-push-9{left:75%}.col-md-push-8{left:66.66666667%}.col-md-push-7{left:58.33333333%}.col-md-push-6{left:50%}.col-md-push-5{left:41.66666667%}.col-md-push-4{left:33.33333333%}.col-md-push-3{left:25%}.col-md-push-2{left:16.66666667%}.col-md-push-1{left:8.33333333%}.col-md-push-0{left:auto}.col-md-offset-12{margin-left:100%}.col-md-offset-11{margin-left:91.66666667%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-9{margin-left:75%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-6{margin-left:50%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-3{margin-left:25%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-0{margin-left:0%}}@media (min-width: 1200px){.col-lg-1,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-10,.col-lg-11,.col-lg-12{float:left}.col-lg-12{width:100%}.col-lg-11{width:91.66666667%}.col-lg-10{width:83.33333333%}.col-lg-9{width:75%}.col-lg-8{width:66.66666667%}.col-lg-7{width:58.33333333%}.col-lg-6{width:50%}.col-lg-5{width:41.66666667%}.col-lg-4{width:33.33333333%}.col-lg-3{width:25%}.col-lg-2{width:16.66666667%}.col-lg-1{width:8.33333333%}.col-lg-pull-12{right:100%}.col-lg-pull-11{right:91.66666667%}.col-lg-pull-10{right:83.33333333%}.col-lg-pull-9{right:75%}.col-lg-pull-8{right:66.66666667%}.col-lg-pull-7{right:58.33333333%}.col-lg-pull-6{right:50%}.col-lg-pull-5{right:41.66666667%}.col-lg-pull-4{right:33.33333333%}.col-lg-pull-3{right:25%}.col-lg-pull-2{right:16.66666667%}.col-lg-pull-1{right:8.33333333%}.col-lg-pull-0{right:auto}.col-lg-push-12{left:100%}.col-lg-push-11{left:91.66666667%}.col-lg-push-10{left:83.33333333%}.col-lg-push-9{left:75%}.col-lg-push-8{left:66.66666667%}.col-lg-push-7{left:58.33333333%}.col-lg-push-6{left:50%}.col-lg-push-5{left:41.66666667%}.col-lg-push-4{left:33.33333333%}.col-lg-push-3{left:25%}.col-lg-push-2{left:16.66666667%}.col-lg-push-1{left:8.33333333%}.col-lg-push-0{left:auto}.col-lg-offset-12{margin-left:100%}.col-lg-offset-11{margin-left:91.66666667%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-0{margin-left:0%}}table{background-color:transparent}table col[class*=col-]{position:static;display:table-column;float:none}table td[class*=col-],table th[class*=col-]{position:static;display:table-cell;float:none}caption{padding-top:8px;padding-bottom:8px;color:#777;text-align:left}th{text-align:left}.table{width:100%;max-width:100%;margin-bottom:20px}.table>thead>tr>th,.table>tbody>tr>th,.table>tfoot>tr>th,.table>thead>tr>td,.table>tbody>tr>td,.table>tfoot>tr>td{padding:8px;line-height:1.42857143;vertical-align:top;border-top:1px solid #ddd}.table>thead>tr>th{vertical-align:bottom;border-bottom:2px solid #ddd}.table>caption+thead>tr:first-child>th,.table>colgroup+thead>tr:first-child>th,.table>thead:first-child>tr:first-child>th,.table>caption+thead>tr:first-child>td,.table>colgroup+thead>tr:first-child>td,.table>thead:first-child>tr:first-child>td{border-top:0}.table>tbody+tbody{border-top:2px solid #ddd}.table .table{background-color:#fff}.table-condensed>thead>tr>th,.table-condensed>tbody>tr>th,.table-condensed>tfoot>tr>th,.table-condensed>thead>tr>td,.table-condensed>tbody>tr>td,.table-condensed>tfoot>tr>td{padding:5px}.table-bordered{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>tbody>tr>th,.table-bordered>tfoot>tr>th,.table-bordered>thead>tr>td,.table-bordered>tbody>tr>td,.table-bordered>tfoot>tr>td{border:1px solid #ddd}.table-bordered>thead>tr>th,.table-bordered>thead>tr>td{border-bottom-width:2px}.table-striped>tbody>tr:nth-of-type(odd){background-color:#f9f9f9}.table-hover>tbody>tr:hover{background-color:#f5f5f5}.table>thead>tr>td.active,.table>tbody>tr>td.active,.table>tfoot>tr>td.active,.table>thead>tr>th.active,.table>tbody>tr>th.active,.table>tfoot>tr>th.active,.table>thead>tr.active>td,.table>tbody>tr.active>td,.table>tfoot>tr.active>td,.table>thead>tr.active>th,.table>tbody>tr.active>th,.table>tfoot>tr.active>th{background-color:#f5f5f5}.table-hover>tbody>tr>td.active:hover,.table-hover>tbody>tr>th.active:hover,.table-hover>tbody>tr.active:hover>td,.table-hover>tbody>tr:hover>.active,.table-hover>tbody>tr.active:hover>th{background-color:#e8e8e8}.table>thead>tr>td.success,.table>tbody>tr>td.success,.table>tfoot>tr>td.success,.table>thead>tr>th.success,.table>tbody>tr>th.success,.table>tfoot>tr>th.success,.table>thead>tr.success>td,.table>tbody>tr.success>td,.table>tfoot>tr.success>td,.table>thead>tr.success>th,.table>tbody>tr.success>th,.table>tfoot>tr.success>th{background-color:#dff0d8}.table-hover>tbody>tr>td.success:hover,.table-hover>tbody>tr>th.success:hover,.table-hover>tbody>tr.success:hover>td,.table-hover>tbody>tr:hover>.success,.table-hover>tbody>tr.success:hover>th{background-color:#d0e9c6}.table>thead>tr>td.info,.table>tbody>tr>td.info,.table>tfoot>tr>td.info,.table>thead>tr>th.info,.table>tbody>tr>th.info,.table>tfoot>tr>th.info,.table>thead>tr.info>td,.table>tbody>tr.info>td,.table>tfoot>tr.info>td,.table>thead>tr.info>th,.table>tbody>tr.info>th,.table>tfoot>tr.info>th{background-color:#d9edf7}.table-hover>tbody>tr>td.info:hover,.table-hover>tbody>tr>th.info:hover,.table-hover>tbody>tr.info:hover>td,.table-hover>tbody>tr:hover>.info,.table-hover>tbody>tr.info:hover>th{background-color:#c4e3f3}.table>thead>tr>td.warning,.table>tbody>tr>td.warning,.table>tfoot>tr>td.warning,.table>thead>tr>th.warning,.table>tbody>tr>th.warning,.table>tfoot>tr>th.warning,.table>thead>tr.warning>td,.table>tbody>tr.warning>td,.table>tfoot>tr.warning>td,.table>thead>tr.warning>th,.table>tbody>tr.warning>th,.table>tfoot>tr.warning>th{background-color:#fcf8e3}.table-hover>tbody>tr>td.warning:hover,.table-hover>tbody>tr>th.warning:hover,.table-hover>tbody>tr.warning:hover>td,.table-hover>tbody>tr:hover>.warning,.table-hover>tbody>tr.warning:hover>th{background-color:#faf2cc}.table>thead>tr>td.danger,.table>tbody>tr>td.danger,.table>tfoot>tr>td.danger,.table>thead>tr>th.danger,.table>tbody>tr>th.danger,.table>tfoot>tr>th.danger,.table>thead>tr.danger>td,.table>tbody>tr.danger>td,.table>tfoot>tr.danger>td,.table>thead>tr.danger>th,.table>tbody>tr.danger>th,.table>tfoot>tr.danger>th{background-color:#f2dede}.table-hover>tbody>tr>td.danger:hover,.table-hover>tbody>tr>th.danger:hover,.table-hover>tbody>tr.danger:hover>td,.table-hover>tbody>tr:hover>.danger,.table-hover>tbody>tr.danger:hover>th{background-color:#ebcccc}.table-responsive{min-height:.01%;overflow-x:auto}@media screen and (max-width: 767px){.table-responsive{width:100%;margin-bottom:15px;overflow-y:hidden;-ms-overflow-style:-ms-autohiding-scrollbar;border:1px solid #ddd}.table-responsive>.table{margin-bottom:0}.table-responsive>.table>thead>tr>th,.table-responsive>.table>tbody>tr>th,.table-responsive>.table>tfoot>tr>th,.table-responsive>.table>thead>tr>td,.table-responsive>.table>tbody>tr>td,.table-responsive>.table>tfoot>tr>td{white-space:nowrap}.table-responsive>.table-bordered{border:0}.table-responsive>.table-bordered>thead>tr>th:first-child,.table-responsive>.table-bordered>tbody>tr>th:first-child,.table-responsive>.table-bordered>tfoot>tr>th:first-child,.table-responsive>.table-bordered>thead>tr>td:first-child,.table-responsive>.table-bordered>tbody>tr>td:first-child,.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.table-responsive>.table-bordered>thead>tr>th:last-child,.table-responsive>.table-bordered>tbody>tr>th:last-child,.table-responsive>.table-bordered>tfoot>tr>th:last-child,.table-responsive>.table-bordered>thead>tr>td:last-child,.table-responsive>.table-bordered>tbody>tr>td:last-child,.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.table-responsive>.table-bordered>tbody>tr:last-child>th,.table-responsive>.table-bordered>tfoot>tr:last-child>th,.table-responsive>.table-bordered>tbody>tr:last-child>td,.table-responsive>.table-bordered>tfoot>tr:last-child>td{border-bottom:0}}fieldset{min-width:0;padding:0;margin:0;border:0}legend{display:block;width:100%;padding:0;margin-bottom:20px;font-size:21px;line-height:inherit;color:#333;border:0;border-bottom:1px solid #e5e5e5}label{display:inline-block;max-width:100%;margin-bottom:5px;font-weight:700}input[type=search]{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;-webkit-appearance:none;-moz-appearance:none;appearance:none}input[type=radio],input[type=checkbox]{margin:4px 0 0;margin-top:1px \ ;line-height:normal}input[type=radio][disabled],input[type=checkbox][disabled],input[type=radio].disabled,input[type=checkbox].disabled,fieldset[disabled] input[type=radio],fieldset[disabled] input[type=checkbox]{cursor:not-allowed}input[type=file]{display:block}input[type=range]{display:block;width:100%}select[multiple],select[size]{height:auto}input[type=file]:focus,input[type=radio]:focus,input[type=checkbox]:focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}output{display:block;padding-top:7px;font-size:14px;line-height:1.42857143;color:#555}.form-control{display:block;width:100%;height:34px;padding:6px 12px;font-size:14px;line-height:1.42857143;color:#555;background-color:#fff;background-image:none;border:1px solid #ccc;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px #00000013;-webkit-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-o-transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;-webkit-transition:border-color ease-in-out .15s,-webkit-box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,-webkit-box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s;transition:border-color ease-in-out .15s,box-shadow ease-in-out .15s,-webkit-box-shadow ease-in-out .15s}.form-control:focus{border-color:#66afe9;outline:0;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6);box-shadow:inset 0 1px 1px #00000013,0 0 8px #66afe999}.form-control::-moz-placeholder{color:#999;opacity:1}.form-control:-ms-input-placeholder{color:#999}.form-control::-webkit-input-placeholder{color:#999}.form-control::-ms-expand{background-color:transparent;border:0}.form-control[disabled],.form-control[readonly],fieldset[disabled] .form-control{background-color:#eee;opacity:1}.form-control[disabled],fieldset[disabled] .form-control{cursor:not-allowed}textarea.form-control{height:auto}@media screen and (-webkit-min-device-pixel-ratio: 0){input[type=date].form-control,input[type=time].form-control,input[type=datetime-local].form-control,input[type=month].form-control{line-height:34px}input[type=date].input-sm,input[type=time].input-sm,input[type=datetime-local].input-sm,input[type=month].input-sm,.input-group-sm input[type=date],.input-group-sm input[type=time],.input-group-sm input[type=datetime-local],.input-group-sm input[type=month]{line-height:30px}input[type=date].input-lg,input[type=time].input-lg,input[type=datetime-local].input-lg,input[type=month].input-lg,.input-group-lg input[type=date],.input-group-lg input[type=time],.input-group-lg input[type=datetime-local],.input-group-lg input[type=month]{line-height:46px}}.form-group{margin-bottom:15px}.radio,.checkbox{position:relative;display:block;margin-top:10px;margin-bottom:10px}.radio.disabled label,.checkbox.disabled label,fieldset[disabled] .radio label,fieldset[disabled] .checkbox label{cursor:not-allowed}.radio label,.checkbox label{min-height:20px;padding-left:20px;margin-bottom:0;font-weight:400;cursor:pointer}.radio input[type=radio],.radio-inline input[type=radio],.checkbox input[type=checkbox],.checkbox-inline input[type=checkbox]{position:absolute;margin-top:4px \ ;margin-left:-20px}.radio+.radio,.checkbox+.checkbox{margin-top:-5px}.radio-inline,.checkbox-inline{position:relative;display:inline-block;padding-left:20px;margin-bottom:0;font-weight:400;vertical-align:middle;cursor:pointer}.radio-inline.disabled,.checkbox-inline.disabled,fieldset[disabled] .radio-inline,fieldset[disabled] .checkbox-inline{cursor:not-allowed}.radio-inline+.radio-inline,.checkbox-inline+.checkbox-inline{margin-top:0;margin-left:10px}.form-control-static{min-height:34px;padding-top:7px;padding-bottom:7px;margin-bottom:0}.form-control-static.input-lg,.form-control-static.input-sm{padding-right:0;padding-left:0}.input-sm{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-sm{height:30px;line-height:30px}textarea.input-sm,select[multiple].input-sm{height:auto}.form-group-sm .form-control{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.form-group-sm select.form-control{height:30px;line-height:30px}.form-group-sm textarea.form-control,.form-group-sm select[multiple].form-control{height:auto}.form-group-sm .form-control-static{height:30px;min-height:32px;padding:6px 10px;font-size:12px;line-height:1.5}.input-lg{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-lg{height:46px;line-height:46px}textarea.input-lg,select[multiple].input-lg{height:auto}.form-group-lg .form-control{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.form-group-lg select.form-control{height:46px;line-height:46px}.form-group-lg textarea.form-control,.form-group-lg select[multiple].form-control{height:auto}.form-group-lg .form-control-static{height:46px;min-height:38px;padding:11px 16px;font-size:18px;line-height:1.3333333}.has-feedback{position:relative}.has-feedback .form-control{padding-right:42.5px}.form-control-feedback{position:absolute;top:0;right:0;z-index:2;display:block;width:34px;height:34px;line-height:34px;text-align:center;pointer-events:none}.input-lg+.form-control-feedback,.input-group-lg+.form-control-feedback,.form-group-lg .form-control+.form-control-feedback{width:46px;height:46px;line-height:46px}.input-sm+.form-control-feedback,.input-group-sm+.form-control-feedback,.form-group-sm .form-control+.form-control-feedback{width:30px;height:30px;line-height:30px}.has-success .help-block,.has-success .control-label,.has-success .radio,.has-success .checkbox,.has-success .radio-inline,.has-success .checkbox-inline,.has-success.radio label,.has-success.checkbox label,.has-success.radio-inline label,.has-success.checkbox-inline label{color:#3c763d}.has-success .form-control{border-color:#3c763d;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px #00000013}.has-success .form-control:focus{border-color:#2b542c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168;box-shadow:inset 0 1px 1px #00000013,0 0 6px #67b168}.has-success .input-group-addon{color:#3c763d;background-color:#dff0d8;border-color:#3c763d}.has-success .form-control-feedback{color:#3c763d}.has-warning .help-block,.has-warning .control-label,.has-warning .radio,.has-warning .checkbox,.has-warning .radio-inline,.has-warning .checkbox-inline,.has-warning.radio label,.has-warning.checkbox label,.has-warning.radio-inline label,.has-warning.checkbox-inline label{color:#8a6d3b}.has-warning .form-control{border-color:#8a6d3b;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px #00000013}.has-warning .form-control:focus{border-color:#66512c;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b;box-shadow:inset 0 1px 1px #00000013,0 0 6px #c0a16b}.has-warning .input-group-addon{color:#8a6d3b;background-color:#fcf8e3;border-color:#8a6d3b}.has-warning .form-control-feedback{color:#8a6d3b}.has-error .help-block,.has-error .control-label,.has-error .radio,.has-error .checkbox,.has-error .radio-inline,.has-error .checkbox-inline,.has-error.radio label,.has-error.checkbox label,.has-error.radio-inline label,.has-error.checkbox-inline label{color:#a94442}.has-error .form-control{border-color:#a94442;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075);box-shadow:inset 0 1px 1px #00000013}.has-error .form-control:focus{border-color:#843534;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483;box-shadow:inset 0 1px 1px #00000013,0 0 6px #ce8483}.has-error .input-group-addon{color:#a94442;background-color:#f2dede;border-color:#a94442}.has-error .form-control-feedback{color:#a94442}.has-feedback label~.form-control-feedback{top:25px}.has-feedback label.sr-only~.form-control-feedback{top:0}.help-block{display:block;margin-top:5px;margin-bottom:10px;color:#737373}@media (min-width: 768px){.form-inline .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.form-inline .form-control{display:inline-block;width:auto;vertical-align:middle}.form-inline .form-control-static{display:inline-block}.form-inline .input-group{display:inline-table;vertical-align:middle}.form-inline .input-group .input-group-addon,.form-inline .input-group .input-group-btn,.form-inline .input-group .form-control{width:auto}.form-inline .input-group>.form-control{width:100%}.form-inline .control-label{margin-bottom:0;vertical-align:middle}.form-inline .radio,.form-inline .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.form-inline .radio label,.form-inline .checkbox label{padding-left:0}.form-inline .radio input[type=radio],.form-inline .checkbox input[type=checkbox]{position:relative;margin-left:0}.form-inline .has-feedback .form-control-feedback{top:0}}.form-horizontal .radio,.form-horizontal .checkbox,.form-horizontal .radio-inline,.form-horizontal .checkbox-inline{padding-top:7px;margin-top:0;margin-bottom:0}.form-horizontal .radio,.form-horizontal .checkbox{min-height:27px}.form-horizontal .form-group{margin-right:-15px;margin-left:-15px}@media (min-width: 768px){.form-horizontal .control-label{padding-top:7px;margin-bottom:0;text-align:right}}.form-horizontal .has-feedback .form-control-feedback{right:15px}@media (min-width: 768px){.form-horizontal .form-group-lg .control-label{padding-top:11px;font-size:18px}}@media (min-width: 768px){.form-horizontal .form-group-sm .control-label{padding-top:6px;font-size:12px}}.btn{display:inline-block;margin-bottom:0;font-weight:400;text-align:center;white-space:nowrap;vertical-align:middle;-ms-touch-action:manipulation;touch-action:manipulation;cursor:pointer;background-image:none;border:1px solid transparent;padding:6px 12px;font-size:14px;line-height:1.42857143;border-radius:4px;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.btn:focus,.btn:active:focus,.btn.active:focus,.btn.focus,.btn:active.focus,.btn.active.focus{outline:5px auto -webkit-focus-ring-color;outline-offset:-2px}.btn:hover,.btn:focus,.btn.focus{color:#333;text-decoration:none}.btn:active,.btn.active{background-image:none;outline:0;-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px #00000020}.btn.disabled,.btn[disabled],fieldset[disabled] .btn{cursor:not-allowed;filter:alpha(opacity=65);opacity:.65;-webkit-box-shadow:none;box-shadow:none}a.btn.disabled,fieldset[disabled] a.btn{pointer-events:none}.btn-default{color:#333;background-color:#fff;border-color:#ccc}.btn-default:focus,.btn-default.focus{color:#333;background-color:#e6e6e6;border-color:#8c8c8c}.btn-default:hover{color:#333;background-color:#e6e6e6;border-color:#adadad}.btn-default:active,.btn-default.active,.open>.dropdown-toggle.btn-default{color:#333;background-color:#e6e6e6;background-image:none;border-color:#adadad}.btn-default:active:hover,.btn-default.active:hover,.open>.dropdown-toggle.btn-default:hover,.btn-default:active:focus,.btn-default.active:focus,.open>.dropdown-toggle.btn-default:focus,.btn-default:active.focus,.btn-default.active.focus,.open>.dropdown-toggle.btn-default.focus{color:#333;background-color:#d4d4d4;border-color:#8c8c8c}.btn-default.disabled:hover,.btn-default[disabled]:hover,fieldset[disabled] .btn-default:hover,.btn-default.disabled:focus,.btn-default[disabled]:focus,fieldset[disabled] .btn-default:focus,.btn-default.disabled.focus,.btn-default[disabled].focus,fieldset[disabled] .btn-default.focus{background-color:#fff;border-color:#ccc}.btn-default .badge{color:#fff;background-color:#333}.btn-primary{color:#fff;background-color:#337ab7;border-color:#2e6da4}.btn-primary:focus,.btn-primary.focus{color:#fff;background-color:#286090;border-color:#122b40}.btn-primary:hover{color:#fff;background-color:#286090;border-color:#204d74}.btn-primary:active,.btn-primary.active,.open>.dropdown-toggle.btn-primary{color:#fff;background-color:#286090;background-image:none;border-color:#204d74}.btn-primary:active:hover,.btn-primary.active:hover,.open>.dropdown-toggle.btn-primary:hover,.btn-primary:active:focus,.btn-primary.active:focus,.open>.dropdown-toggle.btn-primary:focus,.btn-primary:active.focus,.btn-primary.active.focus,.open>.dropdown-toggle.btn-primary.focus{color:#fff;background-color:#204d74;border-color:#122b40}.btn-primary.disabled:hover,.btn-primary[disabled]:hover,fieldset[disabled] .btn-primary:hover,.btn-primary.disabled:focus,.btn-primary[disabled]:focus,fieldset[disabled] .btn-primary:focus,.btn-primary.disabled.focus,.btn-primary[disabled].focus,fieldset[disabled] .btn-primary.focus{background-color:#337ab7;border-color:#2e6da4}.btn-primary .badge{color:#337ab7;background-color:#fff}.btn-success{color:#fff;background-color:#5cb85c;border-color:#4cae4c}.btn-success:focus,.btn-success.focus{color:#fff;background-color:#449d44;border-color:#255625}.btn-success:hover{color:#fff;background-color:#449d44;border-color:#398439}.btn-success:active,.btn-success.active,.open>.dropdown-toggle.btn-success{color:#fff;background-color:#449d44;background-image:none;border-color:#398439}.btn-success:active:hover,.btn-success.active:hover,.open>.dropdown-toggle.btn-success:hover,.btn-success:active:focus,.btn-success.active:focus,.open>.dropdown-toggle.btn-success:focus,.btn-success:active.focus,.btn-success.active.focus,.open>.dropdown-toggle.btn-success.focus{color:#fff;background-color:#398439;border-color:#255625}.btn-success.disabled:hover,.btn-success[disabled]:hover,fieldset[disabled] .btn-success:hover,.btn-success.disabled:focus,.btn-success[disabled]:focus,fieldset[disabled] .btn-success:focus,.btn-success.disabled.focus,.btn-success[disabled].focus,fieldset[disabled] .btn-success.focus{background-color:#5cb85c;border-color:#4cae4c}.btn-success .badge{color:#5cb85c;background-color:#fff}.btn-info{color:#fff;background-color:#5bc0de;border-color:#46b8da}.btn-info:focus,.btn-info.focus{color:#fff;background-color:#31b0d5;border-color:#1b6d85}.btn-info:hover{color:#fff;background-color:#31b0d5;border-color:#269abc}.btn-info:active,.btn-info.active,.open>.dropdown-toggle.btn-info{color:#fff;background-color:#31b0d5;background-image:none;border-color:#269abc}.btn-info:active:hover,.btn-info.active:hover,.open>.dropdown-toggle.btn-info:hover,.btn-info:active:focus,.btn-info.active:focus,.open>.dropdown-toggle.btn-info:focus,.btn-info:active.focus,.btn-info.active.focus,.open>.dropdown-toggle.btn-info.focus{color:#fff;background-color:#269abc;border-color:#1b6d85}.btn-info.disabled:hover,.btn-info[disabled]:hover,fieldset[disabled] .btn-info:hover,.btn-info.disabled:focus,.btn-info[disabled]:focus,fieldset[disabled] .btn-info:focus,.btn-info.disabled.focus,.btn-info[disabled].focus,fieldset[disabled] .btn-info.focus{background-color:#5bc0de;border-color:#46b8da}.btn-info .badge{color:#5bc0de;background-color:#fff}.btn-warning{color:#fff;background-color:#f0ad4e;border-color:#eea236}.btn-warning:focus,.btn-warning.focus{color:#fff;background-color:#ec971f;border-color:#985f0d}.btn-warning:hover{color:#fff;background-color:#ec971f;border-color:#d58512}.btn-warning:active,.btn-warning.active,.open>.dropdown-toggle.btn-warning{color:#fff;background-color:#ec971f;background-image:none;border-color:#d58512}.btn-warning:active:hover,.btn-warning.active:hover,.open>.dropdown-toggle.btn-warning:hover,.btn-warning:active:focus,.btn-warning.active:focus,.open>.dropdown-toggle.btn-warning:focus,.btn-warning:active.focus,.btn-warning.active.focus,.open>.dropdown-toggle.btn-warning.focus{color:#fff;background-color:#d58512;border-color:#985f0d}.btn-warning.disabled:hover,.btn-warning[disabled]:hover,fieldset[disabled] .btn-warning:hover,.btn-warning.disabled:focus,.btn-warning[disabled]:focus,fieldset[disabled] .btn-warning:focus,.btn-warning.disabled.focus,.btn-warning[disabled].focus,fieldset[disabled] .btn-warning.focus{background-color:#f0ad4e;border-color:#eea236}.btn-warning .badge{color:#f0ad4e;background-color:#fff}.btn-danger{color:#fff;background-color:#d9534f;border-color:#d43f3a}.btn-danger:focus,.btn-danger.focus{color:#fff;background-color:#c9302c;border-color:#761c19}.btn-danger:hover{color:#fff;background-color:#c9302c;border-color:#ac2925}.btn-danger:active,.btn-danger.active,.open>.dropdown-toggle.btn-danger{color:#fff;background-color:#c9302c;background-image:none;border-color:#ac2925}.btn-danger:active:hover,.btn-danger.active:hover,.open>.dropdown-toggle.btn-danger:hover,.btn-danger:active:focus,.btn-danger.active:focus,.open>.dropdown-toggle.btn-danger:focus,.btn-danger:active.focus,.btn-danger.active.focus,.open>.dropdown-toggle.btn-danger.focus{color:#fff;background-color:#ac2925;border-color:#761c19}.btn-danger.disabled:hover,.btn-danger[disabled]:hover,fieldset[disabled] .btn-danger:hover,.btn-danger.disabled:focus,.btn-danger[disabled]:focus,fieldset[disabled] .btn-danger:focus,.btn-danger.disabled.focus,.btn-danger[disabled].focus,fieldset[disabled] .btn-danger.focus{background-color:#d9534f;border-color:#d43f3a}.btn-danger .badge{color:#d9534f;background-color:#fff}.btn-link{font-weight:400;color:#337ab7;border-radius:0}.btn-link,.btn-link:active,.btn-link.active,.btn-link[disabled],fieldset[disabled] .btn-link{background-color:transparent;-webkit-box-shadow:none;box-shadow:none}.btn-link,.btn-link:hover,.btn-link:focus,.btn-link:active{border-color:transparent}.btn-link:hover,.btn-link:focus{color:#23527c;text-decoration:underline;background-color:transparent}.btn-link[disabled]:hover,fieldset[disabled] .btn-link:hover,.btn-link[disabled]:focus,fieldset[disabled] .btn-link:focus{color:#777;text-decoration:none}.btn-lg,.btn-group-lg>.btn{padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}.btn-sm,.btn-group-sm>.btn{padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}.btn-xs,.btn-group-xs>.btn{padding:1px 5px;font-size:12px;line-height:1.5;border-radius:3px}.btn-block{display:block;width:100%}.btn-block+.btn-block{margin-top:5px}input[type=submit].btn-block,input[type=reset].btn-block,input[type=button].btn-block{width:100%}.fade{opacity:0;-webkit-transition:opacity .15s linear;-o-transition:opacity .15s linear;transition:opacity .15s linear}.fade.in{opacity:1}.collapse{display:none}.collapse.in{display:block}tr.collapse.in{display:table-row}tbody.collapse.in{display:table-row-group}.collapsing{position:relative;height:0;overflow:hidden;-webkit-transition-property:height,visibility;-o-transition-property:height,visibility;transition-property:height,visibility;-webkit-transition-duration:.35s;-o-transition-duration:.35s;transition-duration:.35s;-webkit-transition-timing-function:ease;-o-transition-timing-function:ease;transition-timing-function:ease}.caret{display:inline-block;width:0;height:0;margin-left:2px;vertical-align:middle;border-top:4px dashed;border-top:4px solid \ ;border-right:4px solid transparent;border-left:4px solid transparent}.dropup,.dropdown{position:relative}.dropdown-toggle:focus{outline:0}.dropdown-menu{position:absolute;top:100%;left:0;z-index:1000;display:none;float:left;min-width:160px;padding:5px 0;margin:2px 0 0;font-size:14px;text-align:left;list-style:none;background-color:#fff;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.15);border-radius:4px;-webkit-box-shadow:0 6px 12px rgba(0,0,0,.175);box-shadow:0 6px 12px #0000002d}.dropdown-menu.pull-right{right:0;left:auto}.dropdown-menu .divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.dropdown-menu>li>a{display:block;padding:3px 20px;clear:both;font-weight:400;line-height:1.42857143;color:#333;white-space:nowrap}.dropdown-menu>li>a:hover,.dropdown-menu>li>a:focus{color:#262626;text-decoration:none;background-color:#f5f5f5}.dropdown-menu>.active>a,.dropdown-menu>.active>a:hover,.dropdown-menu>.active>a:focus{color:#fff;text-decoration:none;background-color:#337ab7;outline:0}.dropdown-menu>.disabled>a,.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{color:#777}.dropdown-menu>.disabled>a:hover,.dropdown-menu>.disabled>a:focus{text-decoration:none;cursor:not-allowed;background-color:transparent;background-image:none;filter:progid:DXImageTransform.Microsoft.gradient(enabled = false)}.open>.dropdown-menu{display:block}.open>a{outline:0}.dropdown-menu-right{right:0;left:auto}.dropdown-menu-left{right:auto;left:0}.dropdown-header{display:block;padding:3px 20px;font-size:12px;line-height:1.42857143;color:#777;white-space:nowrap}.dropdown-backdrop{position:fixed;inset:0;z-index:990}.pull-right>.dropdown-menu{right:0;left:auto}.dropup .caret,.navbar-fixed-bottom .dropdown .caret{content:"";border-top:0;border-bottom:4px dashed;border-bottom:4px solid \ }.dropup .dropdown-menu,.navbar-fixed-bottom .dropdown .dropdown-menu{top:auto;bottom:100%;margin-bottom:2px}@media (min-width: 768px){.navbar-right .dropdown-menu{right:0;left:auto}.navbar-right .dropdown-menu-left{right:auto;left:0}}.btn-group,.btn-group-vertical{position:relative;display:inline-block;vertical-align:middle}.btn-group>.btn,.btn-group-vertical>.btn{position:relative;float:left}.btn-group>.btn:hover,.btn-group-vertical>.btn:hover,.btn-group>.btn:focus,.btn-group-vertical>.btn:focus,.btn-group>.btn:active,.btn-group-vertical>.btn:active,.btn-group>.btn.active,.btn-group-vertical>.btn.active{z-index:2}.btn-group .btn+.btn,.btn-group .btn+.btn-group,.btn-group .btn-group+.btn,.btn-group .btn-group+.btn-group{margin-left:-1px}.btn-toolbar{margin-left:-5px}.btn-toolbar .btn,.btn-toolbar .btn-group,.btn-toolbar .input-group{float:left}.btn-toolbar>.btn,.btn-toolbar>.btn-group,.btn-toolbar>.input-group{margin-left:5px}.btn-group>.btn:not(:first-child):not(:last-child):not(.dropdown-toggle){border-radius:0}.btn-group>.btn:first-child{margin-left:0}.btn-group>.btn:first-child:not(:last-child):not(.dropdown-toggle){border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn:last-child:not(:first-child),.btn-group>.dropdown-toggle:not(:first-child){border-top-left-radius:0;border-bottom-left-radius:0}.btn-group>.btn-group{float:left}.btn-group>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-top-right-radius:0;border-bottom-right-radius:0}.btn-group>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-bottom-left-radius:0}.btn-group .dropdown-toggle:active,.btn-group.open .dropdown-toggle{outline:0}.btn-group>.btn+.dropdown-toggle{padding-right:8px;padding-left:8px}.btn-group>.btn-lg+.dropdown-toggle{padding-right:12px;padding-left:12px}.btn-group.open .dropdown-toggle{-webkit-box-shadow:inset 0 3px 5px rgba(0,0,0,.125);box-shadow:inset 0 3px 5px #00000020}.btn-group.open .dropdown-toggle.btn-link{-webkit-box-shadow:none;box-shadow:none}.btn .caret{margin-left:0}.btn-lg .caret{border-width:5px 5px 0;border-bottom-width:0}.dropup .btn-lg .caret{border-width:0 5px 5px}.btn-group-vertical>.btn,.btn-group-vertical>.btn-group,.btn-group-vertical>.btn-group>.btn{display:block;float:none;width:100%;max-width:100%}.btn-group-vertical>.btn-group>.btn{float:none}.btn-group-vertical>.btn+.btn,.btn-group-vertical>.btn+.btn-group,.btn-group-vertical>.btn-group+.btn,.btn-group-vertical>.btn-group+.btn-group{margin-top:-1px;margin-left:0}.btn-group-vertical>.btn:not(:first-child):not(:last-child){border-radius:0}.btn-group-vertical>.btn:first-child:not(:last-child){border-radius:4px 4px 0 0}.btn-group-vertical>.btn:last-child:not(:first-child){border-radius:0 0 4px 4px}.btn-group-vertical>.btn-group:not(:first-child):not(:last-child)>.btn{border-radius:0}.btn-group-vertical>.btn-group:first-child:not(:last-child)>.btn:last-child,.btn-group-vertical>.btn-group:first-child:not(:last-child)>.dropdown-toggle{border-bottom-right-radius:0;border-bottom-left-radius:0}.btn-group-vertical>.btn-group:last-child:not(:first-child)>.btn:first-child{border-top-left-radius:0;border-top-right-radius:0}.btn-group-justified{display:table;width:100%;table-layout:fixed;border-collapse:separate}.btn-group-justified>.btn,.btn-group-justified>.btn-group{display:table-cell;float:none;width:1%}.btn-group-justified>.btn-group .btn{width:100%}.btn-group-justified>.btn-group .dropdown-menu{left:auto}[data-toggle=buttons]>.btn input[type=radio],[data-toggle=buttons]>.btn-group>.btn input[type=radio],[data-toggle=buttons]>.btn input[type=checkbox],[data-toggle=buttons]>.btn-group>.btn input[type=checkbox]{position:absolute;clip:rect(0,0,0,0);pointer-events:none}.input-group{position:relative;display:table;border-collapse:separate}.input-group[class*=col-]{float:none;padding-right:0;padding-left:0}.input-group .form-control{position:relative;z-index:2;float:left;width:100%;margin-bottom:0}.input-group .form-control:focus{z-index:3}.input-group-lg>.form-control,.input-group-lg>.input-group-addon,.input-group-lg>.input-group-btn>.btn{height:46px;padding:10px 16px;font-size:18px;line-height:1.3333333;border-radius:6px}select.input-group-lg>.form-control,select.input-group-lg>.input-group-addon,select.input-group-lg>.input-group-btn>.btn{height:46px;line-height:46px}textarea.input-group-lg>.form-control,textarea.input-group-lg>.input-group-addon,textarea.input-group-lg>.input-group-btn>.btn,select[multiple].input-group-lg>.form-control,select[multiple].input-group-lg>.input-group-addon,select[multiple].input-group-lg>.input-group-btn>.btn{height:auto}.input-group-sm>.form-control,.input-group-sm>.input-group-addon,.input-group-sm>.input-group-btn>.btn{height:30px;padding:5px 10px;font-size:12px;line-height:1.5;border-radius:3px}select.input-group-sm>.form-control,select.input-group-sm>.input-group-addon,select.input-group-sm>.input-group-btn>.btn{height:30px;line-height:30px}textarea.input-group-sm>.form-control,textarea.input-group-sm>.input-group-addon,textarea.input-group-sm>.input-group-btn>.btn,select[multiple].input-group-sm>.form-control,select[multiple].input-group-sm>.input-group-addon,select[multiple].input-group-sm>.input-group-btn>.btn{height:auto}.input-group-addon,.input-group-btn,.input-group .form-control{display:table-cell}.input-group-addon:not(:first-child):not(:last-child),.input-group-btn:not(:first-child):not(:last-child),.input-group .form-control:not(:first-child):not(:last-child){border-radius:0}.input-group-addon,.input-group-btn{width:1%;white-space:nowrap;vertical-align:middle}.input-group-addon{padding:6px 12px;font-size:14px;font-weight:400;line-height:1;color:#555;text-align:center;background-color:#eee;border:1px solid #ccc;border-radius:4px}.input-group-addon.input-sm{padding:5px 10px;font-size:12px;border-radius:3px}.input-group-addon.input-lg{padding:10px 16px;font-size:18px;border-radius:6px}.input-group-addon input[type=radio],.input-group-addon input[type=checkbox]{margin-top:0}.input-group .form-control:first-child,.input-group-addon:first-child,.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group>.btn,.input-group-btn:first-child>.dropdown-toggle,.input-group-btn:last-child>.btn:not(:last-child):not(.dropdown-toggle),.input-group-btn:last-child>.btn-group:not(:last-child)>.btn{border-top-right-radius:0;border-bottom-right-radius:0}.input-group-addon:first-child{border-right:0}.input-group .form-control:last-child,.input-group-addon:last-child,.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group>.btn,.input-group-btn:last-child>.dropdown-toggle,.input-group-btn:first-child>.btn:not(:first-child),.input-group-btn:first-child>.btn-group:not(:first-child)>.btn{border-top-left-radius:0;border-bottom-left-radius:0}.input-group-addon:last-child{border-left:0}.input-group-btn{position:relative;font-size:0;white-space:nowrap}.input-group-btn>.btn{position:relative}.input-group-btn>.btn+.btn{margin-left:-1px}.input-group-btn>.btn:hover,.input-group-btn>.btn:focus,.input-group-btn>.btn:active{z-index:2}.input-group-btn:first-child>.btn,.input-group-btn:first-child>.btn-group{margin-right:-1px}.input-group-btn:last-child>.btn,.input-group-btn:last-child>.btn-group{z-index:2;margin-left:-1px}.nav{padding-left:0;margin-bottom:0;list-style:none}.nav>li{position:relative;display:block}.nav>li>a{position:relative;display:block;padding:10px 15px}.nav>li>a:hover,.nav>li>a:focus{text-decoration:none;background-color:#eee}.nav>li.disabled>a{color:#777}.nav>li.disabled>a:hover,.nav>li.disabled>a:focus{color:#777;text-decoration:none;cursor:not-allowed;background-color:transparent}.nav .open>a,.nav .open>a:hover,.nav .open>a:focus{background-color:#eee;border-color:#337ab7}.nav .nav-divider{height:1px;margin:9px 0;overflow:hidden;background-color:#e5e5e5}.nav>li>a>img{max-width:none}.nav-tabs{border-bottom:1px solid #ddd}.nav-tabs>li{float:left;margin-bottom:-1px}.nav-tabs>li>a{margin-right:2px;line-height:1.42857143;border:1px solid transparent;border-radius:4px 4px 0 0}.nav-tabs>li>a:hover{border-color:#eeeeee #eeeeee #ddd}.nav-tabs>li.active>a,.nav-tabs>li.active>a:hover,.nav-tabs>li.active>a:focus{color:#555;cursor:default;background-color:#fff;border:1px solid #ddd;border-bottom-color:transparent}.nav-tabs.nav-justified{width:100%;border-bottom:0}.nav-tabs.nav-justified>li{float:none}.nav-tabs.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-tabs.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width: 768px){.nav-tabs.nav-justified>li{display:table-cell;width:1%}.nav-tabs.nav-justified>li>a{margin-bottom:0}}.nav-tabs.nav-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border:1px solid #ddd}@media (min-width: 768px){.nav-tabs.nav-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs.nav-justified>.active>a,.nav-tabs.nav-justified>.active>a:hover,.nav-tabs.nav-justified>.active>a:focus{border-bottom-color:#fff}}.nav-pills>li{float:left}.nav-pills>li>a{border-radius:4px}.nav-pills>li+li{margin-left:2px}.nav-pills>li.active>a,.nav-pills>li.active>a:hover,.nav-pills>li.active>a:focus{color:#fff;background-color:#337ab7}.nav-stacked>li{float:none}.nav-stacked>li+li{margin-top:2px;margin-left:0}.nav-justified{width:100%}.nav-justified>li{float:none}.nav-justified>li>a{margin-bottom:5px;text-align:center}.nav-justified>.dropdown .dropdown-menu{top:auto;left:auto}@media (min-width: 768px){.nav-justified>li{display:table-cell;width:1%}.nav-justified>li>a{margin-bottom:0}}.nav-tabs-justified{border-bottom:0}.nav-tabs-justified>li>a{margin-right:0;border-radius:4px}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border:1px solid #ddd}@media (min-width: 768px){.nav-tabs-justified>li>a{border-bottom:1px solid #ddd;border-radius:4px 4px 0 0}.nav-tabs-justified>.active>a,.nav-tabs-justified>.active>a:hover,.nav-tabs-justified>.active>a:focus{border-bottom-color:#fff}}.tab-content>.tab-pane{display:none}.tab-content>.active{display:block}.nav-tabs .dropdown-menu{margin-top:-1px;border-top-left-radius:0;border-top-right-radius:0}.navbar{position:relative;min-height:50px;margin-bottom:20px;border:1px solid transparent}@media (min-width: 768px){.navbar{border-radius:4px}}@media (min-width: 768px){.navbar-header{float:left}}.navbar-collapse{padding-right:15px;padding-left:15px;overflow-x:visible;border-top:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px #ffffff1a;-webkit-overflow-scrolling:touch}.navbar-collapse.in{overflow-y:auto}@media (min-width: 768px){.navbar-collapse{width:auto;border-top:0;-webkit-box-shadow:none;box-shadow:none}.navbar-collapse.collapse{display:block!important;height:auto!important;padding-bottom:0;overflow:visible!important}.navbar-collapse.in{overflow-y:visible}.navbar-fixed-top .navbar-collapse,.navbar-static-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{padding-right:0;padding-left:0}}.navbar-fixed-top,.navbar-fixed-bottom{position:fixed;right:0;left:0;z-index:1030}.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:340px}@media (max-device-width: 480px) and (orientation: landscape){.navbar-fixed-top .navbar-collapse,.navbar-fixed-bottom .navbar-collapse{max-height:200px}}@media (min-width: 768px){.navbar-fixed-top,.navbar-fixed-bottom{border-radius:0}}.navbar-fixed-top{top:0;border-width:0 0 1px}.navbar-fixed-bottom{bottom:0;margin-bottom:0;border-width:1px 0 0}.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:-15px;margin-left:-15px}@media (min-width: 768px){.container>.navbar-header,.container-fluid>.navbar-header,.container>.navbar-collapse,.container-fluid>.navbar-collapse{margin-right:0;margin-left:0}}.navbar-static-top{z-index:1000;border-width:0 0 1px}@media (min-width: 768px){.navbar-static-top{border-radius:0}}.navbar-brand{float:left;height:50px;padding:15px;font-size:18px;line-height:20px}.navbar-brand:hover,.navbar-brand:focus{text-decoration:none}.navbar-brand>img{display:block}@media (min-width: 768px){.navbar>.container .navbar-brand,.navbar>.container-fluid .navbar-brand{margin-left:-15px}}.navbar-toggle{position:relative;float:right;padding:9px 10px;margin-right:15px;margin-top:8px;margin-bottom:8px;background-color:transparent;background-image:none;border:1px solid transparent;border-radius:4px}.navbar-toggle:focus{outline:0}.navbar-toggle .icon-bar{display:block;width:22px;height:2px;border-radius:1px}.navbar-toggle .icon-bar+.icon-bar{margin-top:4px}@media (min-width: 768px){.navbar-toggle{display:none}}.navbar-nav{margin:7.5px -15px}.navbar-nav>li>a{padding-top:10px;padding-bottom:10px;line-height:20px}@media (max-width: 767px){.navbar-nav .open .dropdown-menu{position:static;float:none;width:auto;margin-top:0;background-color:transparent;border:0;-webkit-box-shadow:none;box-shadow:none}.navbar-nav .open .dropdown-menu>li>a,.navbar-nav .open .dropdown-menu .dropdown-header{padding:5px 15px 5px 25px}.navbar-nav .open .dropdown-menu>li>a{line-height:20px}.navbar-nav .open .dropdown-menu>li>a:hover,.navbar-nav .open .dropdown-menu>li>a:focus{background-image:none}}@media (min-width: 768px){.navbar-nav{float:left;margin:0}.navbar-nav>li{float:left}.navbar-nav>li>a{padding-top:15px;padding-bottom:15px}}.navbar-form{padding:10px 15px;margin:8px -15px;border-top:1px solid transparent;border-bottom:1px solid transparent;-webkit-box-shadow:inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1);box-shadow:inset 0 1px #ffffff1a,0 1px #ffffff1a}@media (min-width: 768px){.navbar-form .form-group{display:inline-block;margin-bottom:0;vertical-align:middle}.navbar-form .form-control{display:inline-block;width:auto;vertical-align:middle}.navbar-form .form-control-static{display:inline-block}.navbar-form .input-group{display:inline-table;vertical-align:middle}.navbar-form .input-group .input-group-addon,.navbar-form .input-group .input-group-btn,.navbar-form .input-group .form-control{width:auto}.navbar-form .input-group>.form-control{width:100%}.navbar-form .control-label{margin-bottom:0;vertical-align:middle}.navbar-form .radio,.navbar-form .checkbox{display:inline-block;margin-top:0;margin-bottom:0;vertical-align:middle}.navbar-form .radio label,.navbar-form .checkbox label{padding-left:0}.navbar-form .radio input[type=radio],.navbar-form .checkbox input[type=checkbox]{position:relative;margin-left:0}.navbar-form .has-feedback .form-control-feedback{top:0}}@media (max-width: 767px){.navbar-form .form-group{margin-bottom:5px}.navbar-form .form-group:last-child{margin-bottom:0}}@media (min-width: 768px){.navbar-form{width:auto;padding-top:0;padding-bottom:0;margin-right:0;margin-left:0;border:0;-webkit-box-shadow:none;box-shadow:none}}.navbar-nav>li>.dropdown-menu{margin-top:0;border-top-left-radius:0;border-top-right-radius:0}.navbar-fixed-bottom .navbar-nav>li>.dropdown-menu{margin-bottom:0;border-radius:4px 4px 0 0}.navbar-btn{margin-top:8px;margin-bottom:8px}.navbar-btn.btn-sm{margin-top:10px;margin-bottom:10px}.navbar-btn.btn-xs{margin-top:14px;margin-bottom:14px}.navbar-text{margin-top:15px;margin-bottom:15px}@media (min-width: 768px){.navbar-text{float:left;margin-right:15px;margin-left:15px}}@media (min-width: 768px){.navbar-left{float:left!important}.navbar-right{float:right!important;margin-right:-15px}.navbar-right~.navbar-right{margin-right:0}}.navbar-default{background-color:#f8f8f8;border-color:#e7e7e7}.navbar-default .navbar-brand{color:#777}.navbar-default .navbar-brand:hover,.navbar-default .navbar-brand:focus{color:#5e5e5e;background-color:transparent}.navbar-default .navbar-text{color:#777}.navbar-default .navbar-nav>li>a{color:#777}.navbar-default .navbar-nav>li>a:hover,.navbar-default .navbar-nav>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav>.active>a,.navbar-default .navbar-nav>.active>a:hover,.navbar-default .navbar-nav>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav>.disabled>a,.navbar-default .navbar-nav>.disabled>a:hover,.navbar-default .navbar-nav>.disabled>a:focus{color:#ccc;background-color:transparent}.navbar-default .navbar-nav>.open>a,.navbar-default .navbar-nav>.open>a:hover,.navbar-default .navbar-nav>.open>a:focus{color:#555;background-color:#e7e7e7}@media (max-width: 767px){.navbar-default .navbar-nav .open .dropdown-menu>li>a{color:#777}.navbar-default .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>li>a:focus{color:#333;background-color:transparent}.navbar-default .navbar-nav .open .dropdown-menu>.active>a,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.active>a:focus{color:#555;background-color:#e7e7e7}.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-default .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#ccc;background-color:transparent}}.navbar-default .navbar-toggle{border-color:#ddd}.navbar-default .navbar-toggle:hover,.navbar-default .navbar-toggle:focus{background-color:#ddd}.navbar-default .navbar-toggle .icon-bar{background-color:#888}.navbar-default .navbar-collapse,.navbar-default .navbar-form{border-color:#e7e7e7}.navbar-default .navbar-link{color:#777}.navbar-default .navbar-link:hover{color:#333}.navbar-default .btn-link{color:#777}.navbar-default .btn-link:hover,.navbar-default .btn-link:focus{color:#333}.navbar-default .btn-link[disabled]:hover,fieldset[disabled] .navbar-default .btn-link:hover,.navbar-default .btn-link[disabled]:focus,fieldset[disabled] .navbar-default .btn-link:focus{color:#ccc}.navbar-inverse{background-color:#222;border-color:#080808}.navbar-inverse .navbar-brand{color:#9d9d9d}.navbar-inverse .navbar-brand:hover,.navbar-inverse .navbar-brand:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-text{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav>li>a:hover,.navbar-inverse .navbar-nav>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav>.active>a,.navbar-inverse .navbar-nav>.active>a:hover,.navbar-inverse .navbar-nav>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav>.disabled>a,.navbar-inverse .navbar-nav>.disabled>a:hover,.navbar-inverse .navbar-nav>.disabled>a:focus{color:#444;background-color:transparent}.navbar-inverse .navbar-nav>.open>a,.navbar-inverse .navbar-nav>.open>a:hover,.navbar-inverse .navbar-nav>.open>a:focus{color:#fff;background-color:#080808}@media (max-width: 767px){.navbar-inverse .navbar-nav .open .dropdown-menu>.dropdown-header{border-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu .divider{background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a{color:#9d9d9d}.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>li>a:focus{color:#fff;background-color:transparent}.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.active>a:focus{color:#fff;background-color:#080808}.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:hover,.navbar-inverse .navbar-nav .open .dropdown-menu>.disabled>a:focus{color:#444;background-color:transparent}}.navbar-inverse .navbar-toggle{border-color:#333}.navbar-inverse .navbar-toggle:hover,.navbar-inverse .navbar-toggle:focus{background-color:#333}.navbar-inverse .navbar-toggle .icon-bar{background-color:#fff}.navbar-inverse .navbar-collapse,.navbar-inverse .navbar-form{border-color:#101010}.navbar-inverse .navbar-link{color:#9d9d9d}.navbar-inverse .navbar-link:hover{color:#fff}.navbar-inverse .btn-link{color:#9d9d9d}.navbar-inverse .btn-link:hover,.navbar-inverse .btn-link:focus{color:#fff}.navbar-inverse .btn-link[disabled]:hover,fieldset[disabled] .navbar-inverse .btn-link:hover,.navbar-inverse .btn-link[disabled]:focus,fieldset[disabled] .navbar-inverse .btn-link:focus{color:#444}.breadcrumb{padding:8px 15px;margin-bottom:20px;list-style:none;background-color:#f5f5f5;border-radius:4px}.breadcrumb>li{display:inline-block}.breadcrumb>li+li:before{padding:0 5px;color:#ccc;content:"/\a0"}.breadcrumb>.active{color:#777}.pagination{display:inline-block;padding-left:0;margin:20px 0;border-radius:4px}.pagination>li{display:inline}.pagination>li>a,.pagination>li>span{position:relative;float:left;padding:6px 12px;margin-left:-1px;line-height:1.42857143;color:#337ab7;text-decoration:none;background-color:#fff;border:1px solid #ddd}.pagination>li>a:hover,.pagination>li>span:hover,.pagination>li>a:focus,.pagination>li>span:focus{z-index:2;color:#23527c;background-color:#eee;border-color:#ddd}.pagination>li:first-child>a,.pagination>li:first-child>span{margin-left:0;border-top-left-radius:4px;border-bottom-left-radius:4px}.pagination>li:last-child>a,.pagination>li:last-child>span{border-top-right-radius:4px;border-bottom-right-radius:4px}.pagination>.active>a,.pagination>.active>span,.pagination>.active>a:hover,.pagination>.active>span:hover,.pagination>.active>a:focus,.pagination>.active>span:focus{z-index:3;color:#fff;cursor:default;background-color:#337ab7;border-color:#337ab7}.pagination>.disabled>span,.pagination>.disabled>span:hover,.pagination>.disabled>span:focus,.pagination>.disabled>a,.pagination>.disabled>a:hover,.pagination>.disabled>a:focus{color:#777;cursor:not-allowed;background-color:#fff;border-color:#ddd}.pagination-lg>li>a,.pagination-lg>li>span{padding:10px 16px;font-size:18px;line-height:1.3333333}.pagination-lg>li:first-child>a,.pagination-lg>li:first-child>span{border-top-left-radius:6px;border-bottom-left-radius:6px}.pagination-lg>li:last-child>a,.pagination-lg>li:last-child>span{border-top-right-radius:6px;border-bottom-right-radius:6px}.pagination-sm>li>a,.pagination-sm>li>span{padding:5px 10px;font-size:12px;line-height:1.5}.pagination-sm>li:first-child>a,.pagination-sm>li:first-child>span{border-top-left-radius:3px;border-bottom-left-radius:3px}.pagination-sm>li:last-child>a,.pagination-sm>li:last-child>span{border-top-right-radius:3px;border-bottom-right-radius:3px}.pager{padding-left:0;margin:20px 0;text-align:center;list-style:none}.pager li{display:inline}.pager li>a,.pager li>span{display:inline-block;padding:5px 14px;background-color:#fff;border:1px solid #ddd;border-radius:15px}.pager li>a:hover,.pager li>a:focus{text-decoration:none;background-color:#eee}.pager .next>a,.pager .next>span{float:right}.pager .previous>a,.pager .previous>span{float:left}.pager .disabled>a,.pager .disabled>a:hover,.pager .disabled>a:focus,.pager .disabled>span{color:#777;cursor:not-allowed;background-color:#fff}.label{display:inline;padding:.2em .6em .3em;font-size:75%;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25em}a.label:hover,a.label:focus{color:#fff;text-decoration:none;cursor:pointer}.label:empty{display:none}.btn .label{position:relative;top:-1px}.label-default{background-color:#777}.label-default[href]:hover,.label-default[href]:focus{background-color:#5e5e5e}.label-primary{background-color:#337ab7}.label-primary[href]:hover,.label-primary[href]:focus{background-color:#286090}.label-success{background-color:#5cb85c}.label-success[href]:hover,.label-success[href]:focus{background-color:#449d44}.label-info{background-color:#5bc0de}.label-info[href]:hover,.label-info[href]:focus{background-color:#31b0d5}.label-warning{background-color:#f0ad4e}.label-warning[href]:hover,.label-warning[href]:focus{background-color:#ec971f}.label-danger{background-color:#d9534f}.label-danger[href]:hover,.label-danger[href]:focus{background-color:#c9302c}.badge{display:inline-block;min-width:10px;padding:3px 7px;font-size:12px;font-weight:700;line-height:1;color:#fff;text-align:center;white-space:nowrap;vertical-align:middle;background-color:#777;border-radius:10px}.badge:empty{display:none}.btn .badge{position:relative;top:-1px}.btn-xs .badge,.btn-group-xs>.btn .badge{top:0;padding:1px 5px}a.badge:hover,a.badge:focus{color:#fff;text-decoration:none;cursor:pointer}.list-group-item.active>.badge,.nav-pills>.active>a>.badge{color:#337ab7;background-color:#fff}.list-group-item>.badge{float:right}.list-group-item>.badge+.badge{margin-right:5px}.nav-pills>li>a>.badge{margin-left:3px}.jumbotron{padding-top:30px;padding-bottom:30px;margin-bottom:30px;color:inherit;background-color:#eee}.jumbotron h1,.jumbotron .h1{color:inherit}.jumbotron p{margin-bottom:15px;font-size:21px;font-weight:200}.jumbotron>hr{border-top-color:#d5d5d5}.container .jumbotron,.container-fluid .jumbotron{padding-right:15px;padding-left:15px;border-radius:6px}.jumbotron .container{max-width:100%}@media screen and (min-width: 768px){.jumbotron{padding-top:48px;padding-bottom:48px}.container .jumbotron,.container-fluid .jumbotron{padding-right:60px;padding-left:60px}.jumbotron h1,.jumbotron .h1{font-size:63px}}.thumbnail{display:block;padding:4px;margin-bottom:20px;line-height:1.42857143;background-color:#fff;border:1px solid #ddd;border-radius:4px;-webkit-transition:border .2s ease-in-out;-o-transition:border .2s ease-in-out;transition:border .2s ease-in-out}.thumbnail>img,.thumbnail a>img{margin-right:auto;margin-left:auto}a.thumbnail:hover,a.thumbnail:focus,a.thumbnail.active{border-color:#337ab7}.thumbnail .caption{padding:9px;color:#333}.alert{padding:15px;margin-bottom:20px;border:1px solid transparent;border-radius:4px}.alert h4{margin-top:0;color:inherit}.alert .alert-link{font-weight:700}.alert>p,.alert>ul{margin-bottom:0}.alert>p+p{margin-top:5px}.alert-dismissable,.alert-dismissible{padding-right:35px}.alert-dismissable .close,.alert-dismissible .close{position:relative;top:-2px;right:-21px;color:inherit}.alert-success{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.alert-success hr{border-top-color:#c9e2b3}.alert-success .alert-link{color:#2b542c}.alert-info{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.alert-info hr{border-top-color:#a6e1ec}.alert-info .alert-link{color:#245269}.alert-warning{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.alert-warning hr{border-top-color:#f7e1b5}.alert-warning .alert-link{color:#66512c}.alert-danger{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.alert-danger hr{border-top-color:#e4b9c0}.alert-danger .alert-link{color:#843534}@-webkit-keyframes progress-bar-stripes{0%{background-position:40px 0}to{background-position:0 0}}@-o-keyframes progress-bar-stripes{0%{background-position:40px 0}to{background-position:0 0}}@keyframes progress-bar-stripes{0%{background-position:40px 0}to{background-position:0 0}}.progress{height:20px;margin-bottom:20px;overflow:hidden;background-color:#f5f5f5;border-radius:4px;-webkit-box-shadow:inset 0 1px 2px rgba(0,0,0,.1);box-shadow:inset 0 1px 2px #0000001a}.progress-bar{float:left;width:0%;height:100%;font-size:12px;line-height:20px;color:#fff;text-align:center;background-color:#337ab7;-webkit-box-shadow:inset 0 -1px 0 rgba(0,0,0,.15);box-shadow:inset 0 -1px #00000026;-webkit-transition:width .6s ease;-o-transition:width .6s ease;transition:width .6s ease}.progress-striped .progress-bar,.progress-bar-striped{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);-webkit-background-size:40px 40px;background-size:40px 40px}.progress.active .progress-bar,.progress-bar.active{-webkit-animation:progress-bar-stripes 2s linear infinite;-o-animation:progress-bar-stripes 2s linear infinite;animation:progress-bar-stripes 2s linear infinite}.progress-bar-success{background-color:#5cb85c}.progress-striped .progress-bar-success{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-info{background-color:#5bc0de}.progress-striped .progress-bar-info{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-warning{background-color:#f0ad4e}.progress-striped .progress-bar-warning{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.progress-bar-danger{background-color:#d9534f}.progress-striped .progress-bar-danger{background-image:-webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:-o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent);background-image:linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent)}.media{margin-top:15px}.media:first-child{margin-top:0}.media,.media-body{overflow:hidden;zoom:1}.media-body{width:10000px}.media-object{display:block}.media-object.img-thumbnail{max-width:none}.media-right,.media>.pull-right{padding-left:10px}.media-left,.media>.pull-left{padding-right:10px}.media-left,.media-right,.media-body{display:table-cell;vertical-align:top}.media-middle{vertical-align:middle}.media-bottom{vertical-align:bottom}.media-heading{margin-top:0;margin-bottom:5px}.media-list{padding-left:0;list-style:none}.list-group{padding-left:0;margin-bottom:20px}.list-group-item{position:relative;display:block;padding:10px 15px;margin-bottom:-1px;background-color:#fff;border:1px solid #ddd}.list-group-item:first-child{border-top-left-radius:4px;border-top-right-radius:4px}.list-group-item:last-child{margin-bottom:0;border-bottom-right-radius:4px;border-bottom-left-radius:4px}.list-group-item.disabled,.list-group-item.disabled:hover,.list-group-item.disabled:focus{color:#777;cursor:not-allowed;background-color:#eee}.list-group-item.disabled .list-group-item-heading,.list-group-item.disabled:hover .list-group-item-heading,.list-group-item.disabled:focus .list-group-item-heading{color:inherit}.list-group-item.disabled .list-group-item-text,.list-group-item.disabled:hover .list-group-item-text,.list-group-item.disabled:focus .list-group-item-text{color:#777}.list-group-item.active,.list-group-item.active:hover,.list-group-item.active:focus{z-index:2;color:#fff;background-color:#337ab7;border-color:#337ab7}.list-group-item.active .list-group-item-heading,.list-group-item.active:hover .list-group-item-heading,.list-group-item.active:focus .list-group-item-heading,.list-group-item.active .list-group-item-heading>small,.list-group-item.active:hover .list-group-item-heading>small,.list-group-item.active:focus .list-group-item-heading>small,.list-group-item.active .list-group-item-heading>.small,.list-group-item.active:hover .list-group-item-heading>.small,.list-group-item.active:focus .list-group-item-heading>.small{color:inherit}.list-group-item.active .list-group-item-text,.list-group-item.active:hover .list-group-item-text,.list-group-item.active:focus .list-group-item-text{color:#c7ddef}a.list-group-item,button.list-group-item{color:#555}a.list-group-item .list-group-item-heading,button.list-group-item .list-group-item-heading{color:#333}a.list-group-item:hover,button.list-group-item:hover,a.list-group-item:focus,button.list-group-item:focus{color:#555;text-decoration:none;background-color:#f5f5f5}button.list-group-item{width:100%;text-align:left}.list-group-item-success{color:#3c763d;background-color:#dff0d8}a.list-group-item-success,button.list-group-item-success{color:#3c763d}a.list-group-item-success .list-group-item-heading,button.list-group-item-success .list-group-item-heading{color:inherit}a.list-group-item-success:hover,button.list-group-item-success:hover,a.list-group-item-success:focus,button.list-group-item-success:focus{color:#3c763d;background-color:#d0e9c6}a.list-group-item-success.active,button.list-group-item-success.active,a.list-group-item-success.active:hover,button.list-group-item-success.active:hover,a.list-group-item-success.active:focus,button.list-group-item-success.active:focus{color:#fff;background-color:#3c763d;border-color:#3c763d}.list-group-item-info{color:#31708f;background-color:#d9edf7}a.list-group-item-info,button.list-group-item-info{color:#31708f}a.list-group-item-info .list-group-item-heading,button.list-group-item-info .list-group-item-heading{color:inherit}a.list-group-item-info:hover,button.list-group-item-info:hover,a.list-group-item-info:focus,button.list-group-item-info:focus{color:#31708f;background-color:#c4e3f3}a.list-group-item-info.active,button.list-group-item-info.active,a.list-group-item-info.active:hover,button.list-group-item-info.active:hover,a.list-group-item-info.active:focus,button.list-group-item-info.active:focus{color:#fff;background-color:#31708f;border-color:#31708f}.list-group-item-warning{color:#8a6d3b;background-color:#fcf8e3}a.list-group-item-warning,button.list-group-item-warning{color:#8a6d3b}a.list-group-item-warning .list-group-item-heading,button.list-group-item-warning .list-group-item-heading{color:inherit}a.list-group-item-warning:hover,button.list-group-item-warning:hover,a.list-group-item-warning:focus,button.list-group-item-warning:focus{color:#8a6d3b;background-color:#faf2cc}a.list-group-item-warning.active,button.list-group-item-warning.active,a.list-group-item-warning.active:hover,button.list-group-item-warning.active:hover,a.list-group-item-warning.active:focus,button.list-group-item-warning.active:focus{color:#fff;background-color:#8a6d3b;border-color:#8a6d3b}.list-group-item-danger{color:#a94442;background-color:#f2dede}a.list-group-item-danger,button.list-group-item-danger{color:#a94442}a.list-group-item-danger .list-group-item-heading,button.list-group-item-danger .list-group-item-heading{color:inherit}a.list-group-item-danger:hover,button.list-group-item-danger:hover,a.list-group-item-danger:focus,button.list-group-item-danger:focus{color:#a94442;background-color:#ebcccc}a.list-group-item-danger.active,button.list-group-item-danger.active,a.list-group-item-danger.active:hover,button.list-group-item-danger.active:hover,a.list-group-item-danger.active:focus,button.list-group-item-danger.active:focus{color:#fff;background-color:#a94442;border-color:#a94442}.list-group-item-heading{margin-top:0;margin-bottom:5px}.list-group-item-text{margin-bottom:0;line-height:1.3}.panel{margin-bottom:20px;background-color:#fff;border:1px solid transparent;border-radius:4px;-webkit-box-shadow:0 1px 1px rgba(0,0,0,.05);box-shadow:0 1px 1px #0000000d}.panel-body{padding:15px}.panel-heading{padding:10px 15px;border-bottom:1px solid transparent;border-top-left-radius:3px;border-top-right-radius:3px}.panel-heading>.dropdown .dropdown-toggle{color:inherit}.panel-title{margin-top:0;margin-bottom:0;font-size:16px;color:inherit}.panel-title>a,.panel-title>small,.panel-title>.small,.panel-title>small>a,.panel-title>.small>a{color:inherit}.panel-footer{padding:10px 15px;background-color:#f5f5f5;border-top:1px solid #ddd;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.list-group,.panel>.panel-collapse>.list-group{margin-bottom:0}.panel>.list-group .list-group-item,.panel>.panel-collapse>.list-group .list-group-item{border-width:1px 0;border-radius:0}.panel>.list-group:first-child .list-group-item:first-child,.panel>.panel-collapse>.list-group:first-child .list-group-item:first-child{border-top:0;border-top-left-radius:3px;border-top-right-radius:3px}.panel>.list-group:last-child .list-group-item:last-child,.panel>.panel-collapse>.list-group:last-child .list-group-item:last-child{border-bottom:0;border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.panel-heading+.panel-collapse>.list-group .list-group-item:first-child{border-top-left-radius:0;border-top-right-radius:0}.panel-heading+.list-group .list-group-item:first-child{border-top-width:0}.list-group+.panel-footer{border-top-width:0}.panel>.table,.panel>.table-responsive>.table,.panel>.panel-collapse>.table{margin-bottom:0}.panel>.table caption,.panel>.table-responsive>.table caption,.panel>.panel-collapse>.table caption{padding-right:15px;padding-left:15px}.panel>.table:first-child,.panel>.table-responsive:first-child>.table:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child{border-top-left-radius:3px;border-top-right-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:first-child,.panel>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:first-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:first-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:first-child{border-top-left-radius:3px}.panel>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child td:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child td:last-child,.panel>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>thead:first-child>tr:first-child th:last-child,.panel>.table:first-child>tbody:first-child>tr:first-child th:last-child,.panel>.table-responsive:first-child>.table:first-child>tbody:first-child>tr:first-child th:last-child{border-top-right-radius:3px}.panel>.table:last-child,.panel>.table-responsive:last-child>.table:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child{border-bottom-right-radius:3px;border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:first-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:first-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:first-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:first-child{border-bottom-left-radius:3px}.panel>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child td:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child td:last-child,.panel>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tbody:last-child>tr:last-child th:last-child,.panel>.table:last-child>tfoot:last-child>tr:last-child th:last-child,.panel>.table-responsive:last-child>.table:last-child>tfoot:last-child>tr:last-child th:last-child{border-bottom-right-radius:3px}.panel>.panel-body+.table,.panel>.panel-body+.table-responsive,.panel>.table+.panel-body,.panel>.table-responsive+.panel-body{border-top:1px solid #ddd}.panel>.table>tbody:first-child>tr:first-child th,.panel>.table>tbody:first-child>tr:first-child td{border-top:0}.panel>.table-bordered,.panel>.table-responsive>.table-bordered{border:0}.panel>.table-bordered>thead>tr>th:first-child,.panel>.table-responsive>.table-bordered>thead>tr>th:first-child,.panel>.table-bordered>tbody>tr>th:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:first-child,.panel>.table-bordered>tfoot>tr>th:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:first-child,.panel>.table-bordered>thead>tr>td:first-child,.panel>.table-responsive>.table-bordered>thead>tr>td:first-child,.panel>.table-bordered>tbody>tr>td:first-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:first-child,.panel>.table-bordered>tfoot>tr>td:first-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:first-child{border-left:0}.panel>.table-bordered>thead>tr>th:last-child,.panel>.table-responsive>.table-bordered>thead>tr>th:last-child,.panel>.table-bordered>tbody>tr>th:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>th:last-child,.panel>.table-bordered>tfoot>tr>th:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>th:last-child,.panel>.table-bordered>thead>tr>td:last-child,.panel>.table-responsive>.table-bordered>thead>tr>td:last-child,.panel>.table-bordered>tbody>tr>td:last-child,.panel>.table-responsive>.table-bordered>tbody>tr>td:last-child,.panel>.table-bordered>tfoot>tr>td:last-child,.panel>.table-responsive>.table-bordered>tfoot>tr>td:last-child{border-right:0}.panel>.table-bordered>thead>tr:first-child>td,.panel>.table-responsive>.table-bordered>thead>tr:first-child>td,.panel>.table-bordered>tbody>tr:first-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>td,.panel>.table-bordered>thead>tr:first-child>th,.panel>.table-responsive>.table-bordered>thead>tr:first-child>th,.panel>.table-bordered>tbody>tr:first-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:first-child>th{border-bottom:0}.panel>.table-bordered>tbody>tr:last-child>td,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>td,.panel>.table-bordered>tfoot>tr:last-child>td,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>td,.panel>.table-bordered>tbody>tr:last-child>th,.panel>.table-responsive>.table-bordered>tbody>tr:last-child>th,.panel>.table-bordered>tfoot>tr:last-child>th,.panel>.table-responsive>.table-bordered>tfoot>tr:last-child>th{border-bottom:0}.panel>.table-responsive{margin-bottom:0;border:0}.panel-group{margin-bottom:20px}.panel-group .panel{margin-bottom:0;border-radius:4px}.panel-group .panel+.panel{margin-top:5px}.panel-group .panel-heading{border-bottom:0}.panel-group .panel-heading+.panel-collapse>.panel-body,.panel-group .panel-heading+.panel-collapse>.list-group{border-top:1px solid #ddd}.panel-group .panel-footer{border-top:0}.panel-group .panel-footer+.panel-collapse .panel-body{border-bottom:1px solid #ddd}.panel-default{border-color:#ddd}.panel-default>.panel-heading{color:#333;background-color:#f5f5f5;border-color:#ddd}.panel-default>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ddd}.panel-default>.panel-heading .badge{color:#f5f5f5;background-color:#333}.panel-default>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ddd}.panel-primary{border-color:#337ab7}.panel-primary>.panel-heading{color:#fff;background-color:#337ab7;border-color:#337ab7}.panel-primary>.panel-heading+.panel-collapse>.panel-body{border-top-color:#337ab7}.panel-primary>.panel-heading .badge{color:#337ab7;background-color:#fff}.panel-primary>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#337ab7}.panel-success{border-color:#d6e9c6}.panel-success>.panel-heading{color:#3c763d;background-color:#dff0d8;border-color:#d6e9c6}.panel-success>.panel-heading+.panel-collapse>.panel-body{border-top-color:#d6e9c6}.panel-success>.panel-heading .badge{color:#dff0d8;background-color:#3c763d}.panel-success>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#d6e9c6}.panel-info{border-color:#bce8f1}.panel-info>.panel-heading{color:#31708f;background-color:#d9edf7;border-color:#bce8f1}.panel-info>.panel-heading+.panel-collapse>.panel-body{border-top-color:#bce8f1}.panel-info>.panel-heading .badge{color:#d9edf7;background-color:#31708f}.panel-info>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#bce8f1}.panel-warning{border-color:#faebcc}.panel-warning>.panel-heading{color:#8a6d3b;background-color:#fcf8e3;border-color:#faebcc}.panel-warning>.panel-heading+.panel-collapse>.panel-body{border-top-color:#faebcc}.panel-warning>.panel-heading .badge{color:#fcf8e3;background-color:#8a6d3b}.panel-warning>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#faebcc}.panel-danger{border-color:#ebccd1}.panel-danger>.panel-heading{color:#a94442;background-color:#f2dede;border-color:#ebccd1}.panel-danger>.panel-heading+.panel-collapse>.panel-body{border-top-color:#ebccd1}.panel-danger>.panel-heading .badge{color:#f2dede;background-color:#a94442}.panel-danger>.panel-footer+.panel-collapse>.panel-body{border-bottom-color:#ebccd1}.embed-responsive{position:relative;display:block;height:0;padding:0;overflow:hidden}.embed-responsive .embed-responsive-item,.embed-responsive iframe,.embed-responsive embed,.embed-responsive object,.embed-responsive video{position:absolute;top:0;bottom:0;left:0;width:100%;height:100%;border:0}.embed-responsive-16by9{padding-bottom:56.25%}.embed-responsive-4by3{padding-bottom:75%}.well{min-height:20px;padding:19px;margin-bottom:20px;background-color:#f5f5f5;border:1px solid #e3e3e3;border-radius:4px;-webkit-box-shadow:inset 0 1px 1px rgba(0,0,0,.05);box-shadow:inset 0 1px 1px #0000000d}.well blockquote{border-color:#ddd;border-color:#00000026}.well-lg{padding:24px;border-radius:6px}.well-sm{padding:9px;border-radius:3px}.close{float:right;font-size:21px;font-weight:700;line-height:1;color:#000;text-shadow:0 1px 0 #fff;filter:alpha(opacity=20);opacity:.2}.close:hover,.close:focus{color:#000;text-decoration:none;cursor:pointer;filter:alpha(opacity=50);opacity:.5}button.close{padding:0;cursor:pointer;background:transparent;border:0;-webkit-appearance:none;-moz-appearance:none;appearance:none}.modal-open{overflow:hidden}.modal{position:fixed;inset:0;z-index:1050;display:none;overflow:hidden;-webkit-overflow-scrolling:touch;outline:0}.modal.fade .modal-dialog{-webkit-transform:translate(0,-25%);-ms-transform:translate(0,-25%);-o-transform:translate(0,-25%);transform:translateY(-25%);-webkit-transition:-webkit-transform .3s ease-out;-o-transition:-o-transform .3s ease-out;transition:-webkit-transform .3s ease-out;transition:transform .3s ease-out;transition:transform .3s ease-out,-webkit-transform .3s ease-out,-o-transform .3s ease-out}.modal.in .modal-dialog{-webkit-transform:translate(0,0);-ms-transform:translate(0,0);-o-transform:translate(0,0);transform:translate(0)}.modal-open .modal{overflow-x:hidden;overflow-y:auto}.modal-dialog{position:relative;width:auto;margin:10px}.modal-content{position:relative;background-color:#fff;background-clip:padding-box;border:1px solid #999;border:1px solid rgba(0,0,0,.2);border-radius:6px;-webkit-box-shadow:0 3px 9px rgba(0,0,0,.5);box-shadow:0 3px 9px #00000080;outline:0}.modal-backdrop{position:fixed;inset:0;z-index:1040;background-color:#000}.modal-backdrop.fade{filter:alpha(opacity=0);opacity:0}.modal-backdrop.in{filter:alpha(opacity=50);opacity:.5}.modal-header{padding:15px;border-bottom:1px solid #e5e5e5}.modal-header .close{margin-top:-2px}.modal-title{margin:0;line-height:1.42857143}.modal-body{position:relative;padding:15px}.modal-footer{padding:15px;text-align:right;border-top:1px solid #e5e5e5}.modal-footer .btn+.btn{margin-bottom:0;margin-left:5px}.modal-footer .btn-group .btn+.btn{margin-left:-1px}.modal-footer .btn-block+.btn-block{margin-left:0}.modal-scrollbar-measure{position:absolute;top:-9999px;width:50px;height:50px;overflow:scroll}@media (min-width: 768px){.modal-dialog{width:600px;margin:30px auto}.modal-content{-webkit-box-shadow:0 5px 15px rgba(0,0,0,.5);box-shadow:0 5px 15px #00000080}.modal-sm{width:300px}}@media (min-width: 992px){.modal-lg{width:900px}}.tooltip{position:absolute;z-index:1070;display:block;font-family:Helvetica Neue,Helvetica,Arial,sans-serif;font-style:normal;font-weight:400;line-height:1.42857143;line-break:auto;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;font-size:12px;filter:alpha(opacity=0);opacity:0}.tooltip.in{filter:alpha(opacity=90);opacity:.9}.tooltip.top{padding:5px 0;margin-top:-3px}.tooltip.right{padding:0 5px;margin-left:3px}.tooltip.bottom{padding:5px 0;margin-top:3px}.tooltip.left{padding:0 5px;margin-left:-3px}.tooltip.top .tooltip-arrow{bottom:0;left:50%;margin-left:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-left .tooltip-arrow{right:5px;bottom:0;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.top-right .tooltip-arrow{bottom:0;left:5px;margin-bottom:-5px;border-width:5px 5px 0;border-top-color:#000}.tooltip.right .tooltip-arrow{top:50%;left:0;margin-top:-5px;border-width:5px 5px 5px 0;border-right-color:#000}.tooltip.left .tooltip-arrow{top:50%;right:0;margin-top:-5px;border-width:5px 0 5px 5px;border-left-color:#000}.tooltip.bottom .tooltip-arrow{top:0;left:50%;margin-left:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-left .tooltip-arrow{top:0;right:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip.bottom-right .tooltip-arrow{top:0;left:5px;margin-top:-5px;border-width:0 5px 5px;border-bottom-color:#000}.tooltip-inner{max-width:200px;padding:3px 8px;color:#fff;text-align:center;background-color:#000;border-radius:4px}.tooltip-arrow{position:absolute;width:0;height:0;border-color:transparent;border-style:solid}.popover{position:absolute;top:0;left:0;z-index:1060;display:none;max-width:276px;padding:1px;font-family:Helvetica Neue,Helvetica,Arial,sans-serif;font-style:normal;font-weight:400;line-height:1.42857143;line-break:auto;text-align:left;text-align:start;text-decoration:none;text-shadow:none;text-transform:none;letter-spacing:normal;word-break:normal;word-spacing:normal;word-wrap:normal;white-space:normal;font-size:14px;background-color:#fff;background-clip:padding-box;border:1px solid #ccc;border:1px solid rgba(0,0,0,.2);border-radius:6px;-webkit-box-shadow:0 5px 10px rgba(0,0,0,.2);box-shadow:0 5px 10px #0003}.popover.top{margin-top:-10px}.popover.right{margin-left:10px}.popover.bottom{margin-top:10px}.popover.left{margin-left:-10px}.popover>.arrow{border-width:11px}.popover>.arrow,.popover>.arrow:after{position:absolute;display:block;width:0;height:0;border-color:transparent;border-style:solid}.popover>.arrow:after{content:"";border-width:10px}.popover.top>.arrow{bottom:-11px;left:50%;margin-left:-11px;border-top-color:#999;border-top-color:#00000040;border-bottom-width:0}.popover.top>.arrow:after{bottom:1px;margin-left:-10px;content:" ";border-top-color:#fff;border-bottom-width:0}.popover.right>.arrow{top:50%;left:-11px;margin-top:-11px;border-right-color:#999;border-right-color:#00000040;border-left-width:0}.popover.right>.arrow:after{bottom:-10px;left:1px;content:" ";border-right-color:#fff;border-left-width:0}.popover.bottom>.arrow{top:-11px;left:50%;margin-left:-11px;border-top-width:0;border-bottom-color:#999;border-bottom-color:#00000040}.popover.bottom>.arrow:after{top:1px;margin-left:-10px;content:" ";border-top-width:0;border-bottom-color:#fff}.popover.left>.arrow{top:50%;right:-11px;margin-top:-11px;border-right-width:0;border-left-color:#999;border-left-color:#00000040}.popover.left>.arrow:after{right:1px;bottom:-10px;content:" ";border-right-width:0;border-left-color:#fff}.popover-title{padding:8px 14px;margin:0;font-size:14px;background-color:#f7f7f7;border-bottom:1px solid #ebebeb;border-radius:5px 5px 0 0}.popover-content{padding:9px 14px}.carousel{position:relative}.carousel-inner{position:relative;width:100%;overflow:hidden}.carousel-inner>.item{position:relative;display:none;-webkit-transition:.6s ease-in-out left;-o-transition:.6s ease-in-out left;transition:.6s ease-in-out left}.carousel-inner>.item>img,.carousel-inner>.item>a>img{line-height:1}@media all and (transform-3d),(-webkit-transform-3d){.carousel-inner>.item{-webkit-transition:-webkit-transform .6s ease-in-out;-o-transition:-o-transform .6s ease-in-out;transition:-webkit-transform .6s ease-in-out;transition:transform .6s ease-in-out;transition:transform .6s ease-in-out,-webkit-transform .6s ease-in-out,-o-transform .6s ease-in-out;-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-perspective:1000px;perspective:1000px}.carousel-inner>.item.next,.carousel-inner>.item.active.right{-webkit-transform:translate3d(100%,0,0);transform:translate3d(100%,0,0);left:0}.carousel-inner>.item.prev,.carousel-inner>.item.active.left{-webkit-transform:translate3d(-100%,0,0);transform:translate3d(-100%,0,0);left:0}.carousel-inner>.item.next.left,.carousel-inner>.item.prev.right,.carousel-inner>.item.active{-webkit-transform:translate3d(0,0,0);transform:translateZ(0);left:0}}.carousel-inner>.active,.carousel-inner>.next,.carousel-inner>.prev{display:block}.carousel-inner>.active{left:0}.carousel-inner>.next,.carousel-inner>.prev{position:absolute;top:0;width:100%}.carousel-inner>.next{left:100%}.carousel-inner>.prev{left:-100%}.carousel-inner>.next.left,.carousel-inner>.prev.right{left:0}.carousel-inner>.active.left{left:-100%}.carousel-inner>.active.right{left:100%}.carousel-control{position:absolute;top:0;bottom:0;left:0;width:15%;font-size:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6);background-color:#0000;filter:alpha(opacity=50);opacity:.5}.carousel-control.left{background-image:-webkit-linear-gradient(left,rgba(0,0,0,.5) 0%,rgba(0,0,0,.0001) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.5) 0%,rgba(0,0,0,.0001) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001)));background-image:linear-gradient(to right,#00000080,#0000);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr="#80000000",endColorstr="#00000000",GradientType=1);background-repeat:repeat-x}.carousel-control.right{right:0;left:auto;background-image:-webkit-linear-gradient(left,rgba(0,0,0,.0001) 0%,rgba(0,0,0,.5) 100%);background-image:-o-linear-gradient(left,rgba(0,0,0,.0001) 0%,rgba(0,0,0,.5) 100%);background-image:-webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5)));background-image:linear-gradient(to right,#0000,#00000080);filter:progid:DXImageTransform.Microsoft.gradient(startColorstr="#00000000",endColorstr="#80000000",GradientType=1);background-repeat:repeat-x}.carousel-control:hover,.carousel-control:focus{color:#fff;text-decoration:none;outline:0;filter:alpha(opacity=90);opacity:.9}.carousel-control .icon-prev,.carousel-control .icon-next,.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right{position:absolute;top:50%;z-index:5;display:inline-block;margin-top:-10px}.carousel-control .icon-prev,.carousel-control .glyphicon-chevron-left{left:50%;margin-left:-10px}.carousel-control .icon-next,.carousel-control .glyphicon-chevron-right{right:50%;margin-right:-10px}.carousel-control .icon-prev,.carousel-control .icon-next{width:20px;height:20px;font-family:serif;line-height:1}.carousel-control .icon-prev:before{content:"\2039"}.carousel-control .icon-next:before{content:"\203a"}.carousel-indicators{position:absolute;bottom:10px;left:50%;z-index:15;width:60%;padding-left:0;margin-left:-30%;text-align:center;list-style:none}.carousel-indicators li{display:inline-block;width:10px;height:10px;margin:1px;text-indent:-999px;cursor:pointer;background-color:#000 \ ;background-color:#0000;border:1px solid #fff;border-radius:10px}.carousel-indicators .active{width:12px;height:12px;margin:0;background-color:#fff}.carousel-caption{position:absolute;right:15%;bottom:20px;left:15%;z-index:10;padding-top:20px;padding-bottom:20px;color:#fff;text-align:center;text-shadow:0 1px 2px rgba(0,0,0,.6)}.carousel-caption .btn{text-shadow:none}@media screen and (min-width: 768px){.carousel-control .glyphicon-chevron-left,.carousel-control .glyphicon-chevron-right,.carousel-control .icon-prev,.carousel-control .icon-next{width:30px;height:30px;margin-top:-10px;font-size:30px}.carousel-control .glyphicon-chevron-left,.carousel-control .icon-prev{margin-left:-10px}.carousel-control .glyphicon-chevron-right,.carousel-control .icon-next{margin-right:-10px}.carousel-caption{right:20%;left:20%;padding-bottom:30px}.carousel-indicators{bottom:20px}}.clearfix:before,.clearfix:after,.dl-horizontal dd:before,.dl-horizontal dd:after,.container:before,.container:after,.container-fluid:before,.container-fluid:after,.row:before,.row:after,.form-horizontal .form-group:before,.form-horizontal .form-group:after,.btn-toolbar:before,.btn-toolbar:after,.btn-group-vertical>.btn-group:before,.btn-group-vertical>.btn-group:after,.nav:before,.nav:after,.navbar:before,.navbar:after,.navbar-header:before,.navbar-header:after,.navbar-collapse:before,.navbar-collapse:after,.pager:before,.pager:after,.panel-body:before,.panel-body:after,.modal-header:before,.modal-header:after,.modal-footer:before,.modal-footer:after{display:table;content:" "}.clearfix:after,.dl-horizontal dd:after,.container:after,.container-fluid:after,.row:after,.form-horizontal .form-group:after,.btn-toolbar:after,.btn-group-vertical>.btn-group:after,.nav:after,.navbar:after,.navbar-header:after,.navbar-collapse:after,.pager:after,.panel-body:after,.modal-header:after,.modal-footer:after{clear:both}.center-block{display:block;margin-right:auto;margin-left:auto}.pull-right{float:right!important}.pull-left{float:left!important}.hide{display:none!important}.show{display:block!important}.invisible{visibility:hidden}.text-hide{font:0/0 a;color:transparent;text-shadow:none;background-color:transparent;border:0}.hidden{display:none!important}.affix{position:fixed}@-ms-viewport{width:device-width}.visible-xs,.visible-sm,.visible-md,.visible-lg,.visible-xs-block,.visible-xs-inline,.visible-xs-inline-block,.visible-sm-block,.visible-sm-inline,.visible-sm-inline-block,.visible-md-block,.visible-md-inline,.visible-md-inline-block,.visible-lg-block,.visible-lg-inline,.visible-lg-inline-block{display:none!important}@media (max-width: 767px){.visible-xs{display:block!important}table.visible-xs{display:table!important}tr.visible-xs{display:table-row!important}th.visible-xs,td.visible-xs{display:table-cell!important}}@media (max-width: 767px){.visible-xs-block{display:block!important}}@media (max-width: 767px){.visible-xs-inline{display:inline!important}}@media (max-width: 767px){.visible-xs-inline-block{display:inline-block!important}}@media (min-width: 768px) and (max-width: 991px){.visible-sm{display:block!important}table.visible-sm{display:table!important}tr.visible-sm{display:table-row!important}th.visible-sm,td.visible-sm{display:table-cell!important}}@media (min-width: 768px) and (max-width: 991px){.visible-sm-block{display:block!important}}@media (min-width: 768px) and (max-width: 991px){.visible-sm-inline{display:inline!important}}@media (min-width: 768px) and (max-width: 991px){.visible-sm-inline-block{display:inline-block!important}}@media (min-width: 992px) and (max-width: 1199px){.visible-md{display:block!important}table.visible-md{display:table!important}tr.visible-md{display:table-row!important}th.visible-md,td.visible-md{display:table-cell!important}}@media (min-width: 992px) and (max-width: 1199px){.visible-md-block{display:block!important}}@media (min-width: 992px) and (max-width: 1199px){.visible-md-inline{display:inline!important}}@media (min-width: 992px) and (max-width: 1199px){.visible-md-inline-block{display:inline-block!important}}@media (min-width: 1200px){.visible-lg{display:block!important}table.visible-lg{display:table!important}tr.visible-lg{display:table-row!important}th.visible-lg,td.visible-lg{display:table-cell!important}}@media (min-width: 1200px){.visible-lg-block{display:block!important}}@media (min-width: 1200px){.visible-lg-inline{display:inline!important}}@media (min-width: 1200px){.visible-lg-inline-block{display:inline-block!important}}@media (max-width: 767px){.hidden-xs{display:none!important}}@media (min-width: 768px) and (max-width: 991px){.hidden-sm{display:none!important}}@media (min-width: 992px) and (max-width: 1199px){.hidden-md{display:none!important}}@media (min-width: 1200px){.hidden-lg{display:none!important}}.visible-print{display:none!important}@media print{.visible-print{display:block!important}table.visible-print{display:table!important}tr.visible-print{display:table-row!important}th.visible-print,td.visible-print{display:table-cell!important}}.visible-print-block{display:none!important}@media print{.visible-print-block{display:block!important}}.visible-print-inline{display:none!important}@media print{.visible-print-inline{display:inline!important}}.visible-print-inline-block{display:none!important}@media print{.visible-print-inline-block{display:inline-block!important}}@media print{.hidden-print{display:none!important}}pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}.hljs{color:#24292e;background:#fff}.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-template-tag,.hljs-template-variable,.hljs-type,.hljs-variable.language_{color:#d73a49}.hljs-title,.hljs-title.class_,.hljs-title.class_.inherited__,.hljs-title.function_{color:#6f42c1}.hljs-attr,.hljs-attribute,.hljs-literal,.hljs-meta,.hljs-number,.hljs-operator,.hljs-selector-attr,.hljs-selector-class,.hljs-selector-id,.hljs-variable{color:#005cc5}.hljs-meta .hljs-string,.hljs-regexp,.hljs-string{color:#032f62}.hljs-built_in,.hljs-symbol{color:#e36209}.hljs-code,.hljs-comment,.hljs-formula{color:#6a737d}.hljs-name,.hljs-quote,.hljs-selector-pseudo,.hljs-selector-tag{color:#22863a}.hljs-subst{color:#24292e}.hljs-section{color:#005cc5;font-weight:700}.hljs-bullet{color:#735c0f}.hljs-emphasis{color:#24292e;font-style:italic}.hljs-strong{color:#24292e;font-weight:700}.hljs-addition{color:#22863a;background-color:#f0fff4}.hljs-deletion{color:#b31d28;background-color:#ffeef0} +/*! Bundled license information: + +@default/bootstrap/dist/css/bootstrap.css: + (*! + * Bootstrap v3.4.1 (https://getbootstrap.com/) + * Copyright 2011-2019 Twitter, Inc. + * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) + *) + (*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css *) + (*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css *) + +@default/highlight.js/styles/github.css: + (*! + Theme: GitHub + Description: Light theme as seen on github.com + Author: github.com + Maintainer: @Hirse + Updated: 2021-05-15 + + Outdated base version: https://github.com/primer/github-syntax-light + Current colors taken from GitHub's CSS + *) +*/ +/*# sourceMappingURL=docfx.vendor.min.css.map */ diff --git a/RWSTemplate/styles/docfx.vendor.min.css.map b/RWSTemplate/styles/docfx.vendor.min.css.map new file mode 100644 index 0000000..abba940 --- /dev/null +++ b/RWSTemplate/styles/docfx.vendor.min.css.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["../../node_modules/@default/bootstrap/dist/css/bootstrap.css", "../../node_modules/@default/bootstrap/dist/css/less/normalize.less", "../../node_modules/@default/bootstrap/dist/css/less/print.less", "../../node_modules/@default/bootstrap/dist/css/less/glyphicons.less", "../../node_modules/@default/bootstrap/dist/css/less/scaffolding.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/vendor-prefixes.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/tab-focus.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/image.less", "../../node_modules/@default/bootstrap/dist/css/less/type.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/text-emphasis.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/background-variant.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/text-overflow.less", "../../node_modules/@default/bootstrap/dist/css/less/code.less", "../../node_modules/@default/bootstrap/dist/css/less/grid.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/grid.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/grid-framework.less", "../../node_modules/@default/bootstrap/dist/css/less/tables.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/table-row.less", "../../node_modules/@default/bootstrap/dist/css/less/forms.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/forms.less", "../../node_modules/@default/bootstrap/dist/css/less/buttons.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/buttons.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/opacity.less", "../../node_modules/@default/bootstrap/dist/css/less/component-animations.less", "../../node_modules/@default/bootstrap/dist/css/less/dropdowns.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/nav-divider.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/reset-filter.less", "../../node_modules/@default/bootstrap/dist/css/less/button-groups.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/border-radius.less", "../../node_modules/@default/bootstrap/dist/css/less/input-groups.less", "../../node_modules/@default/bootstrap/dist/css/less/navs.less", "../../node_modules/@default/bootstrap/dist/css/less/navbar.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/nav-vertical-align.less", "../../node_modules/@default/bootstrap/dist/css/less/utilities.less", "../../node_modules/@default/bootstrap/dist/css/less/breadcrumbs.less", "../../node_modules/@default/bootstrap/dist/css/less/pagination.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/pagination.less", "../../node_modules/@default/bootstrap/dist/css/less/pager.less", "../../node_modules/@default/bootstrap/dist/css/less/labels.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/labels.less", "../../node_modules/@default/bootstrap/dist/css/less/badges.less", "../../node_modules/@default/bootstrap/dist/css/less/jumbotron.less", "../../node_modules/@default/bootstrap/dist/css/less/thumbnails.less", "../../node_modules/@default/bootstrap/dist/css/less/alerts.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/alerts.less", "../../node_modules/@default/bootstrap/dist/css/less/progress-bars.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/gradients.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/progress-bar.less", "../../node_modules/@default/bootstrap/dist/css/less/media.less", "../../node_modules/@default/bootstrap/dist/css/less/list-group.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/list-group.less", "../../node_modules/@default/bootstrap/dist/css/less/panels.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/panels.less", "../../node_modules/@default/bootstrap/dist/css/less/responsive-embed.less", "../../node_modules/@default/bootstrap/dist/css/less/wells.less", "../../node_modules/@default/bootstrap/dist/css/less/close.less", "../../node_modules/@default/bootstrap/dist/css/less/modals.less", "../../node_modules/@default/bootstrap/dist/css/less/tooltip.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/reset-text.less", "../../node_modules/@default/bootstrap/dist/css/less/popovers.less", "../../node_modules/@default/bootstrap/dist/css/less/carousel.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/clearfix.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/center-block.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/hide-text.less", "../../node_modules/@default/bootstrap/dist/css/less/responsive-utilities.less", "../../node_modules/@default/bootstrap/dist/css/less/mixins/responsive-visibility.less", "../../node_modules/@default/highlight.js/styles/github.css"], + "sourcesContent": ["/*!\n * Bootstrap v3.4.1 (https://getbootstrap.com/)\n * Copyright 2011-2019 Twitter, Inc.\n * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)\n */\n/*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */\nhtml {\n font-family: sans-serif;\n -ms-text-size-adjust: 100%;\n -webkit-text-size-adjust: 100%;\n}\nbody {\n margin: 0;\n}\narticle,\naside,\ndetails,\nfigcaption,\nfigure,\nfooter,\nheader,\nhgroup,\nmain,\nmenu,\nnav,\nsection,\nsummary {\n display: block;\n}\naudio,\ncanvas,\nprogress,\nvideo {\n display: inline-block;\n vertical-align: baseline;\n}\naudio:not([controls]) {\n display: none;\n height: 0;\n}\n[hidden],\ntemplate {\n display: none;\n}\na {\n background-color: transparent;\n}\na:active,\na:hover {\n outline: 0;\n}\nabbr[title] {\n border-bottom: none;\n text-decoration: underline;\n text-decoration: underline dotted;\n}\nb,\nstrong {\n font-weight: bold;\n}\ndfn {\n font-style: italic;\n}\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\nmark {\n background: #ff0;\n color: #000;\n}\nsmall {\n font-size: 80%;\n}\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\nsup {\n top: -0.5em;\n}\nsub {\n bottom: -0.25em;\n}\nimg {\n border: 0;\n}\nsvg:not(:root) {\n overflow: hidden;\n}\nfigure {\n margin: 1em 40px;\n}\nhr {\n box-sizing: content-box;\n height: 0;\n}\npre {\n overflow: auto;\n}\ncode,\nkbd,\npre,\nsamp {\n font-family: monospace, monospace;\n font-size: 1em;\n}\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n color: inherit;\n font: inherit;\n margin: 0;\n}\nbutton {\n overflow: visible;\n}\nbutton,\nselect {\n text-transform: none;\n}\nbutton,\nhtml input[type=\"button\"],\ninput[type=\"reset\"],\ninput[type=\"submit\"] {\n -webkit-appearance: button;\n cursor: pointer;\n}\nbutton[disabled],\nhtml input[disabled] {\n cursor: default;\n}\nbutton::-moz-focus-inner,\ninput::-moz-focus-inner {\n border: 0;\n padding: 0;\n}\ninput {\n line-height: normal;\n}\ninput[type=\"checkbox\"],\ninput[type=\"radio\"] {\n box-sizing: border-box;\n padding: 0;\n}\ninput[type=\"number\"]::-webkit-inner-spin-button,\ninput[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\ninput[type=\"search\"] {\n -webkit-appearance: textfield;\n box-sizing: content-box;\n}\ninput[type=\"search\"]::-webkit-search-cancel-button,\ninput[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\nfieldset {\n border: 1px solid #c0c0c0;\n margin: 0 2px;\n padding: 0.35em 0.625em 0.75em;\n}\nlegend {\n border: 0;\n padding: 0;\n}\ntextarea {\n overflow: auto;\n}\noptgroup {\n font-weight: bold;\n}\ntable {\n border-collapse: collapse;\n border-spacing: 0;\n}\ntd,\nth {\n padding: 0;\n}\n/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */\n@media print {\n *,\n *:before,\n *:after {\n color: #000 !important;\n text-shadow: none !important;\n background: transparent !important;\n box-shadow: none !important;\n }\n a,\n a:visited {\n text-decoration: underline;\n }\n a[href]:after {\n content: \" (\" attr(href) \")\";\n }\n abbr[title]:after {\n content: \" (\" attr(title) \")\";\n }\n a[href^=\"#\"]:after,\n a[href^=\"javascript:\"]:after {\n content: \"\";\n }\n pre,\n blockquote {\n border: 1px solid #999;\n page-break-inside: avoid;\n }\n thead {\n display: table-header-group;\n }\n tr,\n img {\n page-break-inside: avoid;\n }\n img {\n max-width: 100% !important;\n }\n p,\n h2,\n h3 {\n orphans: 3;\n widows: 3;\n }\n h2,\n h3 {\n page-break-after: avoid;\n }\n .navbar {\n display: none;\n }\n .btn > .caret,\n .dropup > .btn > .caret {\n border-top-color: #000 !important;\n }\n .label {\n border: 1px solid #000;\n }\n .table {\n border-collapse: collapse !important;\n }\n .table td,\n .table th {\n background-color: #fff !important;\n }\n .table-bordered th,\n .table-bordered td {\n border: 1px solid #ddd !important;\n }\n}\n@font-face {\n font-family: \"Glyphicons Halflings\";\n src: url(\"../fonts/glyphicons-halflings-regular.eot\");\n src: url(\"../fonts/glyphicons-halflings-regular.eot?#iefix\") format(\"embedded-opentype\"), url(\"../fonts/glyphicons-halflings-regular.woff2\") format(\"woff2\"), url(\"../fonts/glyphicons-halflings-regular.woff\") format(\"woff\"), url(\"../fonts/glyphicons-halflings-regular.ttf\") format(\"truetype\"), url(\"../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular\") format(\"svg\");\n}\n.glyphicon {\n position: relative;\n top: 1px;\n display: inline-block;\n font-family: \"Glyphicons Halflings\";\n font-style: normal;\n font-weight: 400;\n line-height: 1;\n -webkit-font-smoothing: antialiased;\n -moz-osx-font-smoothing: grayscale;\n}\n.glyphicon-asterisk:before {\n content: \"\\002a\";\n}\n.glyphicon-plus:before {\n content: \"\\002b\";\n}\n.glyphicon-euro:before,\n.glyphicon-eur:before {\n content: \"\\20ac\";\n}\n.glyphicon-minus:before {\n content: \"\\2212\";\n}\n.glyphicon-cloud:before {\n content: \"\\2601\";\n}\n.glyphicon-envelope:before {\n content: \"\\2709\";\n}\n.glyphicon-pencil:before {\n content: \"\\270f\";\n}\n.glyphicon-glass:before {\n content: \"\\e001\";\n}\n.glyphicon-music:before {\n content: \"\\e002\";\n}\n.glyphicon-search:before {\n content: \"\\e003\";\n}\n.glyphicon-heart:before {\n content: \"\\e005\";\n}\n.glyphicon-star:before {\n content: \"\\e006\";\n}\n.glyphicon-star-empty:before {\n content: \"\\e007\";\n}\n.glyphicon-user:before {\n content: \"\\e008\";\n}\n.glyphicon-film:before {\n content: \"\\e009\";\n}\n.glyphicon-th-large:before {\n content: \"\\e010\";\n}\n.glyphicon-th:before {\n content: \"\\e011\";\n}\n.glyphicon-th-list:before {\n content: \"\\e012\";\n}\n.glyphicon-ok:before {\n content: \"\\e013\";\n}\n.glyphicon-remove:before {\n content: \"\\e014\";\n}\n.glyphicon-zoom-in:before {\n content: \"\\e015\";\n}\n.glyphicon-zoom-out:before {\n content: \"\\e016\";\n}\n.glyphicon-off:before {\n content: \"\\e017\";\n}\n.glyphicon-signal:before {\n content: \"\\e018\";\n}\n.glyphicon-cog:before {\n content: \"\\e019\";\n}\n.glyphicon-trash:before {\n content: \"\\e020\";\n}\n.glyphicon-home:before {\n content: \"\\e021\";\n}\n.glyphicon-file:before {\n content: \"\\e022\";\n}\n.glyphicon-time:before {\n content: \"\\e023\";\n}\n.glyphicon-road:before {\n content: \"\\e024\";\n}\n.glyphicon-download-alt:before {\n content: \"\\e025\";\n}\n.glyphicon-download:before {\n content: \"\\e026\";\n}\n.glyphicon-upload:before {\n content: \"\\e027\";\n}\n.glyphicon-inbox:before {\n content: \"\\e028\";\n}\n.glyphicon-play-circle:before {\n content: \"\\e029\";\n}\n.glyphicon-repeat:before {\n content: \"\\e030\";\n}\n.glyphicon-refresh:before {\n content: \"\\e031\";\n}\n.glyphicon-list-alt:before {\n content: \"\\e032\";\n}\n.glyphicon-lock:before {\n content: \"\\e033\";\n}\n.glyphicon-flag:before {\n content: \"\\e034\";\n}\n.glyphicon-headphones:before {\n content: \"\\e035\";\n}\n.glyphicon-volume-off:before {\n content: \"\\e036\";\n}\n.glyphicon-volume-down:before {\n content: \"\\e037\";\n}\n.glyphicon-volume-up:before {\n content: \"\\e038\";\n}\n.glyphicon-qrcode:before {\n content: \"\\e039\";\n}\n.glyphicon-barcode:before {\n content: \"\\e040\";\n}\n.glyphicon-tag:before {\n content: \"\\e041\";\n}\n.glyphicon-tags:before {\n content: \"\\e042\";\n}\n.glyphicon-book:before {\n content: \"\\e043\";\n}\n.glyphicon-bookmark:before {\n content: \"\\e044\";\n}\n.glyphicon-print:before {\n content: \"\\e045\";\n}\n.glyphicon-camera:before {\n content: \"\\e046\";\n}\n.glyphicon-font:before {\n content: \"\\e047\";\n}\n.glyphicon-bold:before {\n content: \"\\e048\";\n}\n.glyphicon-italic:before {\n content: \"\\e049\";\n}\n.glyphicon-text-height:before {\n content: \"\\e050\";\n}\n.glyphicon-text-width:before {\n content: \"\\e051\";\n}\n.glyphicon-align-left:before {\n content: \"\\e052\";\n}\n.glyphicon-align-center:before {\n content: \"\\e053\";\n}\n.glyphicon-align-right:before {\n content: \"\\e054\";\n}\n.glyphicon-align-justify:before {\n content: \"\\e055\";\n}\n.glyphicon-list:before {\n content: \"\\e056\";\n}\n.glyphicon-indent-left:before {\n content: \"\\e057\";\n}\n.glyphicon-indent-right:before {\n content: \"\\e058\";\n}\n.glyphicon-facetime-video:before {\n content: \"\\e059\";\n}\n.glyphicon-picture:before {\n content: \"\\e060\";\n}\n.glyphicon-map-marker:before {\n content: \"\\e062\";\n}\n.glyphicon-adjust:before {\n content: \"\\e063\";\n}\n.glyphicon-tint:before {\n content: \"\\e064\";\n}\n.glyphicon-edit:before {\n content: \"\\e065\";\n}\n.glyphicon-share:before {\n content: \"\\e066\";\n}\n.glyphicon-check:before {\n content: \"\\e067\";\n}\n.glyphicon-move:before {\n content: \"\\e068\";\n}\n.glyphicon-step-backward:before {\n content: \"\\e069\";\n}\n.glyphicon-fast-backward:before {\n content: \"\\e070\";\n}\n.glyphicon-backward:before {\n content: \"\\e071\";\n}\n.glyphicon-play:before {\n content: \"\\e072\";\n}\n.glyphicon-pause:before {\n content: \"\\e073\";\n}\n.glyphicon-stop:before {\n content: \"\\e074\";\n}\n.glyphicon-forward:before {\n content: \"\\e075\";\n}\n.glyphicon-fast-forward:before {\n content: \"\\e076\";\n}\n.glyphicon-step-forward:before {\n content: \"\\e077\";\n}\n.glyphicon-eject:before {\n content: \"\\e078\";\n}\n.glyphicon-chevron-left:before {\n content: \"\\e079\";\n}\n.glyphicon-chevron-right:before {\n content: \"\\e080\";\n}\n.glyphicon-plus-sign:before {\n content: \"\\e081\";\n}\n.glyphicon-minus-sign:before {\n content: \"\\e082\";\n}\n.glyphicon-remove-sign:before {\n content: \"\\e083\";\n}\n.glyphicon-ok-sign:before {\n content: \"\\e084\";\n}\n.glyphicon-question-sign:before {\n content: \"\\e085\";\n}\n.glyphicon-info-sign:before {\n content: \"\\e086\";\n}\n.glyphicon-screenshot:before {\n content: \"\\e087\";\n}\n.glyphicon-remove-circle:before {\n content: \"\\e088\";\n}\n.glyphicon-ok-circle:before {\n content: \"\\e089\";\n}\n.glyphicon-ban-circle:before {\n content: \"\\e090\";\n}\n.glyphicon-arrow-left:before {\n content: \"\\e091\";\n}\n.glyphicon-arrow-right:before {\n content: \"\\e092\";\n}\n.glyphicon-arrow-up:before {\n content: \"\\e093\";\n}\n.glyphicon-arrow-down:before {\n content: \"\\e094\";\n}\n.glyphicon-share-alt:before {\n content: \"\\e095\";\n}\n.glyphicon-resize-full:before {\n content: \"\\e096\";\n}\n.glyphicon-resize-small:before {\n content: \"\\e097\";\n}\n.glyphicon-exclamation-sign:before {\n content: \"\\e101\";\n}\n.glyphicon-gift:before {\n content: \"\\e102\";\n}\n.glyphicon-leaf:before {\n content: \"\\e103\";\n}\n.glyphicon-fire:before {\n content: \"\\e104\";\n}\n.glyphicon-eye-open:before {\n content: \"\\e105\";\n}\n.glyphicon-eye-close:before {\n content: \"\\e106\";\n}\n.glyphicon-warning-sign:before {\n content: \"\\e107\";\n}\n.glyphicon-plane:before {\n content: \"\\e108\";\n}\n.glyphicon-calendar:before {\n content: \"\\e109\";\n}\n.glyphicon-random:before {\n content: \"\\e110\";\n}\n.glyphicon-comment:before {\n content: \"\\e111\";\n}\n.glyphicon-magnet:before {\n content: \"\\e112\";\n}\n.glyphicon-chevron-up:before {\n content: \"\\e113\";\n}\n.glyphicon-chevron-down:before {\n content: \"\\e114\";\n}\n.glyphicon-retweet:before {\n content: \"\\e115\";\n}\n.glyphicon-shopping-cart:before {\n content: \"\\e116\";\n}\n.glyphicon-folder-close:before {\n content: \"\\e117\";\n}\n.glyphicon-folder-open:before {\n content: \"\\e118\";\n}\n.glyphicon-resize-vertical:before {\n content: \"\\e119\";\n}\n.glyphicon-resize-horizontal:before {\n content: \"\\e120\";\n}\n.glyphicon-hdd:before {\n content: \"\\e121\";\n}\n.glyphicon-bullhorn:before {\n content: \"\\e122\";\n}\n.glyphicon-bell:before {\n content: \"\\e123\";\n}\n.glyphicon-certificate:before {\n content: \"\\e124\";\n}\n.glyphicon-thumbs-up:before {\n content: \"\\e125\";\n}\n.glyphicon-thumbs-down:before {\n content: \"\\e126\";\n}\n.glyphicon-hand-right:before {\n content: \"\\e127\";\n}\n.glyphicon-hand-left:before {\n content: \"\\e128\";\n}\n.glyphicon-hand-up:before {\n content: \"\\e129\";\n}\n.glyphicon-hand-down:before {\n content: \"\\e130\";\n}\n.glyphicon-circle-arrow-right:before {\n content: \"\\e131\";\n}\n.glyphicon-circle-arrow-left:before {\n content: \"\\e132\";\n}\n.glyphicon-circle-arrow-up:before {\n content: \"\\e133\";\n}\n.glyphicon-circle-arrow-down:before {\n content: \"\\e134\";\n}\n.glyphicon-globe:before {\n content: \"\\e135\";\n}\n.glyphicon-wrench:before {\n content: \"\\e136\";\n}\n.glyphicon-tasks:before {\n content: \"\\e137\";\n}\n.glyphicon-filter:before {\n content: \"\\e138\";\n}\n.glyphicon-briefcase:before {\n content: \"\\e139\";\n}\n.glyphicon-fullscreen:before {\n content: \"\\e140\";\n}\n.glyphicon-dashboard:before {\n content: \"\\e141\";\n}\n.glyphicon-paperclip:before {\n content: \"\\e142\";\n}\n.glyphicon-heart-empty:before {\n content: \"\\e143\";\n}\n.glyphicon-link:before {\n content: \"\\e144\";\n}\n.glyphicon-phone:before {\n content: \"\\e145\";\n}\n.glyphicon-pushpin:before {\n content: \"\\e146\";\n}\n.glyphicon-usd:before {\n content: \"\\e148\";\n}\n.glyphicon-gbp:before {\n content: \"\\e149\";\n}\n.glyphicon-sort:before {\n content: \"\\e150\";\n}\n.glyphicon-sort-by-alphabet:before {\n content: \"\\e151\";\n}\n.glyphicon-sort-by-alphabet-alt:before {\n content: \"\\e152\";\n}\n.glyphicon-sort-by-order:before {\n content: \"\\e153\";\n}\n.glyphicon-sort-by-order-alt:before {\n content: \"\\e154\";\n}\n.glyphicon-sort-by-attributes:before {\n content: \"\\e155\";\n}\n.glyphicon-sort-by-attributes-alt:before {\n content: \"\\e156\";\n}\n.glyphicon-unchecked:before {\n content: \"\\e157\";\n}\n.glyphicon-expand:before {\n content: \"\\e158\";\n}\n.glyphicon-collapse-down:before {\n content: \"\\e159\";\n}\n.glyphicon-collapse-up:before {\n content: \"\\e160\";\n}\n.glyphicon-log-in:before {\n content: \"\\e161\";\n}\n.glyphicon-flash:before {\n content: \"\\e162\";\n}\n.glyphicon-log-out:before {\n content: \"\\e163\";\n}\n.glyphicon-new-window:before {\n content: \"\\e164\";\n}\n.glyphicon-record:before {\n content: \"\\e165\";\n}\n.glyphicon-save:before {\n content: \"\\e166\";\n}\n.glyphicon-open:before {\n content: \"\\e167\";\n}\n.glyphicon-saved:before {\n content: \"\\e168\";\n}\n.glyphicon-import:before {\n content: \"\\e169\";\n}\n.glyphicon-export:before {\n content: \"\\e170\";\n}\n.glyphicon-send:before {\n content: \"\\e171\";\n}\n.glyphicon-floppy-disk:before {\n content: \"\\e172\";\n}\n.glyphicon-floppy-saved:before {\n content: \"\\e173\";\n}\n.glyphicon-floppy-remove:before {\n content: \"\\e174\";\n}\n.glyphicon-floppy-save:before {\n content: \"\\e175\";\n}\n.glyphicon-floppy-open:before {\n content: \"\\e176\";\n}\n.glyphicon-credit-card:before {\n content: \"\\e177\";\n}\n.glyphicon-transfer:before {\n content: \"\\e178\";\n}\n.glyphicon-cutlery:before {\n content: \"\\e179\";\n}\n.glyphicon-header:before {\n content: \"\\e180\";\n}\n.glyphicon-compressed:before {\n content: \"\\e181\";\n}\n.glyphicon-earphone:before {\n content: \"\\e182\";\n}\n.glyphicon-phone-alt:before {\n content: \"\\e183\";\n}\n.glyphicon-tower:before {\n content: \"\\e184\";\n}\n.glyphicon-stats:before {\n content: \"\\e185\";\n}\n.glyphicon-sd-video:before {\n content: \"\\e186\";\n}\n.glyphicon-hd-video:before {\n content: \"\\e187\";\n}\n.glyphicon-subtitles:before {\n content: \"\\e188\";\n}\n.glyphicon-sound-stereo:before {\n content: \"\\e189\";\n}\n.glyphicon-sound-dolby:before {\n content: \"\\e190\";\n}\n.glyphicon-sound-5-1:before {\n content: \"\\e191\";\n}\n.glyphicon-sound-6-1:before {\n content: \"\\e192\";\n}\n.glyphicon-sound-7-1:before {\n content: \"\\e193\";\n}\n.glyphicon-copyright-mark:before {\n content: \"\\e194\";\n}\n.glyphicon-registration-mark:before {\n content: \"\\e195\";\n}\n.glyphicon-cloud-download:before {\n content: \"\\e197\";\n}\n.glyphicon-cloud-upload:before {\n content: \"\\e198\";\n}\n.glyphicon-tree-conifer:before {\n content: \"\\e199\";\n}\n.glyphicon-tree-deciduous:before {\n content: \"\\e200\";\n}\n.glyphicon-cd:before {\n content: \"\\e201\";\n}\n.glyphicon-save-file:before {\n content: \"\\e202\";\n}\n.glyphicon-open-file:before {\n content: \"\\e203\";\n}\n.glyphicon-level-up:before {\n content: \"\\e204\";\n}\n.glyphicon-copy:before {\n content: \"\\e205\";\n}\n.glyphicon-paste:before {\n content: \"\\e206\";\n}\n.glyphicon-alert:before {\n content: \"\\e209\";\n}\n.glyphicon-equalizer:before {\n content: \"\\e210\";\n}\n.glyphicon-king:before {\n content: \"\\e211\";\n}\n.glyphicon-queen:before {\n content: \"\\e212\";\n}\n.glyphicon-pawn:before {\n content: \"\\e213\";\n}\n.glyphicon-bishop:before {\n content: \"\\e214\";\n}\n.glyphicon-knight:before {\n content: \"\\e215\";\n}\n.glyphicon-baby-formula:before {\n content: \"\\e216\";\n}\n.glyphicon-tent:before {\n content: \"\\26fa\";\n}\n.glyphicon-blackboard:before {\n content: \"\\e218\";\n}\n.glyphicon-bed:before {\n content: \"\\e219\";\n}\n.glyphicon-apple:before {\n content: \"\\f8ff\";\n}\n.glyphicon-erase:before {\n content: \"\\e221\";\n}\n.glyphicon-hourglass:before {\n content: \"\\231b\";\n}\n.glyphicon-lamp:before {\n content: \"\\e223\";\n}\n.glyphicon-duplicate:before {\n content: \"\\e224\";\n}\n.glyphicon-piggy-bank:before {\n content: \"\\e225\";\n}\n.glyphicon-scissors:before {\n content: \"\\e226\";\n}\n.glyphicon-bitcoin:before {\n content: \"\\e227\";\n}\n.glyphicon-btc:before {\n content: \"\\e227\";\n}\n.glyphicon-xbt:before {\n content: \"\\e227\";\n}\n.glyphicon-yen:before {\n content: \"\\00a5\";\n}\n.glyphicon-jpy:before {\n content: \"\\00a5\";\n}\n.glyphicon-ruble:before {\n content: \"\\20bd\";\n}\n.glyphicon-rub:before {\n content: \"\\20bd\";\n}\n.glyphicon-scale:before {\n content: \"\\e230\";\n}\n.glyphicon-ice-lolly:before {\n content: \"\\e231\";\n}\n.glyphicon-ice-lolly-tasted:before {\n content: \"\\e232\";\n}\n.glyphicon-education:before {\n content: \"\\e233\";\n}\n.glyphicon-option-horizontal:before {\n content: \"\\e234\";\n}\n.glyphicon-option-vertical:before {\n content: \"\\e235\";\n}\n.glyphicon-menu-hamburger:before {\n content: \"\\e236\";\n}\n.glyphicon-modal-window:before {\n content: \"\\e237\";\n}\n.glyphicon-oil:before {\n content: \"\\e238\";\n}\n.glyphicon-grain:before {\n content: \"\\e239\";\n}\n.glyphicon-sunglasses:before {\n content: \"\\e240\";\n}\n.glyphicon-text-size:before {\n content: \"\\e241\";\n}\n.glyphicon-text-color:before {\n content: \"\\e242\";\n}\n.glyphicon-text-background:before {\n content: \"\\e243\";\n}\n.glyphicon-object-align-top:before {\n content: \"\\e244\";\n}\n.glyphicon-object-align-bottom:before {\n content: \"\\e245\";\n}\n.glyphicon-object-align-horizontal:before {\n content: \"\\e246\";\n}\n.glyphicon-object-align-left:before {\n content: \"\\e247\";\n}\n.glyphicon-object-align-vertical:before {\n content: \"\\e248\";\n}\n.glyphicon-object-align-right:before {\n content: \"\\e249\";\n}\n.glyphicon-triangle-right:before {\n content: \"\\e250\";\n}\n.glyphicon-triangle-left:before {\n content: \"\\e251\";\n}\n.glyphicon-triangle-bottom:before {\n content: \"\\e252\";\n}\n.glyphicon-triangle-top:before {\n content: \"\\e253\";\n}\n.glyphicon-console:before {\n content: \"\\e254\";\n}\n.glyphicon-superscript:before {\n content: \"\\e255\";\n}\n.glyphicon-subscript:before {\n content: \"\\e256\";\n}\n.glyphicon-menu-left:before {\n content: \"\\e257\";\n}\n.glyphicon-menu-right:before {\n content: \"\\e258\";\n}\n.glyphicon-menu-down:before {\n content: \"\\e259\";\n}\n.glyphicon-menu-up:before {\n content: \"\\e260\";\n}\n* {\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n box-sizing: border-box;\n}\n*:before,\n*:after {\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n box-sizing: border-box;\n}\nhtml {\n font-size: 10px;\n -webkit-tap-highlight-color: rgba(0, 0, 0, 0);\n}\nbody {\n font-family: \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n font-size: 14px;\n line-height: 1.42857143;\n color: #333333;\n background-color: #fff;\n}\ninput,\nbutton,\nselect,\ntextarea {\n font-family: inherit;\n font-size: inherit;\n line-height: inherit;\n}\na {\n color: #337ab7;\n text-decoration: none;\n}\na:hover,\na:focus {\n color: #23527c;\n text-decoration: underline;\n}\na:focus {\n outline: 5px auto -webkit-focus-ring-color;\n outline-offset: -2px;\n}\nfigure {\n margin: 0;\n}\nimg {\n vertical-align: middle;\n}\n.img-responsive,\n.thumbnail > img,\n.thumbnail a > img,\n.carousel-inner > .item > img,\n.carousel-inner > .item > a > img {\n display: block;\n max-width: 100%;\n height: auto;\n}\n.img-rounded {\n border-radius: 6px;\n}\n.img-thumbnail {\n padding: 4px;\n line-height: 1.42857143;\n background-color: #fff;\n border: 1px solid #ddd;\n border-radius: 4px;\n -webkit-transition: all 0.2s ease-in-out;\n -o-transition: all 0.2s ease-in-out;\n transition: all 0.2s ease-in-out;\n display: inline-block;\n max-width: 100%;\n height: auto;\n}\n.img-circle {\n border-radius: 50%;\n}\nhr {\n margin-top: 20px;\n margin-bottom: 20px;\n border: 0;\n border-top: 1px solid #eeeeee;\n}\n.sr-only {\n position: absolute;\n width: 1px;\n height: 1px;\n padding: 0;\n margin: -1px;\n overflow: hidden;\n clip: rect(0, 0, 0, 0);\n border: 0;\n}\n.sr-only-focusable:active,\n.sr-only-focusable:focus {\n position: static;\n width: auto;\n height: auto;\n margin: 0;\n overflow: visible;\n clip: auto;\n}\n[role=\"button\"] {\n cursor: pointer;\n}\nh1,\nh2,\nh3,\nh4,\nh5,\nh6,\n.h1,\n.h2,\n.h3,\n.h4,\n.h5,\n.h6 {\n font-family: inherit;\n font-weight: 500;\n line-height: 1.1;\n color: inherit;\n}\nh1 small,\nh2 small,\nh3 small,\nh4 small,\nh5 small,\nh6 small,\n.h1 small,\n.h2 small,\n.h3 small,\n.h4 small,\n.h5 small,\n.h6 small,\nh1 .small,\nh2 .small,\nh3 .small,\nh4 .small,\nh5 .small,\nh6 .small,\n.h1 .small,\n.h2 .small,\n.h3 .small,\n.h4 .small,\n.h5 .small,\n.h6 .small {\n font-weight: 400;\n line-height: 1;\n color: #777777;\n}\nh1,\n.h1,\nh2,\n.h2,\nh3,\n.h3 {\n margin-top: 20px;\n margin-bottom: 10px;\n}\nh1 small,\n.h1 small,\nh2 small,\n.h2 small,\nh3 small,\n.h3 small,\nh1 .small,\n.h1 .small,\nh2 .small,\n.h2 .small,\nh3 .small,\n.h3 .small {\n font-size: 65%;\n}\nh4,\n.h4,\nh5,\n.h5,\nh6,\n.h6 {\n margin-top: 10px;\n margin-bottom: 10px;\n}\nh4 small,\n.h4 small,\nh5 small,\n.h5 small,\nh6 small,\n.h6 small,\nh4 .small,\n.h4 .small,\nh5 .small,\n.h5 .small,\nh6 .small,\n.h6 .small {\n font-size: 75%;\n}\nh1,\n.h1 {\n font-size: 36px;\n}\nh2,\n.h2 {\n font-size: 30px;\n}\nh3,\n.h3 {\n font-size: 24px;\n}\nh4,\n.h4 {\n font-size: 18px;\n}\nh5,\n.h5 {\n font-size: 14px;\n}\nh6,\n.h6 {\n font-size: 12px;\n}\np {\n margin: 0 0 10px;\n}\n.lead {\n margin-bottom: 20px;\n font-size: 16px;\n font-weight: 300;\n line-height: 1.4;\n}\n@media (min-width: 768px) {\n .lead {\n font-size: 21px;\n }\n}\nsmall,\n.small {\n font-size: 85%;\n}\nmark,\n.mark {\n padding: 0.2em;\n background-color: #fcf8e3;\n}\n.text-left {\n text-align: left;\n}\n.text-right {\n text-align: right;\n}\n.text-center {\n text-align: center;\n}\n.text-justify {\n text-align: justify;\n}\n.text-nowrap {\n white-space: nowrap;\n}\n.text-lowercase {\n text-transform: lowercase;\n}\n.text-uppercase {\n text-transform: uppercase;\n}\n.text-capitalize {\n text-transform: capitalize;\n}\n.text-muted {\n color: #777777;\n}\n.text-primary {\n color: #337ab7;\n}\na.text-primary:hover,\na.text-primary:focus {\n color: #286090;\n}\n.text-success {\n color: #3c763d;\n}\na.text-success:hover,\na.text-success:focus {\n color: #2b542c;\n}\n.text-info {\n color: #31708f;\n}\na.text-info:hover,\na.text-info:focus {\n color: #245269;\n}\n.text-warning {\n color: #8a6d3b;\n}\na.text-warning:hover,\na.text-warning:focus {\n color: #66512c;\n}\n.text-danger {\n color: #a94442;\n}\na.text-danger:hover,\na.text-danger:focus {\n color: #843534;\n}\n.bg-primary {\n color: #fff;\n background-color: #337ab7;\n}\na.bg-primary:hover,\na.bg-primary:focus {\n background-color: #286090;\n}\n.bg-success {\n background-color: #dff0d8;\n}\na.bg-success:hover,\na.bg-success:focus {\n background-color: #c1e2b3;\n}\n.bg-info {\n background-color: #d9edf7;\n}\na.bg-info:hover,\na.bg-info:focus {\n background-color: #afd9ee;\n}\n.bg-warning {\n background-color: #fcf8e3;\n}\na.bg-warning:hover,\na.bg-warning:focus {\n background-color: #f7ecb5;\n}\n.bg-danger {\n background-color: #f2dede;\n}\na.bg-danger:hover,\na.bg-danger:focus {\n background-color: #e4b9b9;\n}\n.page-header {\n padding-bottom: 9px;\n margin: 40px 0 20px;\n border-bottom: 1px solid #eeeeee;\n}\nul,\nol {\n margin-top: 0;\n margin-bottom: 10px;\n}\nul ul,\nol ul,\nul ol,\nol ol {\n margin-bottom: 0;\n}\n.list-unstyled {\n padding-left: 0;\n list-style: none;\n}\n.list-inline {\n padding-left: 0;\n list-style: none;\n margin-left: -5px;\n}\n.list-inline > li {\n display: inline-block;\n padding-right: 5px;\n padding-left: 5px;\n}\ndl {\n margin-top: 0;\n margin-bottom: 20px;\n}\ndt,\ndd {\n line-height: 1.42857143;\n}\ndt {\n font-weight: 700;\n}\ndd {\n margin-left: 0;\n}\n@media (min-width: 768px) {\n .dl-horizontal dt {\n float: left;\n width: 160px;\n clear: left;\n text-align: right;\n overflow: hidden;\n text-overflow: ellipsis;\n white-space: nowrap;\n }\n .dl-horizontal dd {\n margin-left: 180px;\n }\n}\nabbr[title],\nabbr[data-original-title] {\n cursor: help;\n}\n.initialism {\n font-size: 90%;\n text-transform: uppercase;\n}\nblockquote {\n padding: 10px 20px;\n margin: 0 0 20px;\n font-size: 17.5px;\n border-left: 5px solid #eeeeee;\n}\nblockquote p:last-child,\nblockquote ul:last-child,\nblockquote ol:last-child {\n margin-bottom: 0;\n}\nblockquote footer,\nblockquote small,\nblockquote .small {\n display: block;\n font-size: 80%;\n line-height: 1.42857143;\n color: #777777;\n}\nblockquote footer:before,\nblockquote small:before,\nblockquote .small:before {\n content: \"\\2014 \\00A0\";\n}\n.blockquote-reverse,\nblockquote.pull-right {\n padding-right: 15px;\n padding-left: 0;\n text-align: right;\n border-right: 5px solid #eeeeee;\n border-left: 0;\n}\n.blockquote-reverse footer:before,\nblockquote.pull-right footer:before,\n.blockquote-reverse small:before,\nblockquote.pull-right small:before,\n.blockquote-reverse .small:before,\nblockquote.pull-right .small:before {\n content: \"\";\n}\n.blockquote-reverse footer:after,\nblockquote.pull-right footer:after,\n.blockquote-reverse small:after,\nblockquote.pull-right small:after,\n.blockquote-reverse .small:after,\nblockquote.pull-right .small:after {\n content: \"\\00A0 \\2014\";\n}\naddress {\n margin-bottom: 20px;\n font-style: normal;\n line-height: 1.42857143;\n}\ncode,\nkbd,\npre,\nsamp {\n font-family: Menlo, Monaco, Consolas, \"Courier New\", monospace;\n}\ncode {\n padding: 2px 4px;\n font-size: 90%;\n color: #c7254e;\n background-color: #f9f2f4;\n border-radius: 4px;\n}\nkbd {\n padding: 2px 4px;\n font-size: 90%;\n color: #fff;\n background-color: #333;\n border-radius: 3px;\n box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.25);\n}\nkbd kbd {\n padding: 0;\n font-size: 100%;\n font-weight: 700;\n box-shadow: none;\n}\npre {\n display: block;\n padding: 9.5px;\n margin: 0 0 10px;\n font-size: 13px;\n line-height: 1.42857143;\n color: #333333;\n word-break: break-all;\n word-wrap: break-word;\n background-color: #f5f5f5;\n border: 1px solid #ccc;\n border-radius: 4px;\n}\npre code {\n padding: 0;\n font-size: inherit;\n color: inherit;\n white-space: pre-wrap;\n background-color: transparent;\n border-radius: 0;\n}\n.pre-scrollable {\n max-height: 340px;\n overflow-y: scroll;\n}\n.container {\n padding-right: 15px;\n padding-left: 15px;\n margin-right: auto;\n margin-left: auto;\n}\n@media (min-width: 768px) {\n .container {\n width: 750px;\n }\n}\n@media (min-width: 992px) {\n .container {\n width: 970px;\n }\n}\n@media (min-width: 1200px) {\n .container {\n width: 1170px;\n }\n}\n.container-fluid {\n padding-right: 15px;\n padding-left: 15px;\n margin-right: auto;\n margin-left: auto;\n}\n.row {\n margin-right: -15px;\n margin-left: -15px;\n}\n.row-no-gutters {\n margin-right: 0;\n margin-left: 0;\n}\n.row-no-gutters [class*=\"col-\"] {\n padding-right: 0;\n padding-left: 0;\n}\n.col-xs-1,\n.col-sm-1,\n.col-md-1,\n.col-lg-1,\n.col-xs-2,\n.col-sm-2,\n.col-md-2,\n.col-lg-2,\n.col-xs-3,\n.col-sm-3,\n.col-md-3,\n.col-lg-3,\n.col-xs-4,\n.col-sm-4,\n.col-md-4,\n.col-lg-4,\n.col-xs-5,\n.col-sm-5,\n.col-md-5,\n.col-lg-5,\n.col-xs-6,\n.col-sm-6,\n.col-md-6,\n.col-lg-6,\n.col-xs-7,\n.col-sm-7,\n.col-md-7,\n.col-lg-7,\n.col-xs-8,\n.col-sm-8,\n.col-md-8,\n.col-lg-8,\n.col-xs-9,\n.col-sm-9,\n.col-md-9,\n.col-lg-9,\n.col-xs-10,\n.col-sm-10,\n.col-md-10,\n.col-lg-10,\n.col-xs-11,\n.col-sm-11,\n.col-md-11,\n.col-lg-11,\n.col-xs-12,\n.col-sm-12,\n.col-md-12,\n.col-lg-12 {\n position: relative;\n min-height: 1px;\n padding-right: 15px;\n padding-left: 15px;\n}\n.col-xs-1,\n.col-xs-2,\n.col-xs-3,\n.col-xs-4,\n.col-xs-5,\n.col-xs-6,\n.col-xs-7,\n.col-xs-8,\n.col-xs-9,\n.col-xs-10,\n.col-xs-11,\n.col-xs-12 {\n float: left;\n}\n.col-xs-12 {\n width: 100%;\n}\n.col-xs-11 {\n width: 91.66666667%;\n}\n.col-xs-10 {\n width: 83.33333333%;\n}\n.col-xs-9 {\n width: 75%;\n}\n.col-xs-8 {\n width: 66.66666667%;\n}\n.col-xs-7 {\n width: 58.33333333%;\n}\n.col-xs-6 {\n width: 50%;\n}\n.col-xs-5 {\n width: 41.66666667%;\n}\n.col-xs-4 {\n width: 33.33333333%;\n}\n.col-xs-3 {\n width: 25%;\n}\n.col-xs-2 {\n width: 16.66666667%;\n}\n.col-xs-1 {\n width: 8.33333333%;\n}\n.col-xs-pull-12 {\n right: 100%;\n}\n.col-xs-pull-11 {\n right: 91.66666667%;\n}\n.col-xs-pull-10 {\n right: 83.33333333%;\n}\n.col-xs-pull-9 {\n right: 75%;\n}\n.col-xs-pull-8 {\n right: 66.66666667%;\n}\n.col-xs-pull-7 {\n right: 58.33333333%;\n}\n.col-xs-pull-6 {\n right: 50%;\n}\n.col-xs-pull-5 {\n right: 41.66666667%;\n}\n.col-xs-pull-4 {\n right: 33.33333333%;\n}\n.col-xs-pull-3 {\n right: 25%;\n}\n.col-xs-pull-2 {\n right: 16.66666667%;\n}\n.col-xs-pull-1 {\n right: 8.33333333%;\n}\n.col-xs-pull-0 {\n right: auto;\n}\n.col-xs-push-12 {\n left: 100%;\n}\n.col-xs-push-11 {\n left: 91.66666667%;\n}\n.col-xs-push-10 {\n left: 83.33333333%;\n}\n.col-xs-push-9 {\n left: 75%;\n}\n.col-xs-push-8 {\n left: 66.66666667%;\n}\n.col-xs-push-7 {\n left: 58.33333333%;\n}\n.col-xs-push-6 {\n left: 50%;\n}\n.col-xs-push-5 {\n left: 41.66666667%;\n}\n.col-xs-push-4 {\n left: 33.33333333%;\n}\n.col-xs-push-3 {\n left: 25%;\n}\n.col-xs-push-2 {\n left: 16.66666667%;\n}\n.col-xs-push-1 {\n left: 8.33333333%;\n}\n.col-xs-push-0 {\n left: auto;\n}\n.col-xs-offset-12 {\n margin-left: 100%;\n}\n.col-xs-offset-11 {\n margin-left: 91.66666667%;\n}\n.col-xs-offset-10 {\n margin-left: 83.33333333%;\n}\n.col-xs-offset-9 {\n margin-left: 75%;\n}\n.col-xs-offset-8 {\n margin-left: 66.66666667%;\n}\n.col-xs-offset-7 {\n margin-left: 58.33333333%;\n}\n.col-xs-offset-6 {\n margin-left: 50%;\n}\n.col-xs-offset-5 {\n margin-left: 41.66666667%;\n}\n.col-xs-offset-4 {\n margin-left: 33.33333333%;\n}\n.col-xs-offset-3 {\n margin-left: 25%;\n}\n.col-xs-offset-2 {\n margin-left: 16.66666667%;\n}\n.col-xs-offset-1 {\n margin-left: 8.33333333%;\n}\n.col-xs-offset-0 {\n margin-left: 0%;\n}\n@media (min-width: 768px) {\n .col-sm-1,\n .col-sm-2,\n .col-sm-3,\n .col-sm-4,\n .col-sm-5,\n .col-sm-6,\n .col-sm-7,\n .col-sm-8,\n .col-sm-9,\n .col-sm-10,\n .col-sm-11,\n .col-sm-12 {\n float: left;\n }\n .col-sm-12 {\n width: 100%;\n }\n .col-sm-11 {\n width: 91.66666667%;\n }\n .col-sm-10 {\n width: 83.33333333%;\n }\n .col-sm-9 {\n width: 75%;\n }\n .col-sm-8 {\n width: 66.66666667%;\n }\n .col-sm-7 {\n width: 58.33333333%;\n }\n .col-sm-6 {\n width: 50%;\n }\n .col-sm-5 {\n width: 41.66666667%;\n }\n .col-sm-4 {\n width: 33.33333333%;\n }\n .col-sm-3 {\n width: 25%;\n }\n .col-sm-2 {\n width: 16.66666667%;\n }\n .col-sm-1 {\n width: 8.33333333%;\n }\n .col-sm-pull-12 {\n right: 100%;\n }\n .col-sm-pull-11 {\n right: 91.66666667%;\n }\n .col-sm-pull-10 {\n right: 83.33333333%;\n }\n .col-sm-pull-9 {\n right: 75%;\n }\n .col-sm-pull-8 {\n right: 66.66666667%;\n }\n .col-sm-pull-7 {\n right: 58.33333333%;\n }\n .col-sm-pull-6 {\n right: 50%;\n }\n .col-sm-pull-5 {\n right: 41.66666667%;\n }\n .col-sm-pull-4 {\n right: 33.33333333%;\n }\n .col-sm-pull-3 {\n right: 25%;\n }\n .col-sm-pull-2 {\n right: 16.66666667%;\n }\n .col-sm-pull-1 {\n right: 8.33333333%;\n }\n .col-sm-pull-0 {\n right: auto;\n }\n .col-sm-push-12 {\n left: 100%;\n }\n .col-sm-push-11 {\n left: 91.66666667%;\n }\n .col-sm-push-10 {\n left: 83.33333333%;\n }\n .col-sm-push-9 {\n left: 75%;\n }\n .col-sm-push-8 {\n left: 66.66666667%;\n }\n .col-sm-push-7 {\n left: 58.33333333%;\n }\n .col-sm-push-6 {\n left: 50%;\n }\n .col-sm-push-5 {\n left: 41.66666667%;\n }\n .col-sm-push-4 {\n left: 33.33333333%;\n }\n .col-sm-push-3 {\n left: 25%;\n }\n .col-sm-push-2 {\n left: 16.66666667%;\n }\n .col-sm-push-1 {\n left: 8.33333333%;\n }\n .col-sm-push-0 {\n left: auto;\n }\n .col-sm-offset-12 {\n margin-left: 100%;\n }\n .col-sm-offset-11 {\n margin-left: 91.66666667%;\n }\n .col-sm-offset-10 {\n margin-left: 83.33333333%;\n }\n .col-sm-offset-9 {\n margin-left: 75%;\n }\n .col-sm-offset-8 {\n margin-left: 66.66666667%;\n }\n .col-sm-offset-7 {\n margin-left: 58.33333333%;\n }\n .col-sm-offset-6 {\n margin-left: 50%;\n }\n .col-sm-offset-5 {\n margin-left: 41.66666667%;\n }\n .col-sm-offset-4 {\n margin-left: 33.33333333%;\n }\n .col-sm-offset-3 {\n margin-left: 25%;\n }\n .col-sm-offset-2 {\n margin-left: 16.66666667%;\n }\n .col-sm-offset-1 {\n margin-left: 8.33333333%;\n }\n .col-sm-offset-0 {\n margin-left: 0%;\n }\n}\n@media (min-width: 992px) {\n .col-md-1,\n .col-md-2,\n .col-md-3,\n .col-md-4,\n .col-md-5,\n .col-md-6,\n .col-md-7,\n .col-md-8,\n .col-md-9,\n .col-md-10,\n .col-md-11,\n .col-md-12 {\n float: left;\n }\n .col-md-12 {\n width: 100%;\n }\n .col-md-11 {\n width: 91.66666667%;\n }\n .col-md-10 {\n width: 83.33333333%;\n }\n .col-md-9 {\n width: 75%;\n }\n .col-md-8 {\n width: 66.66666667%;\n }\n .col-md-7 {\n width: 58.33333333%;\n }\n .col-md-6 {\n width: 50%;\n }\n .col-md-5 {\n width: 41.66666667%;\n }\n .col-md-4 {\n width: 33.33333333%;\n }\n .col-md-3 {\n width: 25%;\n }\n .col-md-2 {\n width: 16.66666667%;\n }\n .col-md-1 {\n width: 8.33333333%;\n }\n .col-md-pull-12 {\n right: 100%;\n }\n .col-md-pull-11 {\n right: 91.66666667%;\n }\n .col-md-pull-10 {\n right: 83.33333333%;\n }\n .col-md-pull-9 {\n right: 75%;\n }\n .col-md-pull-8 {\n right: 66.66666667%;\n }\n .col-md-pull-7 {\n right: 58.33333333%;\n }\n .col-md-pull-6 {\n right: 50%;\n }\n .col-md-pull-5 {\n right: 41.66666667%;\n }\n .col-md-pull-4 {\n right: 33.33333333%;\n }\n .col-md-pull-3 {\n right: 25%;\n }\n .col-md-pull-2 {\n right: 16.66666667%;\n }\n .col-md-pull-1 {\n right: 8.33333333%;\n }\n .col-md-pull-0 {\n right: auto;\n }\n .col-md-push-12 {\n left: 100%;\n }\n .col-md-push-11 {\n left: 91.66666667%;\n }\n .col-md-push-10 {\n left: 83.33333333%;\n }\n .col-md-push-9 {\n left: 75%;\n }\n .col-md-push-8 {\n left: 66.66666667%;\n }\n .col-md-push-7 {\n left: 58.33333333%;\n }\n .col-md-push-6 {\n left: 50%;\n }\n .col-md-push-5 {\n left: 41.66666667%;\n }\n .col-md-push-4 {\n left: 33.33333333%;\n }\n .col-md-push-3 {\n left: 25%;\n }\n .col-md-push-2 {\n left: 16.66666667%;\n }\n .col-md-push-1 {\n left: 8.33333333%;\n }\n .col-md-push-0 {\n left: auto;\n }\n .col-md-offset-12 {\n margin-left: 100%;\n }\n .col-md-offset-11 {\n margin-left: 91.66666667%;\n }\n .col-md-offset-10 {\n margin-left: 83.33333333%;\n }\n .col-md-offset-9 {\n margin-left: 75%;\n }\n .col-md-offset-8 {\n margin-left: 66.66666667%;\n }\n .col-md-offset-7 {\n margin-left: 58.33333333%;\n }\n .col-md-offset-6 {\n margin-left: 50%;\n }\n .col-md-offset-5 {\n margin-left: 41.66666667%;\n }\n .col-md-offset-4 {\n margin-left: 33.33333333%;\n }\n .col-md-offset-3 {\n margin-left: 25%;\n }\n .col-md-offset-2 {\n margin-left: 16.66666667%;\n }\n .col-md-offset-1 {\n margin-left: 8.33333333%;\n }\n .col-md-offset-0 {\n margin-left: 0%;\n }\n}\n@media (min-width: 1200px) {\n .col-lg-1,\n .col-lg-2,\n .col-lg-3,\n .col-lg-4,\n .col-lg-5,\n .col-lg-6,\n .col-lg-7,\n .col-lg-8,\n .col-lg-9,\n .col-lg-10,\n .col-lg-11,\n .col-lg-12 {\n float: left;\n }\n .col-lg-12 {\n width: 100%;\n }\n .col-lg-11 {\n width: 91.66666667%;\n }\n .col-lg-10 {\n width: 83.33333333%;\n }\n .col-lg-9 {\n width: 75%;\n }\n .col-lg-8 {\n width: 66.66666667%;\n }\n .col-lg-7 {\n width: 58.33333333%;\n }\n .col-lg-6 {\n width: 50%;\n }\n .col-lg-5 {\n width: 41.66666667%;\n }\n .col-lg-4 {\n width: 33.33333333%;\n }\n .col-lg-3 {\n width: 25%;\n }\n .col-lg-2 {\n width: 16.66666667%;\n }\n .col-lg-1 {\n width: 8.33333333%;\n }\n .col-lg-pull-12 {\n right: 100%;\n }\n .col-lg-pull-11 {\n right: 91.66666667%;\n }\n .col-lg-pull-10 {\n right: 83.33333333%;\n }\n .col-lg-pull-9 {\n right: 75%;\n }\n .col-lg-pull-8 {\n right: 66.66666667%;\n }\n .col-lg-pull-7 {\n right: 58.33333333%;\n }\n .col-lg-pull-6 {\n right: 50%;\n }\n .col-lg-pull-5 {\n right: 41.66666667%;\n }\n .col-lg-pull-4 {\n right: 33.33333333%;\n }\n .col-lg-pull-3 {\n right: 25%;\n }\n .col-lg-pull-2 {\n right: 16.66666667%;\n }\n .col-lg-pull-1 {\n right: 8.33333333%;\n }\n .col-lg-pull-0 {\n right: auto;\n }\n .col-lg-push-12 {\n left: 100%;\n }\n .col-lg-push-11 {\n left: 91.66666667%;\n }\n .col-lg-push-10 {\n left: 83.33333333%;\n }\n .col-lg-push-9 {\n left: 75%;\n }\n .col-lg-push-8 {\n left: 66.66666667%;\n }\n .col-lg-push-7 {\n left: 58.33333333%;\n }\n .col-lg-push-6 {\n left: 50%;\n }\n .col-lg-push-5 {\n left: 41.66666667%;\n }\n .col-lg-push-4 {\n left: 33.33333333%;\n }\n .col-lg-push-3 {\n left: 25%;\n }\n .col-lg-push-2 {\n left: 16.66666667%;\n }\n .col-lg-push-1 {\n left: 8.33333333%;\n }\n .col-lg-push-0 {\n left: auto;\n }\n .col-lg-offset-12 {\n margin-left: 100%;\n }\n .col-lg-offset-11 {\n margin-left: 91.66666667%;\n }\n .col-lg-offset-10 {\n margin-left: 83.33333333%;\n }\n .col-lg-offset-9 {\n margin-left: 75%;\n }\n .col-lg-offset-8 {\n margin-left: 66.66666667%;\n }\n .col-lg-offset-7 {\n margin-left: 58.33333333%;\n }\n .col-lg-offset-6 {\n margin-left: 50%;\n }\n .col-lg-offset-5 {\n margin-left: 41.66666667%;\n }\n .col-lg-offset-4 {\n margin-left: 33.33333333%;\n }\n .col-lg-offset-3 {\n margin-left: 25%;\n }\n .col-lg-offset-2 {\n margin-left: 16.66666667%;\n }\n .col-lg-offset-1 {\n margin-left: 8.33333333%;\n }\n .col-lg-offset-0 {\n margin-left: 0%;\n }\n}\ntable {\n background-color: transparent;\n}\ntable col[class*=\"col-\"] {\n position: static;\n display: table-column;\n float: none;\n}\ntable td[class*=\"col-\"],\ntable th[class*=\"col-\"] {\n position: static;\n display: table-cell;\n float: none;\n}\ncaption {\n padding-top: 8px;\n padding-bottom: 8px;\n color: #777777;\n text-align: left;\n}\nth {\n text-align: left;\n}\n.table {\n width: 100%;\n max-width: 100%;\n margin-bottom: 20px;\n}\n.table > thead > tr > th,\n.table > tbody > tr > th,\n.table > tfoot > tr > th,\n.table > thead > tr > td,\n.table > tbody > tr > td,\n.table > tfoot > tr > td {\n padding: 8px;\n line-height: 1.42857143;\n vertical-align: top;\n border-top: 1px solid #ddd;\n}\n.table > thead > tr > th {\n vertical-align: bottom;\n border-bottom: 2px solid #ddd;\n}\n.table > caption + thead > tr:first-child > th,\n.table > colgroup + thead > tr:first-child > th,\n.table > thead:first-child > tr:first-child > th,\n.table > caption + thead > tr:first-child > td,\n.table > colgroup + thead > tr:first-child > td,\n.table > thead:first-child > tr:first-child > td {\n border-top: 0;\n}\n.table > tbody + tbody {\n border-top: 2px solid #ddd;\n}\n.table .table {\n background-color: #fff;\n}\n.table-condensed > thead > tr > th,\n.table-condensed > tbody > tr > th,\n.table-condensed > tfoot > tr > th,\n.table-condensed > thead > tr > td,\n.table-condensed > tbody > tr > td,\n.table-condensed > tfoot > tr > td {\n padding: 5px;\n}\n.table-bordered {\n border: 1px solid #ddd;\n}\n.table-bordered > thead > tr > th,\n.table-bordered > tbody > tr > th,\n.table-bordered > tfoot > tr > th,\n.table-bordered > thead > tr > td,\n.table-bordered > tbody > tr > td,\n.table-bordered > tfoot > tr > td {\n border: 1px solid #ddd;\n}\n.table-bordered > thead > tr > th,\n.table-bordered > thead > tr > td {\n border-bottom-width: 2px;\n}\n.table-striped > tbody > tr:nth-of-type(odd) {\n background-color: #f9f9f9;\n}\n.table-hover > tbody > tr:hover {\n background-color: #f5f5f5;\n}\n.table > thead > tr > td.active,\n.table > tbody > tr > td.active,\n.table > tfoot > tr > td.active,\n.table > thead > tr > th.active,\n.table > tbody > tr > th.active,\n.table > tfoot > tr > th.active,\n.table > thead > tr.active > td,\n.table > tbody > tr.active > td,\n.table > tfoot > tr.active > td,\n.table > thead > tr.active > th,\n.table > tbody > tr.active > th,\n.table > tfoot > tr.active > th {\n background-color: #f5f5f5;\n}\n.table-hover > tbody > tr > td.active:hover,\n.table-hover > tbody > tr > th.active:hover,\n.table-hover > tbody > tr.active:hover > td,\n.table-hover > tbody > tr:hover > .active,\n.table-hover > tbody > tr.active:hover > th {\n background-color: #e8e8e8;\n}\n.table > thead > tr > td.success,\n.table > tbody > tr > td.success,\n.table > tfoot > tr > td.success,\n.table > thead > tr > th.success,\n.table > tbody > tr > th.success,\n.table > tfoot > tr > th.success,\n.table > thead > tr.success > td,\n.table > tbody > tr.success > td,\n.table > tfoot > tr.success > td,\n.table > thead > tr.success > th,\n.table > tbody > tr.success > th,\n.table > tfoot > tr.success > th {\n background-color: #dff0d8;\n}\n.table-hover > tbody > tr > td.success:hover,\n.table-hover > tbody > tr > th.success:hover,\n.table-hover > tbody > tr.success:hover > td,\n.table-hover > tbody > tr:hover > .success,\n.table-hover > tbody > tr.success:hover > th {\n background-color: #d0e9c6;\n}\n.table > thead > tr > td.info,\n.table > tbody > tr > td.info,\n.table > tfoot > tr > td.info,\n.table > thead > tr > th.info,\n.table > tbody > tr > th.info,\n.table > tfoot > tr > th.info,\n.table > thead > tr.info > td,\n.table > tbody > tr.info > td,\n.table > tfoot > tr.info > td,\n.table > thead > tr.info > th,\n.table > tbody > tr.info > th,\n.table > tfoot > tr.info > th {\n background-color: #d9edf7;\n}\n.table-hover > tbody > tr > td.info:hover,\n.table-hover > tbody > tr > th.info:hover,\n.table-hover > tbody > tr.info:hover > td,\n.table-hover > tbody > tr:hover > .info,\n.table-hover > tbody > tr.info:hover > th {\n background-color: #c4e3f3;\n}\n.table > thead > tr > td.warning,\n.table > tbody > tr > td.warning,\n.table > tfoot > tr > td.warning,\n.table > thead > tr > th.warning,\n.table > tbody > tr > th.warning,\n.table > tfoot > tr > th.warning,\n.table > thead > tr.warning > td,\n.table > tbody > tr.warning > td,\n.table > tfoot > tr.warning > td,\n.table > thead > tr.warning > th,\n.table > tbody > tr.warning > th,\n.table > tfoot > tr.warning > th {\n background-color: #fcf8e3;\n}\n.table-hover > tbody > tr > td.warning:hover,\n.table-hover > tbody > tr > th.warning:hover,\n.table-hover > tbody > tr.warning:hover > td,\n.table-hover > tbody > tr:hover > .warning,\n.table-hover > tbody > tr.warning:hover > th {\n background-color: #faf2cc;\n}\n.table > thead > tr > td.danger,\n.table > tbody > tr > td.danger,\n.table > tfoot > tr > td.danger,\n.table > thead > tr > th.danger,\n.table > tbody > tr > th.danger,\n.table > tfoot > tr > th.danger,\n.table > thead > tr.danger > td,\n.table > tbody > tr.danger > td,\n.table > tfoot > tr.danger > td,\n.table > thead > tr.danger > th,\n.table > tbody > tr.danger > th,\n.table > tfoot > tr.danger > th {\n background-color: #f2dede;\n}\n.table-hover > tbody > tr > td.danger:hover,\n.table-hover > tbody > tr > th.danger:hover,\n.table-hover > tbody > tr.danger:hover > td,\n.table-hover > tbody > tr:hover > .danger,\n.table-hover > tbody > tr.danger:hover > th {\n background-color: #ebcccc;\n}\n.table-responsive {\n min-height: 0.01%;\n overflow-x: auto;\n}\n@media screen and (max-width: 767px) {\n .table-responsive {\n width: 100%;\n margin-bottom: 15px;\n overflow-y: hidden;\n -ms-overflow-style: -ms-autohiding-scrollbar;\n border: 1px solid #ddd;\n }\n .table-responsive > .table {\n margin-bottom: 0;\n }\n .table-responsive > .table > thead > tr > th,\n .table-responsive > .table > tbody > tr > th,\n .table-responsive > .table > tfoot > tr > th,\n .table-responsive > .table > thead > tr > td,\n .table-responsive > .table > tbody > tr > td,\n .table-responsive > .table > tfoot > tr > td {\n white-space: nowrap;\n }\n .table-responsive > .table-bordered {\n border: 0;\n }\n .table-responsive > .table-bordered > thead > tr > th:first-child,\n .table-responsive > .table-bordered > tbody > tr > th:first-child,\n .table-responsive > .table-bordered > tfoot > tr > th:first-child,\n .table-responsive > .table-bordered > thead > tr > td:first-child,\n .table-responsive > .table-bordered > tbody > tr > td:first-child,\n .table-responsive > .table-bordered > tfoot > tr > td:first-child {\n border-left: 0;\n }\n .table-responsive > .table-bordered > thead > tr > th:last-child,\n .table-responsive > .table-bordered > tbody > tr > th:last-child,\n .table-responsive > .table-bordered > tfoot > tr > th:last-child,\n .table-responsive > .table-bordered > thead > tr > td:last-child,\n .table-responsive > .table-bordered > tbody > tr > td:last-child,\n .table-responsive > .table-bordered > tfoot > tr > td:last-child {\n border-right: 0;\n }\n .table-responsive > .table-bordered > tbody > tr:last-child > th,\n .table-responsive > .table-bordered > tfoot > tr:last-child > th,\n .table-responsive > .table-bordered > tbody > tr:last-child > td,\n .table-responsive > .table-bordered > tfoot > tr:last-child > td {\n border-bottom: 0;\n }\n}\nfieldset {\n min-width: 0;\n padding: 0;\n margin: 0;\n border: 0;\n}\nlegend {\n display: block;\n width: 100%;\n padding: 0;\n margin-bottom: 20px;\n font-size: 21px;\n line-height: inherit;\n color: #333333;\n border: 0;\n border-bottom: 1px solid #e5e5e5;\n}\nlabel {\n display: inline-block;\n max-width: 100%;\n margin-bottom: 5px;\n font-weight: 700;\n}\ninput[type=\"search\"] {\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n box-sizing: border-box;\n -webkit-appearance: none;\n appearance: none;\n}\ninput[type=\"radio\"],\ninput[type=\"checkbox\"] {\n margin: 4px 0 0;\n margin-top: 1px \\9;\n line-height: normal;\n}\ninput[type=\"radio\"][disabled],\ninput[type=\"checkbox\"][disabled],\ninput[type=\"radio\"].disabled,\ninput[type=\"checkbox\"].disabled,\nfieldset[disabled] input[type=\"radio\"],\nfieldset[disabled] input[type=\"checkbox\"] {\n cursor: not-allowed;\n}\ninput[type=\"file\"] {\n display: block;\n}\ninput[type=\"range\"] {\n display: block;\n width: 100%;\n}\nselect[multiple],\nselect[size] {\n height: auto;\n}\ninput[type=\"file\"]:focus,\ninput[type=\"radio\"]:focus,\ninput[type=\"checkbox\"]:focus {\n outline: 5px auto -webkit-focus-ring-color;\n outline-offset: -2px;\n}\noutput {\n display: block;\n padding-top: 7px;\n font-size: 14px;\n line-height: 1.42857143;\n color: #555555;\n}\n.form-control {\n display: block;\n width: 100%;\n height: 34px;\n padding: 6px 12px;\n font-size: 14px;\n line-height: 1.42857143;\n color: #555555;\n background-color: #fff;\n background-image: none;\n border: 1px solid #ccc;\n border-radius: 4px;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n -webkit-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;\n -o-transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;\n transition: border-color ease-in-out .15s, box-shadow ease-in-out .15s;\n}\n.form-control:focus {\n border-color: #66afe9;\n outline: 0;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075), 0 0 8px rgba(102, 175, 233, 0.6);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, .075), 0 0 8px rgba(102, 175, 233, 0.6);\n}\n.form-control::-moz-placeholder {\n color: #999;\n opacity: 1;\n}\n.form-control:-ms-input-placeholder {\n color: #999;\n}\n.form-control::-webkit-input-placeholder {\n color: #999;\n}\n.form-control::-ms-expand {\n background-color: transparent;\n border: 0;\n}\n.form-control[disabled],\n.form-control[readonly],\nfieldset[disabled] .form-control {\n background-color: #eeeeee;\n opacity: 1;\n}\n.form-control[disabled],\nfieldset[disabled] .form-control {\n cursor: not-allowed;\n}\ntextarea.form-control {\n height: auto;\n}\n@media screen and (-webkit-min-device-pixel-ratio: 0) {\n input[type=\"date\"].form-control,\n input[type=\"time\"].form-control,\n input[type=\"datetime-local\"].form-control,\n input[type=\"month\"].form-control {\n line-height: 34px;\n }\n input[type=\"date\"].input-sm,\n input[type=\"time\"].input-sm,\n input[type=\"datetime-local\"].input-sm,\n input[type=\"month\"].input-sm,\n .input-group-sm input[type=\"date\"],\n .input-group-sm input[type=\"time\"],\n .input-group-sm input[type=\"datetime-local\"],\n .input-group-sm input[type=\"month\"] {\n line-height: 30px;\n }\n input[type=\"date\"].input-lg,\n input[type=\"time\"].input-lg,\n input[type=\"datetime-local\"].input-lg,\n input[type=\"month\"].input-lg,\n .input-group-lg input[type=\"date\"],\n .input-group-lg input[type=\"time\"],\n .input-group-lg input[type=\"datetime-local\"],\n .input-group-lg input[type=\"month\"] {\n line-height: 46px;\n }\n}\n.form-group {\n margin-bottom: 15px;\n}\n.radio,\n.checkbox {\n position: relative;\n display: block;\n margin-top: 10px;\n margin-bottom: 10px;\n}\n.radio.disabled label,\n.checkbox.disabled label,\nfieldset[disabled] .radio label,\nfieldset[disabled] .checkbox label {\n cursor: not-allowed;\n}\n.radio label,\n.checkbox label {\n min-height: 20px;\n padding-left: 20px;\n margin-bottom: 0;\n font-weight: 400;\n cursor: pointer;\n}\n.radio input[type=\"radio\"],\n.radio-inline input[type=\"radio\"],\n.checkbox input[type=\"checkbox\"],\n.checkbox-inline input[type=\"checkbox\"] {\n position: absolute;\n margin-top: 4px \\9;\n margin-left: -20px;\n}\n.radio + .radio,\n.checkbox + .checkbox {\n margin-top: -5px;\n}\n.radio-inline,\n.checkbox-inline {\n position: relative;\n display: inline-block;\n padding-left: 20px;\n margin-bottom: 0;\n font-weight: 400;\n vertical-align: middle;\n cursor: pointer;\n}\n.radio-inline.disabled,\n.checkbox-inline.disabled,\nfieldset[disabled] .radio-inline,\nfieldset[disabled] .checkbox-inline {\n cursor: not-allowed;\n}\n.radio-inline + .radio-inline,\n.checkbox-inline + .checkbox-inline {\n margin-top: 0;\n margin-left: 10px;\n}\n.form-control-static {\n min-height: 34px;\n padding-top: 7px;\n padding-bottom: 7px;\n margin-bottom: 0;\n}\n.form-control-static.input-lg,\n.form-control-static.input-sm {\n padding-right: 0;\n padding-left: 0;\n}\n.input-sm {\n height: 30px;\n padding: 5px 10px;\n font-size: 12px;\n line-height: 1.5;\n border-radius: 3px;\n}\nselect.input-sm {\n height: 30px;\n line-height: 30px;\n}\ntextarea.input-sm,\nselect[multiple].input-sm {\n height: auto;\n}\n.form-group-sm .form-control {\n height: 30px;\n padding: 5px 10px;\n font-size: 12px;\n line-height: 1.5;\n border-radius: 3px;\n}\n.form-group-sm select.form-control {\n height: 30px;\n line-height: 30px;\n}\n.form-group-sm textarea.form-control,\n.form-group-sm select[multiple].form-control {\n height: auto;\n}\n.form-group-sm .form-control-static {\n height: 30px;\n min-height: 32px;\n padding: 6px 10px;\n font-size: 12px;\n line-height: 1.5;\n}\n.input-lg {\n height: 46px;\n padding: 10px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n border-radius: 6px;\n}\nselect.input-lg {\n height: 46px;\n line-height: 46px;\n}\ntextarea.input-lg,\nselect[multiple].input-lg {\n height: auto;\n}\n.form-group-lg .form-control {\n height: 46px;\n padding: 10px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n border-radius: 6px;\n}\n.form-group-lg select.form-control {\n height: 46px;\n line-height: 46px;\n}\n.form-group-lg textarea.form-control,\n.form-group-lg select[multiple].form-control {\n height: auto;\n}\n.form-group-lg .form-control-static {\n height: 46px;\n min-height: 38px;\n padding: 11px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n}\n.has-feedback {\n position: relative;\n}\n.has-feedback .form-control {\n padding-right: 42.5px;\n}\n.form-control-feedback {\n position: absolute;\n top: 0;\n right: 0;\n z-index: 2;\n display: block;\n width: 34px;\n height: 34px;\n line-height: 34px;\n text-align: center;\n pointer-events: none;\n}\n.input-lg + .form-control-feedback,\n.input-group-lg + .form-control-feedback,\n.form-group-lg .form-control + .form-control-feedback {\n width: 46px;\n height: 46px;\n line-height: 46px;\n}\n.input-sm + .form-control-feedback,\n.input-group-sm + .form-control-feedback,\n.form-group-sm .form-control + .form-control-feedback {\n width: 30px;\n height: 30px;\n line-height: 30px;\n}\n.has-success .help-block,\n.has-success .control-label,\n.has-success .radio,\n.has-success .checkbox,\n.has-success .radio-inline,\n.has-success .checkbox-inline,\n.has-success.radio label,\n.has-success.checkbox label,\n.has-success.radio-inline label,\n.has-success.checkbox-inline label {\n color: #3c763d;\n}\n.has-success .form-control {\n border-color: #3c763d;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n}\n.has-success .form-control:focus {\n border-color: #2b542c;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #67b168;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #67b168;\n}\n.has-success .input-group-addon {\n color: #3c763d;\n background-color: #dff0d8;\n border-color: #3c763d;\n}\n.has-success .form-control-feedback {\n color: #3c763d;\n}\n.has-warning .help-block,\n.has-warning .control-label,\n.has-warning .radio,\n.has-warning .checkbox,\n.has-warning .radio-inline,\n.has-warning .checkbox-inline,\n.has-warning.radio label,\n.has-warning.checkbox label,\n.has-warning.radio-inline label,\n.has-warning.checkbox-inline label {\n color: #8a6d3b;\n}\n.has-warning .form-control {\n border-color: #8a6d3b;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n}\n.has-warning .form-control:focus {\n border-color: #66512c;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #c0a16b;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #c0a16b;\n}\n.has-warning .input-group-addon {\n color: #8a6d3b;\n background-color: #fcf8e3;\n border-color: #8a6d3b;\n}\n.has-warning .form-control-feedback {\n color: #8a6d3b;\n}\n.has-error .help-block,\n.has-error .control-label,\n.has-error .radio,\n.has-error .checkbox,\n.has-error .radio-inline,\n.has-error .checkbox-inline,\n.has-error.radio label,\n.has-error.checkbox label,\n.has-error.radio-inline label,\n.has-error.checkbox-inline label {\n color: #a94442;\n}\n.has-error .form-control {\n border-color: #a94442;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075);\n}\n.has-error .form-control:focus {\n border-color: #843534;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #ce8483;\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 6px #ce8483;\n}\n.has-error .input-group-addon {\n color: #a94442;\n background-color: #f2dede;\n border-color: #a94442;\n}\n.has-error .form-control-feedback {\n color: #a94442;\n}\n.has-feedback label ~ .form-control-feedback {\n top: 25px;\n}\n.has-feedback label.sr-only ~ .form-control-feedback {\n top: 0;\n}\n.help-block {\n display: block;\n margin-top: 5px;\n margin-bottom: 10px;\n color: #737373;\n}\n@media (min-width: 768px) {\n .form-inline .form-group {\n display: inline-block;\n margin-bottom: 0;\n vertical-align: middle;\n }\n .form-inline .form-control {\n display: inline-block;\n width: auto;\n vertical-align: middle;\n }\n .form-inline .form-control-static {\n display: inline-block;\n }\n .form-inline .input-group {\n display: inline-table;\n vertical-align: middle;\n }\n .form-inline .input-group .input-group-addon,\n .form-inline .input-group .input-group-btn,\n .form-inline .input-group .form-control {\n width: auto;\n }\n .form-inline .input-group > .form-control {\n width: 100%;\n }\n .form-inline .control-label {\n margin-bottom: 0;\n vertical-align: middle;\n }\n .form-inline .radio,\n .form-inline .checkbox {\n display: inline-block;\n margin-top: 0;\n margin-bottom: 0;\n vertical-align: middle;\n }\n .form-inline .radio label,\n .form-inline .checkbox label {\n padding-left: 0;\n }\n .form-inline .radio input[type=\"radio\"],\n .form-inline .checkbox input[type=\"checkbox\"] {\n position: relative;\n margin-left: 0;\n }\n .form-inline .has-feedback .form-control-feedback {\n top: 0;\n }\n}\n.form-horizontal .radio,\n.form-horizontal .checkbox,\n.form-horizontal .radio-inline,\n.form-horizontal .checkbox-inline {\n padding-top: 7px;\n margin-top: 0;\n margin-bottom: 0;\n}\n.form-horizontal .radio,\n.form-horizontal .checkbox {\n min-height: 27px;\n}\n.form-horizontal .form-group {\n margin-right: -15px;\n margin-left: -15px;\n}\n@media (min-width: 768px) {\n .form-horizontal .control-label {\n padding-top: 7px;\n margin-bottom: 0;\n text-align: right;\n }\n}\n.form-horizontal .has-feedback .form-control-feedback {\n right: 15px;\n}\n@media (min-width: 768px) {\n .form-horizontal .form-group-lg .control-label {\n padding-top: 11px;\n font-size: 18px;\n }\n}\n@media (min-width: 768px) {\n .form-horizontal .form-group-sm .control-label {\n padding-top: 6px;\n font-size: 12px;\n }\n}\n.btn {\n display: inline-block;\n margin-bottom: 0;\n font-weight: normal;\n text-align: center;\n white-space: nowrap;\n vertical-align: middle;\n touch-action: manipulation;\n cursor: pointer;\n background-image: none;\n border: 1px solid transparent;\n padding: 6px 12px;\n font-size: 14px;\n line-height: 1.42857143;\n border-radius: 4px;\n -webkit-user-select: none;\n -moz-user-select: none;\n -ms-user-select: none;\n user-select: none;\n}\n.btn:focus,\n.btn:active:focus,\n.btn.active:focus,\n.btn.focus,\n.btn:active.focus,\n.btn.active.focus {\n outline: 5px auto -webkit-focus-ring-color;\n outline-offset: -2px;\n}\n.btn:hover,\n.btn:focus,\n.btn.focus {\n color: #333;\n text-decoration: none;\n}\n.btn:active,\n.btn.active {\n background-image: none;\n outline: 0;\n -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);\n box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);\n}\n.btn.disabled,\n.btn[disabled],\nfieldset[disabled] .btn {\n cursor: not-allowed;\n filter: alpha(opacity=65);\n opacity: 0.65;\n -webkit-box-shadow: none;\n box-shadow: none;\n}\na.btn.disabled,\nfieldset[disabled] a.btn {\n pointer-events: none;\n}\n.btn-default {\n color: #333;\n background-color: #fff;\n border-color: #ccc;\n}\n.btn-default:focus,\n.btn-default.focus {\n color: #333;\n background-color: #e6e6e6;\n border-color: #8c8c8c;\n}\n.btn-default:hover {\n color: #333;\n background-color: #e6e6e6;\n border-color: #adadad;\n}\n.btn-default:active,\n.btn-default.active,\n.open > .dropdown-toggle.btn-default {\n color: #333;\n background-color: #e6e6e6;\n background-image: none;\n border-color: #adadad;\n}\n.btn-default:active:hover,\n.btn-default.active:hover,\n.open > .dropdown-toggle.btn-default:hover,\n.btn-default:active:focus,\n.btn-default.active:focus,\n.open > .dropdown-toggle.btn-default:focus,\n.btn-default:active.focus,\n.btn-default.active.focus,\n.open > .dropdown-toggle.btn-default.focus {\n color: #333;\n background-color: #d4d4d4;\n border-color: #8c8c8c;\n}\n.btn-default.disabled:hover,\n.btn-default[disabled]:hover,\nfieldset[disabled] .btn-default:hover,\n.btn-default.disabled:focus,\n.btn-default[disabled]:focus,\nfieldset[disabled] .btn-default:focus,\n.btn-default.disabled.focus,\n.btn-default[disabled].focus,\nfieldset[disabled] .btn-default.focus {\n background-color: #fff;\n border-color: #ccc;\n}\n.btn-default .badge {\n color: #fff;\n background-color: #333;\n}\n.btn-primary {\n color: #fff;\n background-color: #337ab7;\n border-color: #2e6da4;\n}\n.btn-primary:focus,\n.btn-primary.focus {\n color: #fff;\n background-color: #286090;\n border-color: #122b40;\n}\n.btn-primary:hover {\n color: #fff;\n background-color: #286090;\n border-color: #204d74;\n}\n.btn-primary:active,\n.btn-primary.active,\n.open > .dropdown-toggle.btn-primary {\n color: #fff;\n background-color: #286090;\n background-image: none;\n border-color: #204d74;\n}\n.btn-primary:active:hover,\n.btn-primary.active:hover,\n.open > .dropdown-toggle.btn-primary:hover,\n.btn-primary:active:focus,\n.btn-primary.active:focus,\n.open > .dropdown-toggle.btn-primary:focus,\n.btn-primary:active.focus,\n.btn-primary.active.focus,\n.open > .dropdown-toggle.btn-primary.focus {\n color: #fff;\n background-color: #204d74;\n border-color: #122b40;\n}\n.btn-primary.disabled:hover,\n.btn-primary[disabled]:hover,\nfieldset[disabled] .btn-primary:hover,\n.btn-primary.disabled:focus,\n.btn-primary[disabled]:focus,\nfieldset[disabled] .btn-primary:focus,\n.btn-primary.disabled.focus,\n.btn-primary[disabled].focus,\nfieldset[disabled] .btn-primary.focus {\n background-color: #337ab7;\n border-color: #2e6da4;\n}\n.btn-primary .badge {\n color: #337ab7;\n background-color: #fff;\n}\n.btn-success {\n color: #fff;\n background-color: #5cb85c;\n border-color: #4cae4c;\n}\n.btn-success:focus,\n.btn-success.focus {\n color: #fff;\n background-color: #449d44;\n border-color: #255625;\n}\n.btn-success:hover {\n color: #fff;\n background-color: #449d44;\n border-color: #398439;\n}\n.btn-success:active,\n.btn-success.active,\n.open > .dropdown-toggle.btn-success {\n color: #fff;\n background-color: #449d44;\n background-image: none;\n border-color: #398439;\n}\n.btn-success:active:hover,\n.btn-success.active:hover,\n.open > .dropdown-toggle.btn-success:hover,\n.btn-success:active:focus,\n.btn-success.active:focus,\n.open > .dropdown-toggle.btn-success:focus,\n.btn-success:active.focus,\n.btn-success.active.focus,\n.open > .dropdown-toggle.btn-success.focus {\n color: #fff;\n background-color: #398439;\n border-color: #255625;\n}\n.btn-success.disabled:hover,\n.btn-success[disabled]:hover,\nfieldset[disabled] .btn-success:hover,\n.btn-success.disabled:focus,\n.btn-success[disabled]:focus,\nfieldset[disabled] .btn-success:focus,\n.btn-success.disabled.focus,\n.btn-success[disabled].focus,\nfieldset[disabled] .btn-success.focus {\n background-color: #5cb85c;\n border-color: #4cae4c;\n}\n.btn-success .badge {\n color: #5cb85c;\n background-color: #fff;\n}\n.btn-info {\n color: #fff;\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n.btn-info:focus,\n.btn-info.focus {\n color: #fff;\n background-color: #31b0d5;\n border-color: #1b6d85;\n}\n.btn-info:hover {\n color: #fff;\n background-color: #31b0d5;\n border-color: #269abc;\n}\n.btn-info:active,\n.btn-info.active,\n.open > .dropdown-toggle.btn-info {\n color: #fff;\n background-color: #31b0d5;\n background-image: none;\n border-color: #269abc;\n}\n.btn-info:active:hover,\n.btn-info.active:hover,\n.open > .dropdown-toggle.btn-info:hover,\n.btn-info:active:focus,\n.btn-info.active:focus,\n.open > .dropdown-toggle.btn-info:focus,\n.btn-info:active.focus,\n.btn-info.active.focus,\n.open > .dropdown-toggle.btn-info.focus {\n color: #fff;\n background-color: #269abc;\n border-color: #1b6d85;\n}\n.btn-info.disabled:hover,\n.btn-info[disabled]:hover,\nfieldset[disabled] .btn-info:hover,\n.btn-info.disabled:focus,\n.btn-info[disabled]:focus,\nfieldset[disabled] .btn-info:focus,\n.btn-info.disabled.focus,\n.btn-info[disabled].focus,\nfieldset[disabled] .btn-info.focus {\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n.btn-info .badge {\n color: #5bc0de;\n background-color: #fff;\n}\n.btn-warning {\n color: #fff;\n background-color: #f0ad4e;\n border-color: #eea236;\n}\n.btn-warning:focus,\n.btn-warning.focus {\n color: #fff;\n background-color: #ec971f;\n border-color: #985f0d;\n}\n.btn-warning:hover {\n color: #fff;\n background-color: #ec971f;\n border-color: #d58512;\n}\n.btn-warning:active,\n.btn-warning.active,\n.open > .dropdown-toggle.btn-warning {\n color: #fff;\n background-color: #ec971f;\n background-image: none;\n border-color: #d58512;\n}\n.btn-warning:active:hover,\n.btn-warning.active:hover,\n.open > .dropdown-toggle.btn-warning:hover,\n.btn-warning:active:focus,\n.btn-warning.active:focus,\n.open > .dropdown-toggle.btn-warning:focus,\n.btn-warning:active.focus,\n.btn-warning.active.focus,\n.open > .dropdown-toggle.btn-warning.focus {\n color: #fff;\n background-color: #d58512;\n border-color: #985f0d;\n}\n.btn-warning.disabled:hover,\n.btn-warning[disabled]:hover,\nfieldset[disabled] .btn-warning:hover,\n.btn-warning.disabled:focus,\n.btn-warning[disabled]:focus,\nfieldset[disabled] .btn-warning:focus,\n.btn-warning.disabled.focus,\n.btn-warning[disabled].focus,\nfieldset[disabled] .btn-warning.focus {\n background-color: #f0ad4e;\n border-color: #eea236;\n}\n.btn-warning .badge {\n color: #f0ad4e;\n background-color: #fff;\n}\n.btn-danger {\n color: #fff;\n background-color: #d9534f;\n border-color: #d43f3a;\n}\n.btn-danger:focus,\n.btn-danger.focus {\n color: #fff;\n background-color: #c9302c;\n border-color: #761c19;\n}\n.btn-danger:hover {\n color: #fff;\n background-color: #c9302c;\n border-color: #ac2925;\n}\n.btn-danger:active,\n.btn-danger.active,\n.open > .dropdown-toggle.btn-danger {\n color: #fff;\n background-color: #c9302c;\n background-image: none;\n border-color: #ac2925;\n}\n.btn-danger:active:hover,\n.btn-danger.active:hover,\n.open > .dropdown-toggle.btn-danger:hover,\n.btn-danger:active:focus,\n.btn-danger.active:focus,\n.open > .dropdown-toggle.btn-danger:focus,\n.btn-danger:active.focus,\n.btn-danger.active.focus,\n.open > .dropdown-toggle.btn-danger.focus {\n color: #fff;\n background-color: #ac2925;\n border-color: #761c19;\n}\n.btn-danger.disabled:hover,\n.btn-danger[disabled]:hover,\nfieldset[disabled] .btn-danger:hover,\n.btn-danger.disabled:focus,\n.btn-danger[disabled]:focus,\nfieldset[disabled] .btn-danger:focus,\n.btn-danger.disabled.focus,\n.btn-danger[disabled].focus,\nfieldset[disabled] .btn-danger.focus {\n background-color: #d9534f;\n border-color: #d43f3a;\n}\n.btn-danger .badge {\n color: #d9534f;\n background-color: #fff;\n}\n.btn-link {\n font-weight: 400;\n color: #337ab7;\n border-radius: 0;\n}\n.btn-link,\n.btn-link:active,\n.btn-link.active,\n.btn-link[disabled],\nfieldset[disabled] .btn-link {\n background-color: transparent;\n -webkit-box-shadow: none;\n box-shadow: none;\n}\n.btn-link,\n.btn-link:hover,\n.btn-link:focus,\n.btn-link:active {\n border-color: transparent;\n}\n.btn-link:hover,\n.btn-link:focus {\n color: #23527c;\n text-decoration: underline;\n background-color: transparent;\n}\n.btn-link[disabled]:hover,\nfieldset[disabled] .btn-link:hover,\n.btn-link[disabled]:focus,\nfieldset[disabled] .btn-link:focus {\n color: #777777;\n text-decoration: none;\n}\n.btn-lg,\n.btn-group-lg > .btn {\n padding: 10px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n border-radius: 6px;\n}\n.btn-sm,\n.btn-group-sm > .btn {\n padding: 5px 10px;\n font-size: 12px;\n line-height: 1.5;\n border-radius: 3px;\n}\n.btn-xs,\n.btn-group-xs > .btn {\n padding: 1px 5px;\n font-size: 12px;\n line-height: 1.5;\n border-radius: 3px;\n}\n.btn-block {\n display: block;\n width: 100%;\n}\n.btn-block + .btn-block {\n margin-top: 5px;\n}\ninput[type=\"submit\"].btn-block,\ninput[type=\"reset\"].btn-block,\ninput[type=\"button\"].btn-block {\n width: 100%;\n}\n.fade {\n opacity: 0;\n -webkit-transition: opacity 0.15s linear;\n -o-transition: opacity 0.15s linear;\n transition: opacity 0.15s linear;\n}\n.fade.in {\n opacity: 1;\n}\n.collapse {\n display: none;\n}\n.collapse.in {\n display: block;\n}\ntr.collapse.in {\n display: table-row;\n}\ntbody.collapse.in {\n display: table-row-group;\n}\n.collapsing {\n position: relative;\n height: 0;\n overflow: hidden;\n -webkit-transition-property: height, visibility;\n transition-property: height, visibility;\n -webkit-transition-duration: 0.35s;\n transition-duration: 0.35s;\n -webkit-transition-timing-function: ease;\n transition-timing-function: ease;\n}\n.caret {\n display: inline-block;\n width: 0;\n height: 0;\n margin-left: 2px;\n vertical-align: middle;\n border-top: 4px dashed;\n border-top: 4px solid \\9;\n border-right: 4px solid transparent;\n border-left: 4px solid transparent;\n}\n.dropup,\n.dropdown {\n position: relative;\n}\n.dropdown-toggle:focus {\n outline: 0;\n}\n.dropdown-menu {\n position: absolute;\n top: 100%;\n left: 0;\n z-index: 1000;\n display: none;\n float: left;\n min-width: 160px;\n padding: 5px 0;\n margin: 2px 0 0;\n font-size: 14px;\n text-align: left;\n list-style: none;\n background-color: #fff;\n background-clip: padding-box;\n border: 1px solid #ccc;\n border: 1px solid rgba(0, 0, 0, 0.15);\n border-radius: 4px;\n -webkit-box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175);\n box-shadow: 0 6px 12px rgba(0, 0, 0, 0.175);\n}\n.dropdown-menu.pull-right {\n right: 0;\n left: auto;\n}\n.dropdown-menu .divider {\n height: 1px;\n margin: 9px 0;\n overflow: hidden;\n background-color: #e5e5e5;\n}\n.dropdown-menu > li > a {\n display: block;\n padding: 3px 20px;\n clear: both;\n font-weight: 400;\n line-height: 1.42857143;\n color: #333333;\n white-space: nowrap;\n}\n.dropdown-menu > li > a:hover,\n.dropdown-menu > li > a:focus {\n color: #262626;\n text-decoration: none;\n background-color: #f5f5f5;\n}\n.dropdown-menu > .active > a,\n.dropdown-menu > .active > a:hover,\n.dropdown-menu > .active > a:focus {\n color: #fff;\n text-decoration: none;\n background-color: #337ab7;\n outline: 0;\n}\n.dropdown-menu > .disabled > a,\n.dropdown-menu > .disabled > a:hover,\n.dropdown-menu > .disabled > a:focus {\n color: #777777;\n}\n.dropdown-menu > .disabled > a:hover,\n.dropdown-menu > .disabled > a:focus {\n text-decoration: none;\n cursor: not-allowed;\n background-color: transparent;\n background-image: none;\n filter: progid:DXImageTransform.Microsoft.gradient(enabled = false);\n}\n.open > .dropdown-menu {\n display: block;\n}\n.open > a {\n outline: 0;\n}\n.dropdown-menu-right {\n right: 0;\n left: auto;\n}\n.dropdown-menu-left {\n right: auto;\n left: 0;\n}\n.dropdown-header {\n display: block;\n padding: 3px 20px;\n font-size: 12px;\n line-height: 1.42857143;\n color: #777777;\n white-space: nowrap;\n}\n.dropdown-backdrop {\n position: fixed;\n top: 0;\n right: 0;\n bottom: 0;\n left: 0;\n z-index: 990;\n}\n.pull-right > .dropdown-menu {\n right: 0;\n left: auto;\n}\n.dropup .caret,\n.navbar-fixed-bottom .dropdown .caret {\n content: \"\";\n border-top: 0;\n border-bottom: 4px dashed;\n border-bottom: 4px solid \\9;\n}\n.dropup .dropdown-menu,\n.navbar-fixed-bottom .dropdown .dropdown-menu {\n top: auto;\n bottom: 100%;\n margin-bottom: 2px;\n}\n@media (min-width: 768px) {\n .navbar-right .dropdown-menu {\n right: 0;\n left: auto;\n }\n .navbar-right .dropdown-menu-left {\n right: auto;\n left: 0;\n }\n}\n.btn-group,\n.btn-group-vertical {\n position: relative;\n display: inline-block;\n vertical-align: middle;\n}\n.btn-group > .btn,\n.btn-group-vertical > .btn {\n position: relative;\n float: left;\n}\n.btn-group > .btn:hover,\n.btn-group-vertical > .btn:hover,\n.btn-group > .btn:focus,\n.btn-group-vertical > .btn:focus,\n.btn-group > .btn:active,\n.btn-group-vertical > .btn:active,\n.btn-group > .btn.active,\n.btn-group-vertical > .btn.active {\n z-index: 2;\n}\n.btn-group .btn + .btn,\n.btn-group .btn + .btn-group,\n.btn-group .btn-group + .btn,\n.btn-group .btn-group + .btn-group {\n margin-left: -1px;\n}\n.btn-toolbar {\n margin-left: -5px;\n}\n.btn-toolbar .btn,\n.btn-toolbar .btn-group,\n.btn-toolbar .input-group {\n float: left;\n}\n.btn-toolbar > .btn,\n.btn-toolbar > .btn-group,\n.btn-toolbar > .input-group {\n margin-left: 5px;\n}\n.btn-group > .btn:not(:first-child):not(:last-child):not(.dropdown-toggle) {\n border-radius: 0;\n}\n.btn-group > .btn:first-child {\n margin-left: 0;\n}\n.btn-group > .btn:first-child:not(:last-child):not(.dropdown-toggle) {\n border-top-right-radius: 0;\n border-bottom-right-radius: 0;\n}\n.btn-group > .btn:last-child:not(:first-child),\n.btn-group > .dropdown-toggle:not(:first-child) {\n border-top-left-radius: 0;\n border-bottom-left-radius: 0;\n}\n.btn-group > .btn-group {\n float: left;\n}\n.btn-group > .btn-group:not(:first-child):not(:last-child) > .btn {\n border-radius: 0;\n}\n.btn-group > .btn-group:first-child:not(:last-child) > .btn:last-child,\n.btn-group > .btn-group:first-child:not(:last-child) > .dropdown-toggle {\n border-top-right-radius: 0;\n border-bottom-right-radius: 0;\n}\n.btn-group > .btn-group:last-child:not(:first-child) > .btn:first-child {\n border-top-left-radius: 0;\n border-bottom-left-radius: 0;\n}\n.btn-group .dropdown-toggle:active,\n.btn-group.open .dropdown-toggle {\n outline: 0;\n}\n.btn-group > .btn + .dropdown-toggle {\n padding-right: 8px;\n padding-left: 8px;\n}\n.btn-group > .btn-lg + .dropdown-toggle {\n padding-right: 12px;\n padding-left: 12px;\n}\n.btn-group.open .dropdown-toggle {\n -webkit-box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);\n box-shadow: inset 0 3px 5px rgba(0, 0, 0, 0.125);\n}\n.btn-group.open .dropdown-toggle.btn-link {\n -webkit-box-shadow: none;\n box-shadow: none;\n}\n.btn .caret {\n margin-left: 0;\n}\n.btn-lg .caret {\n border-width: 5px 5px 0;\n border-bottom-width: 0;\n}\n.dropup .btn-lg .caret {\n border-width: 0 5px 5px;\n}\n.btn-group-vertical > .btn,\n.btn-group-vertical > .btn-group,\n.btn-group-vertical > .btn-group > .btn {\n display: block;\n float: none;\n width: 100%;\n max-width: 100%;\n}\n.btn-group-vertical > .btn-group > .btn {\n float: none;\n}\n.btn-group-vertical > .btn + .btn,\n.btn-group-vertical > .btn + .btn-group,\n.btn-group-vertical > .btn-group + .btn,\n.btn-group-vertical > .btn-group + .btn-group {\n margin-top: -1px;\n margin-left: 0;\n}\n.btn-group-vertical > .btn:not(:first-child):not(:last-child) {\n border-radius: 0;\n}\n.btn-group-vertical > .btn:first-child:not(:last-child) {\n border-top-left-radius: 4px;\n border-top-right-radius: 4px;\n border-bottom-right-radius: 0;\n border-bottom-left-radius: 0;\n}\n.btn-group-vertical > .btn:last-child:not(:first-child) {\n border-top-left-radius: 0;\n border-top-right-radius: 0;\n border-bottom-right-radius: 4px;\n border-bottom-left-radius: 4px;\n}\n.btn-group-vertical > .btn-group:not(:first-child):not(:last-child) > .btn {\n border-radius: 0;\n}\n.btn-group-vertical > .btn-group:first-child:not(:last-child) > .btn:last-child,\n.btn-group-vertical > .btn-group:first-child:not(:last-child) > .dropdown-toggle {\n border-bottom-right-radius: 0;\n border-bottom-left-radius: 0;\n}\n.btn-group-vertical > .btn-group:last-child:not(:first-child) > .btn:first-child {\n border-top-left-radius: 0;\n border-top-right-radius: 0;\n}\n.btn-group-justified {\n display: table;\n width: 100%;\n table-layout: fixed;\n border-collapse: separate;\n}\n.btn-group-justified > .btn,\n.btn-group-justified > .btn-group {\n display: table-cell;\n float: none;\n width: 1%;\n}\n.btn-group-justified > .btn-group .btn {\n width: 100%;\n}\n.btn-group-justified > .btn-group .dropdown-menu {\n left: auto;\n}\n[data-toggle=\"buttons\"] > .btn input[type=\"radio\"],\n[data-toggle=\"buttons\"] > .btn-group > .btn input[type=\"radio\"],\n[data-toggle=\"buttons\"] > .btn input[type=\"checkbox\"],\n[data-toggle=\"buttons\"] > .btn-group > .btn input[type=\"checkbox\"] {\n position: absolute;\n clip: rect(0, 0, 0, 0);\n pointer-events: none;\n}\n.input-group {\n position: relative;\n display: table;\n border-collapse: separate;\n}\n.input-group[class*=\"col-\"] {\n float: none;\n padding-right: 0;\n padding-left: 0;\n}\n.input-group .form-control {\n position: relative;\n z-index: 2;\n float: left;\n width: 100%;\n margin-bottom: 0;\n}\n.input-group .form-control:focus {\n z-index: 3;\n}\n.input-group-lg > .form-control,\n.input-group-lg > .input-group-addon,\n.input-group-lg > .input-group-btn > .btn {\n height: 46px;\n padding: 10px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n border-radius: 6px;\n}\nselect.input-group-lg > .form-control,\nselect.input-group-lg > .input-group-addon,\nselect.input-group-lg > .input-group-btn > .btn {\n height: 46px;\n line-height: 46px;\n}\ntextarea.input-group-lg > .form-control,\ntextarea.input-group-lg > .input-group-addon,\ntextarea.input-group-lg > .input-group-btn > .btn,\nselect[multiple].input-group-lg > .form-control,\nselect[multiple].input-group-lg > .input-group-addon,\nselect[multiple].input-group-lg > .input-group-btn > .btn {\n height: auto;\n}\n.input-group-sm > .form-control,\n.input-group-sm > .input-group-addon,\n.input-group-sm > .input-group-btn > .btn {\n height: 30px;\n padding: 5px 10px;\n font-size: 12px;\n line-height: 1.5;\n border-radius: 3px;\n}\nselect.input-group-sm > .form-control,\nselect.input-group-sm > .input-group-addon,\nselect.input-group-sm > .input-group-btn > .btn {\n height: 30px;\n line-height: 30px;\n}\ntextarea.input-group-sm > .form-control,\ntextarea.input-group-sm > .input-group-addon,\ntextarea.input-group-sm > .input-group-btn > .btn,\nselect[multiple].input-group-sm > .form-control,\nselect[multiple].input-group-sm > .input-group-addon,\nselect[multiple].input-group-sm > .input-group-btn > .btn {\n height: auto;\n}\n.input-group-addon,\n.input-group-btn,\n.input-group .form-control {\n display: table-cell;\n}\n.input-group-addon:not(:first-child):not(:last-child),\n.input-group-btn:not(:first-child):not(:last-child),\n.input-group .form-control:not(:first-child):not(:last-child) {\n border-radius: 0;\n}\n.input-group-addon,\n.input-group-btn {\n width: 1%;\n white-space: nowrap;\n vertical-align: middle;\n}\n.input-group-addon {\n padding: 6px 12px;\n font-size: 14px;\n font-weight: 400;\n line-height: 1;\n color: #555555;\n text-align: center;\n background-color: #eeeeee;\n border: 1px solid #ccc;\n border-radius: 4px;\n}\n.input-group-addon.input-sm {\n padding: 5px 10px;\n font-size: 12px;\n border-radius: 3px;\n}\n.input-group-addon.input-lg {\n padding: 10px 16px;\n font-size: 18px;\n border-radius: 6px;\n}\n.input-group-addon input[type=\"radio\"],\n.input-group-addon input[type=\"checkbox\"] {\n margin-top: 0;\n}\n.input-group .form-control:first-child,\n.input-group-addon:first-child,\n.input-group-btn:first-child > .btn,\n.input-group-btn:first-child > .btn-group > .btn,\n.input-group-btn:first-child > .dropdown-toggle,\n.input-group-btn:last-child > .btn:not(:last-child):not(.dropdown-toggle),\n.input-group-btn:last-child > .btn-group:not(:last-child) > .btn {\n border-top-right-radius: 0;\n border-bottom-right-radius: 0;\n}\n.input-group-addon:first-child {\n border-right: 0;\n}\n.input-group .form-control:last-child,\n.input-group-addon:last-child,\n.input-group-btn:last-child > .btn,\n.input-group-btn:last-child > .btn-group > .btn,\n.input-group-btn:last-child > .dropdown-toggle,\n.input-group-btn:first-child > .btn:not(:first-child),\n.input-group-btn:first-child > .btn-group:not(:first-child) > .btn {\n border-top-left-radius: 0;\n border-bottom-left-radius: 0;\n}\n.input-group-addon:last-child {\n border-left: 0;\n}\n.input-group-btn {\n position: relative;\n font-size: 0;\n white-space: nowrap;\n}\n.input-group-btn > .btn {\n position: relative;\n}\n.input-group-btn > .btn + .btn {\n margin-left: -1px;\n}\n.input-group-btn > .btn:hover,\n.input-group-btn > .btn:focus,\n.input-group-btn > .btn:active {\n z-index: 2;\n}\n.input-group-btn:first-child > .btn,\n.input-group-btn:first-child > .btn-group {\n margin-right: -1px;\n}\n.input-group-btn:last-child > .btn,\n.input-group-btn:last-child > .btn-group {\n z-index: 2;\n margin-left: -1px;\n}\n.nav {\n padding-left: 0;\n margin-bottom: 0;\n list-style: none;\n}\n.nav > li {\n position: relative;\n display: block;\n}\n.nav > li > a {\n position: relative;\n display: block;\n padding: 10px 15px;\n}\n.nav > li > a:hover,\n.nav > li > a:focus {\n text-decoration: none;\n background-color: #eeeeee;\n}\n.nav > li.disabled > a {\n color: #777777;\n}\n.nav > li.disabled > a:hover,\n.nav > li.disabled > a:focus {\n color: #777777;\n text-decoration: none;\n cursor: not-allowed;\n background-color: transparent;\n}\n.nav .open > a,\n.nav .open > a:hover,\n.nav .open > a:focus {\n background-color: #eeeeee;\n border-color: #337ab7;\n}\n.nav .nav-divider {\n height: 1px;\n margin: 9px 0;\n overflow: hidden;\n background-color: #e5e5e5;\n}\n.nav > li > a > img {\n max-width: none;\n}\n.nav-tabs {\n border-bottom: 1px solid #ddd;\n}\n.nav-tabs > li {\n float: left;\n margin-bottom: -1px;\n}\n.nav-tabs > li > a {\n margin-right: 2px;\n line-height: 1.42857143;\n border: 1px solid transparent;\n border-radius: 4px 4px 0 0;\n}\n.nav-tabs > li > a:hover {\n border-color: #eeeeee #eeeeee #ddd;\n}\n.nav-tabs > li.active > a,\n.nav-tabs > li.active > a:hover,\n.nav-tabs > li.active > a:focus {\n color: #555555;\n cursor: default;\n background-color: #fff;\n border: 1px solid #ddd;\n border-bottom-color: transparent;\n}\n.nav-tabs.nav-justified {\n width: 100%;\n border-bottom: 0;\n}\n.nav-tabs.nav-justified > li {\n float: none;\n}\n.nav-tabs.nav-justified > li > a {\n margin-bottom: 5px;\n text-align: center;\n}\n.nav-tabs.nav-justified > .dropdown .dropdown-menu {\n top: auto;\n left: auto;\n}\n@media (min-width: 768px) {\n .nav-tabs.nav-justified > li {\n display: table-cell;\n width: 1%;\n }\n .nav-tabs.nav-justified > li > a {\n margin-bottom: 0;\n }\n}\n.nav-tabs.nav-justified > li > a {\n margin-right: 0;\n border-radius: 4px;\n}\n.nav-tabs.nav-justified > .active > a,\n.nav-tabs.nav-justified > .active > a:hover,\n.nav-tabs.nav-justified > .active > a:focus {\n border: 1px solid #ddd;\n}\n@media (min-width: 768px) {\n .nav-tabs.nav-justified > li > a {\n border-bottom: 1px solid #ddd;\n border-radius: 4px 4px 0 0;\n }\n .nav-tabs.nav-justified > .active > a,\n .nav-tabs.nav-justified > .active > a:hover,\n .nav-tabs.nav-justified > .active > a:focus {\n border-bottom-color: #fff;\n }\n}\n.nav-pills > li {\n float: left;\n}\n.nav-pills > li > a {\n border-radius: 4px;\n}\n.nav-pills > li + li {\n margin-left: 2px;\n}\n.nav-pills > li.active > a,\n.nav-pills > li.active > a:hover,\n.nav-pills > li.active > a:focus {\n color: #fff;\n background-color: #337ab7;\n}\n.nav-stacked > li {\n float: none;\n}\n.nav-stacked > li + li {\n margin-top: 2px;\n margin-left: 0;\n}\n.nav-justified {\n width: 100%;\n}\n.nav-justified > li {\n float: none;\n}\n.nav-justified > li > a {\n margin-bottom: 5px;\n text-align: center;\n}\n.nav-justified > .dropdown .dropdown-menu {\n top: auto;\n left: auto;\n}\n@media (min-width: 768px) {\n .nav-justified > li {\n display: table-cell;\n width: 1%;\n }\n .nav-justified > li > a {\n margin-bottom: 0;\n }\n}\n.nav-tabs-justified {\n border-bottom: 0;\n}\n.nav-tabs-justified > li > a {\n margin-right: 0;\n border-radius: 4px;\n}\n.nav-tabs-justified > .active > a,\n.nav-tabs-justified > .active > a:hover,\n.nav-tabs-justified > .active > a:focus {\n border: 1px solid #ddd;\n}\n@media (min-width: 768px) {\n .nav-tabs-justified > li > a {\n border-bottom: 1px solid #ddd;\n border-radius: 4px 4px 0 0;\n }\n .nav-tabs-justified > .active > a,\n .nav-tabs-justified > .active > a:hover,\n .nav-tabs-justified > .active > a:focus {\n border-bottom-color: #fff;\n }\n}\n.tab-content > .tab-pane {\n display: none;\n}\n.tab-content > .active {\n display: block;\n}\n.nav-tabs .dropdown-menu {\n margin-top: -1px;\n border-top-left-radius: 0;\n border-top-right-radius: 0;\n}\n.navbar {\n position: relative;\n min-height: 50px;\n margin-bottom: 20px;\n border: 1px solid transparent;\n}\n@media (min-width: 768px) {\n .navbar {\n border-radius: 4px;\n }\n}\n@media (min-width: 768px) {\n .navbar-header {\n float: left;\n }\n}\n.navbar-collapse {\n padding-right: 15px;\n padding-left: 15px;\n overflow-x: visible;\n border-top: 1px solid transparent;\n box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1);\n -webkit-overflow-scrolling: touch;\n}\n.navbar-collapse.in {\n overflow-y: auto;\n}\n@media (min-width: 768px) {\n .navbar-collapse {\n width: auto;\n border-top: 0;\n box-shadow: none;\n }\n .navbar-collapse.collapse {\n display: block !important;\n height: auto !important;\n padding-bottom: 0;\n overflow: visible !important;\n }\n .navbar-collapse.in {\n overflow-y: visible;\n }\n .navbar-fixed-top .navbar-collapse,\n .navbar-static-top .navbar-collapse,\n .navbar-fixed-bottom .navbar-collapse {\n padding-right: 0;\n padding-left: 0;\n }\n}\n.navbar-fixed-top,\n.navbar-fixed-bottom {\n position: fixed;\n right: 0;\n left: 0;\n z-index: 1030;\n}\n.navbar-fixed-top .navbar-collapse,\n.navbar-fixed-bottom .navbar-collapse {\n max-height: 340px;\n}\n@media (max-device-width: 480px) and (orientation: landscape) {\n .navbar-fixed-top .navbar-collapse,\n .navbar-fixed-bottom .navbar-collapse {\n max-height: 200px;\n }\n}\n@media (min-width: 768px) {\n .navbar-fixed-top,\n .navbar-fixed-bottom {\n border-radius: 0;\n }\n}\n.navbar-fixed-top {\n top: 0;\n border-width: 0 0 1px;\n}\n.navbar-fixed-bottom {\n bottom: 0;\n margin-bottom: 0;\n border-width: 1px 0 0;\n}\n.container > .navbar-header,\n.container-fluid > .navbar-header,\n.container > .navbar-collapse,\n.container-fluid > .navbar-collapse {\n margin-right: -15px;\n margin-left: -15px;\n}\n@media (min-width: 768px) {\n .container > .navbar-header,\n .container-fluid > .navbar-header,\n .container > .navbar-collapse,\n .container-fluid > .navbar-collapse {\n margin-right: 0;\n margin-left: 0;\n }\n}\n.navbar-static-top {\n z-index: 1000;\n border-width: 0 0 1px;\n}\n@media (min-width: 768px) {\n .navbar-static-top {\n border-radius: 0;\n }\n}\n.navbar-brand {\n float: left;\n height: 50px;\n padding: 15px 15px;\n font-size: 18px;\n line-height: 20px;\n}\n.navbar-brand:hover,\n.navbar-brand:focus {\n text-decoration: none;\n}\n.navbar-brand > img {\n display: block;\n}\n@media (min-width: 768px) {\n .navbar > .container .navbar-brand,\n .navbar > .container-fluid .navbar-brand {\n margin-left: -15px;\n }\n}\n.navbar-toggle {\n position: relative;\n float: right;\n padding: 9px 10px;\n margin-right: 15px;\n margin-top: 8px;\n margin-bottom: 8px;\n background-color: transparent;\n background-image: none;\n border: 1px solid transparent;\n border-radius: 4px;\n}\n.navbar-toggle:focus {\n outline: 0;\n}\n.navbar-toggle .icon-bar {\n display: block;\n width: 22px;\n height: 2px;\n border-radius: 1px;\n}\n.navbar-toggle .icon-bar + .icon-bar {\n margin-top: 4px;\n}\n@media (min-width: 768px) {\n .navbar-toggle {\n display: none;\n }\n}\n.navbar-nav {\n margin: 7.5px -15px;\n}\n.navbar-nav > li > a {\n padding-top: 10px;\n padding-bottom: 10px;\n line-height: 20px;\n}\n@media (max-width: 767px) {\n .navbar-nav .open .dropdown-menu {\n position: static;\n float: none;\n width: auto;\n margin-top: 0;\n background-color: transparent;\n border: 0;\n box-shadow: none;\n }\n .navbar-nav .open .dropdown-menu > li > a,\n .navbar-nav .open .dropdown-menu .dropdown-header {\n padding: 5px 15px 5px 25px;\n }\n .navbar-nav .open .dropdown-menu > li > a {\n line-height: 20px;\n }\n .navbar-nav .open .dropdown-menu > li > a:hover,\n .navbar-nav .open .dropdown-menu > li > a:focus {\n background-image: none;\n }\n}\n@media (min-width: 768px) {\n .navbar-nav {\n float: left;\n margin: 0;\n }\n .navbar-nav > li {\n float: left;\n }\n .navbar-nav > li > a {\n padding-top: 15px;\n padding-bottom: 15px;\n }\n}\n.navbar-form {\n padding: 10px 15px;\n margin-right: -15px;\n margin-left: -15px;\n border-top: 1px solid transparent;\n border-bottom: 1px solid transparent;\n -webkit-box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1);\n box-shadow: inset 0 1px 0 rgba(255, 255, 255, 0.1), 0 1px 0 rgba(255, 255, 255, 0.1);\n margin-top: 8px;\n margin-bottom: 8px;\n}\n@media (min-width: 768px) {\n .navbar-form .form-group {\n display: inline-block;\n margin-bottom: 0;\n vertical-align: middle;\n }\n .navbar-form .form-control {\n display: inline-block;\n width: auto;\n vertical-align: middle;\n }\n .navbar-form .form-control-static {\n display: inline-block;\n }\n .navbar-form .input-group {\n display: inline-table;\n vertical-align: middle;\n }\n .navbar-form .input-group .input-group-addon,\n .navbar-form .input-group .input-group-btn,\n .navbar-form .input-group .form-control {\n width: auto;\n }\n .navbar-form .input-group > .form-control {\n width: 100%;\n }\n .navbar-form .control-label {\n margin-bottom: 0;\n vertical-align: middle;\n }\n .navbar-form .radio,\n .navbar-form .checkbox {\n display: inline-block;\n margin-top: 0;\n margin-bottom: 0;\n vertical-align: middle;\n }\n .navbar-form .radio label,\n .navbar-form .checkbox label {\n padding-left: 0;\n }\n .navbar-form .radio input[type=\"radio\"],\n .navbar-form .checkbox input[type=\"checkbox\"] {\n position: relative;\n margin-left: 0;\n }\n .navbar-form .has-feedback .form-control-feedback {\n top: 0;\n }\n}\n@media (max-width: 767px) {\n .navbar-form .form-group {\n margin-bottom: 5px;\n }\n .navbar-form .form-group:last-child {\n margin-bottom: 0;\n }\n}\n@media (min-width: 768px) {\n .navbar-form {\n width: auto;\n padding-top: 0;\n padding-bottom: 0;\n margin-right: 0;\n margin-left: 0;\n border: 0;\n -webkit-box-shadow: none;\n box-shadow: none;\n }\n}\n.navbar-nav > li > .dropdown-menu {\n margin-top: 0;\n border-top-left-radius: 0;\n border-top-right-radius: 0;\n}\n.navbar-fixed-bottom .navbar-nav > li > .dropdown-menu {\n margin-bottom: 0;\n border-top-left-radius: 4px;\n border-top-right-radius: 4px;\n border-bottom-right-radius: 0;\n border-bottom-left-radius: 0;\n}\n.navbar-btn {\n margin-top: 8px;\n margin-bottom: 8px;\n}\n.navbar-btn.btn-sm {\n margin-top: 10px;\n margin-bottom: 10px;\n}\n.navbar-btn.btn-xs {\n margin-top: 14px;\n margin-bottom: 14px;\n}\n.navbar-text {\n margin-top: 15px;\n margin-bottom: 15px;\n}\n@media (min-width: 768px) {\n .navbar-text {\n float: left;\n margin-right: 15px;\n margin-left: 15px;\n }\n}\n@media (min-width: 768px) {\n .navbar-left {\n float: left !important;\n }\n .navbar-right {\n float: right !important;\n margin-right: -15px;\n }\n .navbar-right ~ .navbar-right {\n margin-right: 0;\n }\n}\n.navbar-default {\n background-color: #f8f8f8;\n border-color: #e7e7e7;\n}\n.navbar-default .navbar-brand {\n color: #777;\n}\n.navbar-default .navbar-brand:hover,\n.navbar-default .navbar-brand:focus {\n color: #5e5e5e;\n background-color: transparent;\n}\n.navbar-default .navbar-text {\n color: #777;\n}\n.navbar-default .navbar-nav > li > a {\n color: #777;\n}\n.navbar-default .navbar-nav > li > a:hover,\n.navbar-default .navbar-nav > li > a:focus {\n color: #333;\n background-color: transparent;\n}\n.navbar-default .navbar-nav > .active > a,\n.navbar-default .navbar-nav > .active > a:hover,\n.navbar-default .navbar-nav > .active > a:focus {\n color: #555;\n background-color: #e7e7e7;\n}\n.navbar-default .navbar-nav > .disabled > a,\n.navbar-default .navbar-nav > .disabled > a:hover,\n.navbar-default .navbar-nav > .disabled > a:focus {\n color: #ccc;\n background-color: transparent;\n}\n.navbar-default .navbar-nav > .open > a,\n.navbar-default .navbar-nav > .open > a:hover,\n.navbar-default .navbar-nav > .open > a:focus {\n color: #555;\n background-color: #e7e7e7;\n}\n@media (max-width: 767px) {\n .navbar-default .navbar-nav .open .dropdown-menu > li > a {\n color: #777;\n }\n .navbar-default .navbar-nav .open .dropdown-menu > li > a:hover,\n .navbar-default .navbar-nav .open .dropdown-menu > li > a:focus {\n color: #333;\n background-color: transparent;\n }\n .navbar-default .navbar-nav .open .dropdown-menu > .active > a,\n .navbar-default .navbar-nav .open .dropdown-menu > .active > a:hover,\n .navbar-default .navbar-nav .open .dropdown-menu > .active > a:focus {\n color: #555;\n background-color: #e7e7e7;\n }\n .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a,\n .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:hover,\n .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:focus {\n color: #ccc;\n background-color: transparent;\n }\n}\n.navbar-default .navbar-toggle {\n border-color: #ddd;\n}\n.navbar-default .navbar-toggle:hover,\n.navbar-default .navbar-toggle:focus {\n background-color: #ddd;\n}\n.navbar-default .navbar-toggle .icon-bar {\n background-color: #888;\n}\n.navbar-default .navbar-collapse,\n.navbar-default .navbar-form {\n border-color: #e7e7e7;\n}\n.navbar-default .navbar-link {\n color: #777;\n}\n.navbar-default .navbar-link:hover {\n color: #333;\n}\n.navbar-default .btn-link {\n color: #777;\n}\n.navbar-default .btn-link:hover,\n.navbar-default .btn-link:focus {\n color: #333;\n}\n.navbar-default .btn-link[disabled]:hover,\nfieldset[disabled] .navbar-default .btn-link:hover,\n.navbar-default .btn-link[disabled]:focus,\nfieldset[disabled] .navbar-default .btn-link:focus {\n color: #ccc;\n}\n.navbar-inverse {\n background-color: #222;\n border-color: #080808;\n}\n.navbar-inverse .navbar-brand {\n color: #9d9d9d;\n}\n.navbar-inverse .navbar-brand:hover,\n.navbar-inverse .navbar-brand:focus {\n color: #fff;\n background-color: transparent;\n}\n.navbar-inverse .navbar-text {\n color: #9d9d9d;\n}\n.navbar-inverse .navbar-nav > li > a {\n color: #9d9d9d;\n}\n.navbar-inverse .navbar-nav > li > a:hover,\n.navbar-inverse .navbar-nav > li > a:focus {\n color: #fff;\n background-color: transparent;\n}\n.navbar-inverse .navbar-nav > .active > a,\n.navbar-inverse .navbar-nav > .active > a:hover,\n.navbar-inverse .navbar-nav > .active > a:focus {\n color: #fff;\n background-color: #080808;\n}\n.navbar-inverse .navbar-nav > .disabled > a,\n.navbar-inverse .navbar-nav > .disabled > a:hover,\n.navbar-inverse .navbar-nav > .disabled > a:focus {\n color: #444;\n background-color: transparent;\n}\n.navbar-inverse .navbar-nav > .open > a,\n.navbar-inverse .navbar-nav > .open > a:hover,\n.navbar-inverse .navbar-nav > .open > a:focus {\n color: #fff;\n background-color: #080808;\n}\n@media (max-width: 767px) {\n .navbar-inverse .navbar-nav .open .dropdown-menu > .dropdown-header {\n border-color: #080808;\n }\n .navbar-inverse .navbar-nav .open .dropdown-menu .divider {\n background-color: #080808;\n }\n .navbar-inverse .navbar-nav .open .dropdown-menu > li > a {\n color: #9d9d9d;\n }\n .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:hover,\n .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:focus {\n color: #fff;\n background-color: transparent;\n }\n .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a,\n .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:hover,\n .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:focus {\n color: #fff;\n background-color: #080808;\n }\n .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a,\n .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:hover,\n .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:focus {\n color: #444;\n background-color: transparent;\n }\n}\n.navbar-inverse .navbar-toggle {\n border-color: #333;\n}\n.navbar-inverse .navbar-toggle:hover,\n.navbar-inverse .navbar-toggle:focus {\n background-color: #333;\n}\n.navbar-inverse .navbar-toggle .icon-bar {\n background-color: #fff;\n}\n.navbar-inverse .navbar-collapse,\n.navbar-inverse .navbar-form {\n border-color: #101010;\n}\n.navbar-inverse .navbar-link {\n color: #9d9d9d;\n}\n.navbar-inverse .navbar-link:hover {\n color: #fff;\n}\n.navbar-inverse .btn-link {\n color: #9d9d9d;\n}\n.navbar-inverse .btn-link:hover,\n.navbar-inverse .btn-link:focus {\n color: #fff;\n}\n.navbar-inverse .btn-link[disabled]:hover,\nfieldset[disabled] .navbar-inverse .btn-link:hover,\n.navbar-inverse .btn-link[disabled]:focus,\nfieldset[disabled] .navbar-inverse .btn-link:focus {\n color: #444;\n}\n.breadcrumb {\n padding: 8px 15px;\n margin-bottom: 20px;\n list-style: none;\n background-color: #f5f5f5;\n border-radius: 4px;\n}\n.breadcrumb > li {\n display: inline-block;\n}\n.breadcrumb > li + li:before {\n padding: 0 5px;\n color: #ccc;\n content: \"/\\00a0\";\n}\n.breadcrumb > .active {\n color: #777777;\n}\n.pagination {\n display: inline-block;\n padding-left: 0;\n margin: 20px 0;\n border-radius: 4px;\n}\n.pagination > li {\n display: inline;\n}\n.pagination > li > a,\n.pagination > li > span {\n position: relative;\n float: left;\n padding: 6px 12px;\n margin-left: -1px;\n line-height: 1.42857143;\n color: #337ab7;\n text-decoration: none;\n background-color: #fff;\n border: 1px solid #ddd;\n}\n.pagination > li > a:hover,\n.pagination > li > span:hover,\n.pagination > li > a:focus,\n.pagination > li > span:focus {\n z-index: 2;\n color: #23527c;\n background-color: #eeeeee;\n border-color: #ddd;\n}\n.pagination > li:first-child > a,\n.pagination > li:first-child > span {\n margin-left: 0;\n border-top-left-radius: 4px;\n border-bottom-left-radius: 4px;\n}\n.pagination > li:last-child > a,\n.pagination > li:last-child > span {\n border-top-right-radius: 4px;\n border-bottom-right-radius: 4px;\n}\n.pagination > .active > a,\n.pagination > .active > span,\n.pagination > .active > a:hover,\n.pagination > .active > span:hover,\n.pagination > .active > a:focus,\n.pagination > .active > span:focus {\n z-index: 3;\n color: #fff;\n cursor: default;\n background-color: #337ab7;\n border-color: #337ab7;\n}\n.pagination > .disabled > span,\n.pagination > .disabled > span:hover,\n.pagination > .disabled > span:focus,\n.pagination > .disabled > a,\n.pagination > .disabled > a:hover,\n.pagination > .disabled > a:focus {\n color: #777777;\n cursor: not-allowed;\n background-color: #fff;\n border-color: #ddd;\n}\n.pagination-lg > li > a,\n.pagination-lg > li > span {\n padding: 10px 16px;\n font-size: 18px;\n line-height: 1.3333333;\n}\n.pagination-lg > li:first-child > a,\n.pagination-lg > li:first-child > span {\n border-top-left-radius: 6px;\n border-bottom-left-radius: 6px;\n}\n.pagination-lg > li:last-child > a,\n.pagination-lg > li:last-child > span {\n border-top-right-radius: 6px;\n border-bottom-right-radius: 6px;\n}\n.pagination-sm > li > a,\n.pagination-sm > li > span {\n padding: 5px 10px;\n font-size: 12px;\n line-height: 1.5;\n}\n.pagination-sm > li:first-child > a,\n.pagination-sm > li:first-child > span {\n border-top-left-radius: 3px;\n border-bottom-left-radius: 3px;\n}\n.pagination-sm > li:last-child > a,\n.pagination-sm > li:last-child > span {\n border-top-right-radius: 3px;\n border-bottom-right-radius: 3px;\n}\n.pager {\n padding-left: 0;\n margin: 20px 0;\n text-align: center;\n list-style: none;\n}\n.pager li {\n display: inline;\n}\n.pager li > a,\n.pager li > span {\n display: inline-block;\n padding: 5px 14px;\n background-color: #fff;\n border: 1px solid #ddd;\n border-radius: 15px;\n}\n.pager li > a:hover,\n.pager li > a:focus {\n text-decoration: none;\n background-color: #eeeeee;\n}\n.pager .next > a,\n.pager .next > span {\n float: right;\n}\n.pager .previous > a,\n.pager .previous > span {\n float: left;\n}\n.pager .disabled > a,\n.pager .disabled > a:hover,\n.pager .disabled > a:focus,\n.pager .disabled > span {\n color: #777777;\n cursor: not-allowed;\n background-color: #fff;\n}\n.label {\n display: inline;\n padding: 0.2em 0.6em 0.3em;\n font-size: 75%;\n font-weight: 700;\n line-height: 1;\n color: #fff;\n text-align: center;\n white-space: nowrap;\n vertical-align: baseline;\n border-radius: 0.25em;\n}\na.label:hover,\na.label:focus {\n color: #fff;\n text-decoration: none;\n cursor: pointer;\n}\n.label:empty {\n display: none;\n}\n.btn .label {\n position: relative;\n top: -1px;\n}\n.label-default {\n background-color: #777777;\n}\n.label-default[href]:hover,\n.label-default[href]:focus {\n background-color: #5e5e5e;\n}\n.label-primary {\n background-color: #337ab7;\n}\n.label-primary[href]:hover,\n.label-primary[href]:focus {\n background-color: #286090;\n}\n.label-success {\n background-color: #5cb85c;\n}\n.label-success[href]:hover,\n.label-success[href]:focus {\n background-color: #449d44;\n}\n.label-info {\n background-color: #5bc0de;\n}\n.label-info[href]:hover,\n.label-info[href]:focus {\n background-color: #31b0d5;\n}\n.label-warning {\n background-color: #f0ad4e;\n}\n.label-warning[href]:hover,\n.label-warning[href]:focus {\n background-color: #ec971f;\n}\n.label-danger {\n background-color: #d9534f;\n}\n.label-danger[href]:hover,\n.label-danger[href]:focus {\n background-color: #c9302c;\n}\n.badge {\n display: inline-block;\n min-width: 10px;\n padding: 3px 7px;\n font-size: 12px;\n font-weight: bold;\n line-height: 1;\n color: #fff;\n text-align: center;\n white-space: nowrap;\n vertical-align: middle;\n background-color: #777777;\n border-radius: 10px;\n}\n.badge:empty {\n display: none;\n}\n.btn .badge {\n position: relative;\n top: -1px;\n}\n.btn-xs .badge,\n.btn-group-xs > .btn .badge {\n top: 0;\n padding: 1px 5px;\n}\na.badge:hover,\na.badge:focus {\n color: #fff;\n text-decoration: none;\n cursor: pointer;\n}\n.list-group-item.active > .badge,\n.nav-pills > .active > a > .badge {\n color: #337ab7;\n background-color: #fff;\n}\n.list-group-item > .badge {\n float: right;\n}\n.list-group-item > .badge + .badge {\n margin-right: 5px;\n}\n.nav-pills > li > a > .badge {\n margin-left: 3px;\n}\n.jumbotron {\n padding-top: 30px;\n padding-bottom: 30px;\n margin-bottom: 30px;\n color: inherit;\n background-color: #eeeeee;\n}\n.jumbotron h1,\n.jumbotron .h1 {\n color: inherit;\n}\n.jumbotron p {\n margin-bottom: 15px;\n font-size: 21px;\n font-weight: 200;\n}\n.jumbotron > hr {\n border-top-color: #d5d5d5;\n}\n.container .jumbotron,\n.container-fluid .jumbotron {\n padding-right: 15px;\n padding-left: 15px;\n border-radius: 6px;\n}\n.jumbotron .container {\n max-width: 100%;\n}\n@media screen and (min-width: 768px) {\n .jumbotron {\n padding-top: 48px;\n padding-bottom: 48px;\n }\n .container .jumbotron,\n .container-fluid .jumbotron {\n padding-right: 60px;\n padding-left: 60px;\n }\n .jumbotron h1,\n .jumbotron .h1 {\n font-size: 63px;\n }\n}\n.thumbnail {\n display: block;\n padding: 4px;\n margin-bottom: 20px;\n line-height: 1.42857143;\n background-color: #fff;\n border: 1px solid #ddd;\n border-radius: 4px;\n -webkit-transition: border 0.2s ease-in-out;\n -o-transition: border 0.2s ease-in-out;\n transition: border 0.2s ease-in-out;\n}\n.thumbnail > img,\n.thumbnail a > img {\n margin-right: auto;\n margin-left: auto;\n}\na.thumbnail:hover,\na.thumbnail:focus,\na.thumbnail.active {\n border-color: #337ab7;\n}\n.thumbnail .caption {\n padding: 9px;\n color: #333333;\n}\n.alert {\n padding: 15px;\n margin-bottom: 20px;\n border: 1px solid transparent;\n border-radius: 4px;\n}\n.alert h4 {\n margin-top: 0;\n color: inherit;\n}\n.alert .alert-link {\n font-weight: bold;\n}\n.alert > p,\n.alert > ul {\n margin-bottom: 0;\n}\n.alert > p + p {\n margin-top: 5px;\n}\n.alert-dismissable,\n.alert-dismissible {\n padding-right: 35px;\n}\n.alert-dismissable .close,\n.alert-dismissible .close {\n position: relative;\n top: -2px;\n right: -21px;\n color: inherit;\n}\n.alert-success {\n color: #3c763d;\n background-color: #dff0d8;\n border-color: #d6e9c6;\n}\n.alert-success hr {\n border-top-color: #c9e2b3;\n}\n.alert-success .alert-link {\n color: #2b542c;\n}\n.alert-info {\n color: #31708f;\n background-color: #d9edf7;\n border-color: #bce8f1;\n}\n.alert-info hr {\n border-top-color: #a6e1ec;\n}\n.alert-info .alert-link {\n color: #245269;\n}\n.alert-warning {\n color: #8a6d3b;\n background-color: #fcf8e3;\n border-color: #faebcc;\n}\n.alert-warning hr {\n border-top-color: #f7e1b5;\n}\n.alert-warning .alert-link {\n color: #66512c;\n}\n.alert-danger {\n color: #a94442;\n background-color: #f2dede;\n border-color: #ebccd1;\n}\n.alert-danger hr {\n border-top-color: #e4b9c0;\n}\n.alert-danger .alert-link {\n color: #843534;\n}\n@-webkit-keyframes progress-bar-stripes {\n from {\n background-position: 40px 0;\n }\n to {\n background-position: 0 0;\n }\n}\n@keyframes progress-bar-stripes {\n from {\n background-position: 40px 0;\n }\n to {\n background-position: 0 0;\n }\n}\n.progress {\n height: 20px;\n margin-bottom: 20px;\n overflow: hidden;\n background-color: #f5f5f5;\n border-radius: 4px;\n -webkit-box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1);\n box-shadow: inset 0 1px 2px rgba(0, 0, 0, 0.1);\n}\n.progress-bar {\n float: left;\n width: 0%;\n height: 100%;\n font-size: 12px;\n line-height: 20px;\n color: #fff;\n text-align: center;\n background-color: #337ab7;\n -webkit-box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15);\n box-shadow: inset 0 -1px 0 rgba(0, 0, 0, 0.15);\n -webkit-transition: width 0.6s ease;\n -o-transition: width 0.6s ease;\n transition: width 0.6s ease;\n}\n.progress-striped .progress-bar,\n.progress-bar-striped {\n background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-size: 40px 40px;\n}\n.progress.active .progress-bar,\n.progress-bar.active {\n -webkit-animation: progress-bar-stripes 2s linear infinite;\n -o-animation: progress-bar-stripes 2s linear infinite;\n animation: progress-bar-stripes 2s linear infinite;\n}\n.progress-bar-success {\n background-color: #5cb85c;\n}\n.progress-striped .progress-bar-success {\n background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n}\n.progress-bar-info {\n background-color: #5bc0de;\n}\n.progress-striped .progress-bar-info {\n background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n}\n.progress-bar-warning {\n background-color: #f0ad4e;\n}\n.progress-striped .progress-bar-warning {\n background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n}\n.progress-bar-danger {\n background-color: #d9534f;\n}\n.progress-striped .progress-bar-danger {\n background-image: -webkit-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: -o-linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n background-image: linear-gradient(45deg, rgba(255, 255, 255, 0.15) 25%, transparent 25%, transparent 50%, rgba(255, 255, 255, 0.15) 50%, rgba(255, 255, 255, 0.15) 75%, transparent 75%, transparent);\n}\n.media {\n margin-top: 15px;\n}\n.media:first-child {\n margin-top: 0;\n}\n.media,\n.media-body {\n overflow: hidden;\n zoom: 1;\n}\n.media-body {\n width: 10000px;\n}\n.media-object {\n display: block;\n}\n.media-object.img-thumbnail {\n max-width: none;\n}\n.media-right,\n.media > .pull-right {\n padding-left: 10px;\n}\n.media-left,\n.media > .pull-left {\n padding-right: 10px;\n}\n.media-left,\n.media-right,\n.media-body {\n display: table-cell;\n vertical-align: top;\n}\n.media-middle {\n vertical-align: middle;\n}\n.media-bottom {\n vertical-align: bottom;\n}\n.media-heading {\n margin-top: 0;\n margin-bottom: 5px;\n}\n.media-list {\n padding-left: 0;\n list-style: none;\n}\n.list-group {\n padding-left: 0;\n margin-bottom: 20px;\n}\n.list-group-item {\n position: relative;\n display: block;\n padding: 10px 15px;\n margin-bottom: -1px;\n background-color: #fff;\n border: 1px solid #ddd;\n}\n.list-group-item:first-child {\n border-top-left-radius: 4px;\n border-top-right-radius: 4px;\n}\n.list-group-item:last-child {\n margin-bottom: 0;\n border-bottom-right-radius: 4px;\n border-bottom-left-radius: 4px;\n}\n.list-group-item.disabled,\n.list-group-item.disabled:hover,\n.list-group-item.disabled:focus {\n color: #777777;\n cursor: not-allowed;\n background-color: #eeeeee;\n}\n.list-group-item.disabled .list-group-item-heading,\n.list-group-item.disabled:hover .list-group-item-heading,\n.list-group-item.disabled:focus .list-group-item-heading {\n color: inherit;\n}\n.list-group-item.disabled .list-group-item-text,\n.list-group-item.disabled:hover .list-group-item-text,\n.list-group-item.disabled:focus .list-group-item-text {\n color: #777777;\n}\n.list-group-item.active,\n.list-group-item.active:hover,\n.list-group-item.active:focus {\n z-index: 2;\n color: #fff;\n background-color: #337ab7;\n border-color: #337ab7;\n}\n.list-group-item.active .list-group-item-heading,\n.list-group-item.active:hover .list-group-item-heading,\n.list-group-item.active:focus .list-group-item-heading,\n.list-group-item.active .list-group-item-heading > small,\n.list-group-item.active:hover .list-group-item-heading > small,\n.list-group-item.active:focus .list-group-item-heading > small,\n.list-group-item.active .list-group-item-heading > .small,\n.list-group-item.active:hover .list-group-item-heading > .small,\n.list-group-item.active:focus .list-group-item-heading > .small {\n color: inherit;\n}\n.list-group-item.active .list-group-item-text,\n.list-group-item.active:hover .list-group-item-text,\n.list-group-item.active:focus .list-group-item-text {\n color: #c7ddef;\n}\na.list-group-item,\nbutton.list-group-item {\n color: #555;\n}\na.list-group-item .list-group-item-heading,\nbutton.list-group-item .list-group-item-heading {\n color: #333;\n}\na.list-group-item:hover,\nbutton.list-group-item:hover,\na.list-group-item:focus,\nbutton.list-group-item:focus {\n color: #555;\n text-decoration: none;\n background-color: #f5f5f5;\n}\nbutton.list-group-item {\n width: 100%;\n text-align: left;\n}\n.list-group-item-success {\n color: #3c763d;\n background-color: #dff0d8;\n}\na.list-group-item-success,\nbutton.list-group-item-success {\n color: #3c763d;\n}\na.list-group-item-success .list-group-item-heading,\nbutton.list-group-item-success .list-group-item-heading {\n color: inherit;\n}\na.list-group-item-success:hover,\nbutton.list-group-item-success:hover,\na.list-group-item-success:focus,\nbutton.list-group-item-success:focus {\n color: #3c763d;\n background-color: #d0e9c6;\n}\na.list-group-item-success.active,\nbutton.list-group-item-success.active,\na.list-group-item-success.active:hover,\nbutton.list-group-item-success.active:hover,\na.list-group-item-success.active:focus,\nbutton.list-group-item-success.active:focus {\n color: #fff;\n background-color: #3c763d;\n border-color: #3c763d;\n}\n.list-group-item-info {\n color: #31708f;\n background-color: #d9edf7;\n}\na.list-group-item-info,\nbutton.list-group-item-info {\n color: #31708f;\n}\na.list-group-item-info .list-group-item-heading,\nbutton.list-group-item-info .list-group-item-heading {\n color: inherit;\n}\na.list-group-item-info:hover,\nbutton.list-group-item-info:hover,\na.list-group-item-info:focus,\nbutton.list-group-item-info:focus {\n color: #31708f;\n background-color: #c4e3f3;\n}\na.list-group-item-info.active,\nbutton.list-group-item-info.active,\na.list-group-item-info.active:hover,\nbutton.list-group-item-info.active:hover,\na.list-group-item-info.active:focus,\nbutton.list-group-item-info.active:focus {\n color: #fff;\n background-color: #31708f;\n border-color: #31708f;\n}\n.list-group-item-warning {\n color: #8a6d3b;\n background-color: #fcf8e3;\n}\na.list-group-item-warning,\nbutton.list-group-item-warning {\n color: #8a6d3b;\n}\na.list-group-item-warning .list-group-item-heading,\nbutton.list-group-item-warning .list-group-item-heading {\n color: inherit;\n}\na.list-group-item-warning:hover,\nbutton.list-group-item-warning:hover,\na.list-group-item-warning:focus,\nbutton.list-group-item-warning:focus {\n color: #8a6d3b;\n background-color: #faf2cc;\n}\na.list-group-item-warning.active,\nbutton.list-group-item-warning.active,\na.list-group-item-warning.active:hover,\nbutton.list-group-item-warning.active:hover,\na.list-group-item-warning.active:focus,\nbutton.list-group-item-warning.active:focus {\n color: #fff;\n background-color: #8a6d3b;\n border-color: #8a6d3b;\n}\n.list-group-item-danger {\n color: #a94442;\n background-color: #f2dede;\n}\na.list-group-item-danger,\nbutton.list-group-item-danger {\n color: #a94442;\n}\na.list-group-item-danger .list-group-item-heading,\nbutton.list-group-item-danger .list-group-item-heading {\n color: inherit;\n}\na.list-group-item-danger:hover,\nbutton.list-group-item-danger:hover,\na.list-group-item-danger:focus,\nbutton.list-group-item-danger:focus {\n color: #a94442;\n background-color: #ebcccc;\n}\na.list-group-item-danger.active,\nbutton.list-group-item-danger.active,\na.list-group-item-danger.active:hover,\nbutton.list-group-item-danger.active:hover,\na.list-group-item-danger.active:focus,\nbutton.list-group-item-danger.active:focus {\n color: #fff;\n background-color: #a94442;\n border-color: #a94442;\n}\n.list-group-item-heading {\n margin-top: 0;\n margin-bottom: 5px;\n}\n.list-group-item-text {\n margin-bottom: 0;\n line-height: 1.3;\n}\n.panel {\n margin-bottom: 20px;\n background-color: #fff;\n border: 1px solid transparent;\n border-radius: 4px;\n -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);\n box-shadow: 0 1px 1px rgba(0, 0, 0, 0.05);\n}\n.panel-body {\n padding: 15px;\n}\n.panel-heading {\n padding: 10px 15px;\n border-bottom: 1px solid transparent;\n border-top-left-radius: 3px;\n border-top-right-radius: 3px;\n}\n.panel-heading > .dropdown .dropdown-toggle {\n color: inherit;\n}\n.panel-title {\n margin-top: 0;\n margin-bottom: 0;\n font-size: 16px;\n color: inherit;\n}\n.panel-title > a,\n.panel-title > small,\n.panel-title > .small,\n.panel-title > small > a,\n.panel-title > .small > a {\n color: inherit;\n}\n.panel-footer {\n padding: 10px 15px;\n background-color: #f5f5f5;\n border-top: 1px solid #ddd;\n border-bottom-right-radius: 3px;\n border-bottom-left-radius: 3px;\n}\n.panel > .list-group,\n.panel > .panel-collapse > .list-group {\n margin-bottom: 0;\n}\n.panel > .list-group .list-group-item,\n.panel > .panel-collapse > .list-group .list-group-item {\n border-width: 1px 0;\n border-radius: 0;\n}\n.panel > .list-group:first-child .list-group-item:first-child,\n.panel > .panel-collapse > .list-group:first-child .list-group-item:first-child {\n border-top: 0;\n border-top-left-radius: 3px;\n border-top-right-radius: 3px;\n}\n.panel > .list-group:last-child .list-group-item:last-child,\n.panel > .panel-collapse > .list-group:last-child .list-group-item:last-child {\n border-bottom: 0;\n border-bottom-right-radius: 3px;\n border-bottom-left-radius: 3px;\n}\n.panel > .panel-heading + .panel-collapse > .list-group .list-group-item:first-child {\n border-top-left-radius: 0;\n border-top-right-radius: 0;\n}\n.panel-heading + .list-group .list-group-item:first-child {\n border-top-width: 0;\n}\n.list-group + .panel-footer {\n border-top-width: 0;\n}\n.panel > .table,\n.panel > .table-responsive > .table,\n.panel > .panel-collapse > .table {\n margin-bottom: 0;\n}\n.panel > .table caption,\n.panel > .table-responsive > .table caption,\n.panel > .panel-collapse > .table caption {\n padding-right: 15px;\n padding-left: 15px;\n}\n.panel > .table:first-child,\n.panel > .table-responsive:first-child > .table:first-child {\n border-top-left-radius: 3px;\n border-top-right-radius: 3px;\n}\n.panel > .table:first-child > thead:first-child > tr:first-child,\n.panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child,\n.panel > .table:first-child > tbody:first-child > tr:first-child,\n.panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child {\n border-top-left-radius: 3px;\n border-top-right-radius: 3px;\n}\n.panel > .table:first-child > thead:first-child > tr:first-child td:first-child,\n.panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child td:first-child,\n.panel > .table:first-child > tbody:first-child > tr:first-child td:first-child,\n.panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child td:first-child,\n.panel > .table:first-child > thead:first-child > tr:first-child th:first-child,\n.panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child th:first-child,\n.panel > .table:first-child > tbody:first-child > tr:first-child th:first-child,\n.panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child th:first-child {\n border-top-left-radius: 3px;\n}\n.panel > .table:first-child > thead:first-child > tr:first-child td:last-child,\n.panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child td:last-child,\n.panel > .table:first-child > tbody:first-child > tr:first-child td:last-child,\n.panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child td:last-child,\n.panel > .table:first-child > thead:first-child > tr:first-child th:last-child,\n.panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child th:last-child,\n.panel > .table:first-child > tbody:first-child > tr:first-child th:last-child,\n.panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child th:last-child {\n border-top-right-radius: 3px;\n}\n.panel > .table:last-child,\n.panel > .table-responsive:last-child > .table:last-child {\n border-bottom-right-radius: 3px;\n border-bottom-left-radius: 3px;\n}\n.panel > .table:last-child > tbody:last-child > tr:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child,\n.panel > .table:last-child > tfoot:last-child > tr:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child {\n border-bottom-right-radius: 3px;\n border-bottom-left-radius: 3px;\n}\n.panel > .table:last-child > tbody:last-child > tr:last-child td:first-child,\n.panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child td:first-child,\n.panel > .table:last-child > tfoot:last-child > tr:last-child td:first-child,\n.panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child td:first-child,\n.panel > .table:last-child > tbody:last-child > tr:last-child th:first-child,\n.panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child th:first-child,\n.panel > .table:last-child > tfoot:last-child > tr:last-child th:first-child,\n.panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child th:first-child {\n border-bottom-left-radius: 3px;\n}\n.panel > .table:last-child > tbody:last-child > tr:last-child td:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child td:last-child,\n.panel > .table:last-child > tfoot:last-child > tr:last-child td:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child td:last-child,\n.panel > .table:last-child > tbody:last-child > tr:last-child th:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child th:last-child,\n.panel > .table:last-child > tfoot:last-child > tr:last-child th:last-child,\n.panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child th:last-child {\n border-bottom-right-radius: 3px;\n}\n.panel > .panel-body + .table,\n.panel > .panel-body + .table-responsive,\n.panel > .table + .panel-body,\n.panel > .table-responsive + .panel-body {\n border-top: 1px solid #ddd;\n}\n.panel > .table > tbody:first-child > tr:first-child th,\n.panel > .table > tbody:first-child > tr:first-child td {\n border-top: 0;\n}\n.panel > .table-bordered,\n.panel > .table-responsive > .table-bordered {\n border: 0;\n}\n.panel > .table-bordered > thead > tr > th:first-child,\n.panel > .table-responsive > .table-bordered > thead > tr > th:first-child,\n.panel > .table-bordered > tbody > tr > th:first-child,\n.panel > .table-responsive > .table-bordered > tbody > tr > th:first-child,\n.panel > .table-bordered > tfoot > tr > th:first-child,\n.panel > .table-responsive > .table-bordered > tfoot > tr > th:first-child,\n.panel > .table-bordered > thead > tr > td:first-child,\n.panel > .table-responsive > .table-bordered > thead > tr > td:first-child,\n.panel > .table-bordered > tbody > tr > td:first-child,\n.panel > .table-responsive > .table-bordered > tbody > tr > td:first-child,\n.panel > .table-bordered > tfoot > tr > td:first-child,\n.panel > .table-responsive > .table-bordered > tfoot > tr > td:first-child {\n border-left: 0;\n}\n.panel > .table-bordered > thead > tr > th:last-child,\n.panel > .table-responsive > .table-bordered > thead > tr > th:last-child,\n.panel > .table-bordered > tbody > tr > th:last-child,\n.panel > .table-responsive > .table-bordered > tbody > tr > th:last-child,\n.panel > .table-bordered > tfoot > tr > th:last-child,\n.panel > .table-responsive > .table-bordered > tfoot > tr > th:last-child,\n.panel > .table-bordered > thead > tr > td:last-child,\n.panel > .table-responsive > .table-bordered > thead > tr > td:last-child,\n.panel > .table-bordered > tbody > tr > td:last-child,\n.panel > .table-responsive > .table-bordered > tbody > tr > td:last-child,\n.panel > .table-bordered > tfoot > tr > td:last-child,\n.panel > .table-responsive > .table-bordered > tfoot > tr > td:last-child {\n border-right: 0;\n}\n.panel > .table-bordered > thead > tr:first-child > td,\n.panel > .table-responsive > .table-bordered > thead > tr:first-child > td,\n.panel > .table-bordered > tbody > tr:first-child > td,\n.panel > .table-responsive > .table-bordered > tbody > tr:first-child > td,\n.panel > .table-bordered > thead > tr:first-child > th,\n.panel > .table-responsive > .table-bordered > thead > tr:first-child > th,\n.panel > .table-bordered > tbody > tr:first-child > th,\n.panel > .table-responsive > .table-bordered > tbody > tr:first-child > th {\n border-bottom: 0;\n}\n.panel > .table-bordered > tbody > tr:last-child > td,\n.panel > .table-responsive > .table-bordered > tbody > tr:last-child > td,\n.panel > .table-bordered > tfoot > tr:last-child > td,\n.panel > .table-responsive > .table-bordered > tfoot > tr:last-child > td,\n.panel > .table-bordered > tbody > tr:last-child > th,\n.panel > .table-responsive > .table-bordered > tbody > tr:last-child > th,\n.panel > .table-bordered > tfoot > tr:last-child > th,\n.panel > .table-responsive > .table-bordered > tfoot > tr:last-child > th {\n border-bottom: 0;\n}\n.panel > .table-responsive {\n margin-bottom: 0;\n border: 0;\n}\n.panel-group {\n margin-bottom: 20px;\n}\n.panel-group .panel {\n margin-bottom: 0;\n border-radius: 4px;\n}\n.panel-group .panel + .panel {\n margin-top: 5px;\n}\n.panel-group .panel-heading {\n border-bottom: 0;\n}\n.panel-group .panel-heading + .panel-collapse > .panel-body,\n.panel-group .panel-heading + .panel-collapse > .list-group {\n border-top: 1px solid #ddd;\n}\n.panel-group .panel-footer {\n border-top: 0;\n}\n.panel-group .panel-footer + .panel-collapse .panel-body {\n border-bottom: 1px solid #ddd;\n}\n.panel-default {\n border-color: #ddd;\n}\n.panel-default > .panel-heading {\n color: #333333;\n background-color: #f5f5f5;\n border-color: #ddd;\n}\n.panel-default > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #ddd;\n}\n.panel-default > .panel-heading .badge {\n color: #f5f5f5;\n background-color: #333333;\n}\n.panel-default > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #ddd;\n}\n.panel-primary {\n border-color: #337ab7;\n}\n.panel-primary > .panel-heading {\n color: #fff;\n background-color: #337ab7;\n border-color: #337ab7;\n}\n.panel-primary > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #337ab7;\n}\n.panel-primary > .panel-heading .badge {\n color: #337ab7;\n background-color: #fff;\n}\n.panel-primary > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #337ab7;\n}\n.panel-success {\n border-color: #d6e9c6;\n}\n.panel-success > .panel-heading {\n color: #3c763d;\n background-color: #dff0d8;\n border-color: #d6e9c6;\n}\n.panel-success > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #d6e9c6;\n}\n.panel-success > .panel-heading .badge {\n color: #dff0d8;\n background-color: #3c763d;\n}\n.panel-success > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #d6e9c6;\n}\n.panel-info {\n border-color: #bce8f1;\n}\n.panel-info > .panel-heading {\n color: #31708f;\n background-color: #d9edf7;\n border-color: #bce8f1;\n}\n.panel-info > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #bce8f1;\n}\n.panel-info > .panel-heading .badge {\n color: #d9edf7;\n background-color: #31708f;\n}\n.panel-info > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #bce8f1;\n}\n.panel-warning {\n border-color: #faebcc;\n}\n.panel-warning > .panel-heading {\n color: #8a6d3b;\n background-color: #fcf8e3;\n border-color: #faebcc;\n}\n.panel-warning > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #faebcc;\n}\n.panel-warning > .panel-heading .badge {\n color: #fcf8e3;\n background-color: #8a6d3b;\n}\n.panel-warning > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #faebcc;\n}\n.panel-danger {\n border-color: #ebccd1;\n}\n.panel-danger > .panel-heading {\n color: #a94442;\n background-color: #f2dede;\n border-color: #ebccd1;\n}\n.panel-danger > .panel-heading + .panel-collapse > .panel-body {\n border-top-color: #ebccd1;\n}\n.panel-danger > .panel-heading .badge {\n color: #f2dede;\n background-color: #a94442;\n}\n.panel-danger > .panel-footer + .panel-collapse > .panel-body {\n border-bottom-color: #ebccd1;\n}\n.embed-responsive {\n position: relative;\n display: block;\n height: 0;\n padding: 0;\n overflow: hidden;\n}\n.embed-responsive .embed-responsive-item,\n.embed-responsive iframe,\n.embed-responsive embed,\n.embed-responsive object,\n.embed-responsive video {\n position: absolute;\n top: 0;\n bottom: 0;\n left: 0;\n width: 100%;\n height: 100%;\n border: 0;\n}\n.embed-responsive-16by9 {\n padding-bottom: 56.25%;\n}\n.embed-responsive-4by3 {\n padding-bottom: 75%;\n}\n.well {\n min-height: 20px;\n padding: 19px;\n margin-bottom: 20px;\n background-color: #f5f5f5;\n border: 1px solid #e3e3e3;\n border-radius: 4px;\n -webkit-box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);\n box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.05);\n}\n.well blockquote {\n border-color: #ddd;\n border-color: rgba(0, 0, 0, 0.15);\n}\n.well-lg {\n padding: 24px;\n border-radius: 6px;\n}\n.well-sm {\n padding: 9px;\n border-radius: 3px;\n}\n.close {\n float: right;\n font-size: 21px;\n font-weight: bold;\n line-height: 1;\n color: #000;\n text-shadow: 0 1px 0 #fff;\n filter: alpha(opacity=20);\n opacity: 0.2;\n}\n.close:hover,\n.close:focus {\n color: #000;\n text-decoration: none;\n cursor: pointer;\n filter: alpha(opacity=50);\n opacity: 0.5;\n}\nbutton.close {\n padding: 0;\n cursor: pointer;\n background: transparent;\n border: 0;\n -webkit-appearance: none;\n appearance: none;\n}\n.modal-open {\n overflow: hidden;\n}\n.modal {\n position: fixed;\n top: 0;\n right: 0;\n bottom: 0;\n left: 0;\n z-index: 1050;\n display: none;\n overflow: hidden;\n -webkit-overflow-scrolling: touch;\n outline: 0;\n}\n.modal.fade .modal-dialog {\n -webkit-transform: translate(0, -25%);\n -ms-transform: translate(0, -25%);\n -o-transform: translate(0, -25%);\n transform: translate(0, -25%);\n -webkit-transition: -webkit-transform 0.3s ease-out;\n -moz-transition: -moz-transform 0.3s ease-out;\n -o-transition: -o-transform 0.3s ease-out;\n transition: transform 0.3s ease-out;\n}\n.modal.in .modal-dialog {\n -webkit-transform: translate(0, 0);\n -ms-transform: translate(0, 0);\n -o-transform: translate(0, 0);\n transform: translate(0, 0);\n}\n.modal-open .modal {\n overflow-x: hidden;\n overflow-y: auto;\n}\n.modal-dialog {\n position: relative;\n width: auto;\n margin: 10px;\n}\n.modal-content {\n position: relative;\n background-color: #fff;\n background-clip: padding-box;\n border: 1px solid #999;\n border: 1px solid rgba(0, 0, 0, 0.2);\n border-radius: 6px;\n -webkit-box-shadow: 0 3px 9px rgba(0, 0, 0, 0.5);\n box-shadow: 0 3px 9px rgba(0, 0, 0, 0.5);\n outline: 0;\n}\n.modal-backdrop {\n position: fixed;\n top: 0;\n right: 0;\n bottom: 0;\n left: 0;\n z-index: 1040;\n background-color: #000;\n}\n.modal-backdrop.fade {\n filter: alpha(opacity=0);\n opacity: 0;\n}\n.modal-backdrop.in {\n filter: alpha(opacity=50);\n opacity: 0.5;\n}\n.modal-header {\n padding: 15px;\n border-bottom: 1px solid #e5e5e5;\n}\n.modal-header .close {\n margin-top: -2px;\n}\n.modal-title {\n margin: 0;\n line-height: 1.42857143;\n}\n.modal-body {\n position: relative;\n padding: 15px;\n}\n.modal-footer {\n padding: 15px;\n text-align: right;\n border-top: 1px solid #e5e5e5;\n}\n.modal-footer .btn + .btn {\n margin-bottom: 0;\n margin-left: 5px;\n}\n.modal-footer .btn-group .btn + .btn {\n margin-left: -1px;\n}\n.modal-footer .btn-block + .btn-block {\n margin-left: 0;\n}\n.modal-scrollbar-measure {\n position: absolute;\n top: -9999px;\n width: 50px;\n height: 50px;\n overflow: scroll;\n}\n@media (min-width: 768px) {\n .modal-dialog {\n width: 600px;\n margin: 30px auto;\n }\n .modal-content {\n -webkit-box-shadow: 0 5px 15px rgba(0, 0, 0, 0.5);\n box-shadow: 0 5px 15px rgba(0, 0, 0, 0.5);\n }\n .modal-sm {\n width: 300px;\n }\n}\n@media (min-width: 992px) {\n .modal-lg {\n width: 900px;\n }\n}\n.tooltip {\n position: absolute;\n z-index: 1070;\n display: block;\n font-family: \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n font-style: normal;\n font-weight: 400;\n line-height: 1.42857143;\n line-break: auto;\n text-align: left;\n text-align: start;\n text-decoration: none;\n text-shadow: none;\n text-transform: none;\n letter-spacing: normal;\n word-break: normal;\n word-spacing: normal;\n word-wrap: normal;\n white-space: normal;\n font-size: 12px;\n filter: alpha(opacity=0);\n opacity: 0;\n}\n.tooltip.in {\n filter: alpha(opacity=90);\n opacity: 0.9;\n}\n.tooltip.top {\n padding: 5px 0;\n margin-top: -3px;\n}\n.tooltip.right {\n padding: 0 5px;\n margin-left: 3px;\n}\n.tooltip.bottom {\n padding: 5px 0;\n margin-top: 3px;\n}\n.tooltip.left {\n padding: 0 5px;\n margin-left: -3px;\n}\n.tooltip.top .tooltip-arrow {\n bottom: 0;\n left: 50%;\n margin-left: -5px;\n border-width: 5px 5px 0;\n border-top-color: #000;\n}\n.tooltip.top-left .tooltip-arrow {\n right: 5px;\n bottom: 0;\n margin-bottom: -5px;\n border-width: 5px 5px 0;\n border-top-color: #000;\n}\n.tooltip.top-right .tooltip-arrow {\n bottom: 0;\n left: 5px;\n margin-bottom: -5px;\n border-width: 5px 5px 0;\n border-top-color: #000;\n}\n.tooltip.right .tooltip-arrow {\n top: 50%;\n left: 0;\n margin-top: -5px;\n border-width: 5px 5px 5px 0;\n border-right-color: #000;\n}\n.tooltip.left .tooltip-arrow {\n top: 50%;\n right: 0;\n margin-top: -5px;\n border-width: 5px 0 5px 5px;\n border-left-color: #000;\n}\n.tooltip.bottom .tooltip-arrow {\n top: 0;\n left: 50%;\n margin-left: -5px;\n border-width: 0 5px 5px;\n border-bottom-color: #000;\n}\n.tooltip.bottom-left .tooltip-arrow {\n top: 0;\n right: 5px;\n margin-top: -5px;\n border-width: 0 5px 5px;\n border-bottom-color: #000;\n}\n.tooltip.bottom-right .tooltip-arrow {\n top: 0;\n left: 5px;\n margin-top: -5px;\n border-width: 0 5px 5px;\n border-bottom-color: #000;\n}\n.tooltip-inner {\n max-width: 200px;\n padding: 3px 8px;\n color: #fff;\n text-align: center;\n background-color: #000;\n border-radius: 4px;\n}\n.tooltip-arrow {\n position: absolute;\n width: 0;\n height: 0;\n border-color: transparent;\n border-style: solid;\n}\n.popover {\n position: absolute;\n top: 0;\n left: 0;\n z-index: 1060;\n display: none;\n max-width: 276px;\n padding: 1px;\n font-family: \"Helvetica Neue\", Helvetica, Arial, sans-serif;\n font-style: normal;\n font-weight: 400;\n line-height: 1.42857143;\n line-break: auto;\n text-align: left;\n text-align: start;\n text-decoration: none;\n text-shadow: none;\n text-transform: none;\n letter-spacing: normal;\n word-break: normal;\n word-spacing: normal;\n word-wrap: normal;\n white-space: normal;\n font-size: 14px;\n background-color: #fff;\n background-clip: padding-box;\n border: 1px solid #ccc;\n border: 1px solid rgba(0, 0, 0, 0.2);\n border-radius: 6px;\n -webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);\n box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);\n}\n.popover.top {\n margin-top: -10px;\n}\n.popover.right {\n margin-left: 10px;\n}\n.popover.bottom {\n margin-top: 10px;\n}\n.popover.left {\n margin-left: -10px;\n}\n.popover > .arrow {\n border-width: 11px;\n}\n.popover > .arrow,\n.popover > .arrow:after {\n position: absolute;\n display: block;\n width: 0;\n height: 0;\n border-color: transparent;\n border-style: solid;\n}\n.popover > .arrow:after {\n content: \"\";\n border-width: 10px;\n}\n.popover.top > .arrow {\n bottom: -11px;\n left: 50%;\n margin-left: -11px;\n border-top-color: #999999;\n border-top-color: rgba(0, 0, 0, 0.25);\n border-bottom-width: 0;\n}\n.popover.top > .arrow:after {\n bottom: 1px;\n margin-left: -10px;\n content: \" \";\n border-top-color: #fff;\n border-bottom-width: 0;\n}\n.popover.right > .arrow {\n top: 50%;\n left: -11px;\n margin-top: -11px;\n border-right-color: #999999;\n border-right-color: rgba(0, 0, 0, 0.25);\n border-left-width: 0;\n}\n.popover.right > .arrow:after {\n bottom: -10px;\n left: 1px;\n content: \" \";\n border-right-color: #fff;\n border-left-width: 0;\n}\n.popover.bottom > .arrow {\n top: -11px;\n left: 50%;\n margin-left: -11px;\n border-top-width: 0;\n border-bottom-color: #999999;\n border-bottom-color: rgba(0, 0, 0, 0.25);\n}\n.popover.bottom > .arrow:after {\n top: 1px;\n margin-left: -10px;\n content: \" \";\n border-top-width: 0;\n border-bottom-color: #fff;\n}\n.popover.left > .arrow {\n top: 50%;\n right: -11px;\n margin-top: -11px;\n border-right-width: 0;\n border-left-color: #999999;\n border-left-color: rgba(0, 0, 0, 0.25);\n}\n.popover.left > .arrow:after {\n right: 1px;\n bottom: -10px;\n content: \" \";\n border-right-width: 0;\n border-left-color: #fff;\n}\n.popover-title {\n padding: 8px 14px;\n margin: 0;\n font-size: 14px;\n background-color: #f7f7f7;\n border-bottom: 1px solid #ebebeb;\n border-radius: 5px 5px 0 0;\n}\n.popover-content {\n padding: 9px 14px;\n}\n.carousel {\n position: relative;\n}\n.carousel-inner {\n position: relative;\n width: 100%;\n overflow: hidden;\n}\n.carousel-inner > .item {\n position: relative;\n display: none;\n -webkit-transition: 0.6s ease-in-out left;\n -o-transition: 0.6s ease-in-out left;\n transition: 0.6s ease-in-out left;\n}\n.carousel-inner > .item > img,\n.carousel-inner > .item > a > img {\n line-height: 1;\n}\n@media all and (transform-3d), (-webkit-transform-3d) {\n .carousel-inner > .item {\n -webkit-transition: -webkit-transform 0.6s ease-in-out;\n -moz-transition: -moz-transform 0.6s ease-in-out;\n -o-transition: -o-transform 0.6s ease-in-out;\n transition: transform 0.6s ease-in-out;\n -webkit-backface-visibility: hidden;\n -moz-backface-visibility: hidden;\n backface-visibility: hidden;\n -webkit-perspective: 1000px;\n -moz-perspective: 1000px;\n perspective: 1000px;\n }\n .carousel-inner > .item.next,\n .carousel-inner > .item.active.right {\n -webkit-transform: translate3d(100%, 0, 0);\n transform: translate3d(100%, 0, 0);\n left: 0;\n }\n .carousel-inner > .item.prev,\n .carousel-inner > .item.active.left {\n -webkit-transform: translate3d(-100%, 0, 0);\n transform: translate3d(-100%, 0, 0);\n left: 0;\n }\n .carousel-inner > .item.next.left,\n .carousel-inner > .item.prev.right,\n .carousel-inner > .item.active {\n -webkit-transform: translate3d(0, 0, 0);\n transform: translate3d(0, 0, 0);\n left: 0;\n }\n}\n.carousel-inner > .active,\n.carousel-inner > .next,\n.carousel-inner > .prev {\n display: block;\n}\n.carousel-inner > .active {\n left: 0;\n}\n.carousel-inner > .next,\n.carousel-inner > .prev {\n position: absolute;\n top: 0;\n width: 100%;\n}\n.carousel-inner > .next {\n left: 100%;\n}\n.carousel-inner > .prev {\n left: -100%;\n}\n.carousel-inner > .next.left,\n.carousel-inner > .prev.right {\n left: 0;\n}\n.carousel-inner > .active.left {\n left: -100%;\n}\n.carousel-inner > .active.right {\n left: 100%;\n}\n.carousel-control {\n position: absolute;\n top: 0;\n bottom: 0;\n left: 0;\n width: 15%;\n font-size: 20px;\n color: #fff;\n text-align: center;\n text-shadow: 0 1px 2px rgba(0, 0, 0, 0.6);\n background-color: rgba(0, 0, 0, 0);\n filter: alpha(opacity=50);\n opacity: 0.5;\n}\n.carousel-control.left {\n background-image: -webkit-linear-gradient(left, rgba(0, 0, 0, 0.5) 0%, rgba(0, 0, 0, 0.0001) 100%);\n background-image: -o-linear-gradient(left, rgba(0, 0, 0, 0.5) 0%, rgba(0, 0, 0, 0.0001) 100%);\n background-image: linear-gradient(to right, rgba(0, 0, 0, 0.5) 0%, rgba(0, 0, 0, 0.0001) 100%);\n filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#80000000', endColorstr='#00000000', GradientType=1);\n background-repeat: repeat-x;\n}\n.carousel-control.right {\n right: 0;\n left: auto;\n background-image: -webkit-linear-gradient(left, rgba(0, 0, 0, 0.0001) 0%, rgba(0, 0, 0, 0.5) 100%);\n background-image: -o-linear-gradient(left, rgba(0, 0, 0, 0.0001) 0%, rgba(0, 0, 0, 0.5) 100%);\n background-image: linear-gradient(to right, rgba(0, 0, 0, 0.0001) 0%, rgba(0, 0, 0, 0.5) 100%);\n filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#00000000', endColorstr='#80000000', GradientType=1);\n background-repeat: repeat-x;\n}\n.carousel-control:hover,\n.carousel-control:focus {\n color: #fff;\n text-decoration: none;\n outline: 0;\n filter: alpha(opacity=90);\n opacity: 0.9;\n}\n.carousel-control .icon-prev,\n.carousel-control .icon-next,\n.carousel-control .glyphicon-chevron-left,\n.carousel-control .glyphicon-chevron-right {\n position: absolute;\n top: 50%;\n z-index: 5;\n display: inline-block;\n margin-top: -10px;\n}\n.carousel-control .icon-prev,\n.carousel-control .glyphicon-chevron-left {\n left: 50%;\n margin-left: -10px;\n}\n.carousel-control .icon-next,\n.carousel-control .glyphicon-chevron-right {\n right: 50%;\n margin-right: -10px;\n}\n.carousel-control .icon-prev,\n.carousel-control .icon-next {\n width: 20px;\n height: 20px;\n font-family: serif;\n line-height: 1;\n}\n.carousel-control .icon-prev:before {\n content: \"\\2039\";\n}\n.carousel-control .icon-next:before {\n content: \"\\203a\";\n}\n.carousel-indicators {\n position: absolute;\n bottom: 10px;\n left: 50%;\n z-index: 15;\n width: 60%;\n padding-left: 0;\n margin-left: -30%;\n text-align: center;\n list-style: none;\n}\n.carousel-indicators li {\n display: inline-block;\n width: 10px;\n height: 10px;\n margin: 1px;\n text-indent: -999px;\n cursor: pointer;\n background-color: #000 \\9;\n background-color: rgba(0, 0, 0, 0);\n border: 1px solid #fff;\n border-radius: 10px;\n}\n.carousel-indicators .active {\n width: 12px;\n height: 12px;\n margin: 0;\n background-color: #fff;\n}\n.carousel-caption {\n position: absolute;\n right: 15%;\n bottom: 20px;\n left: 15%;\n z-index: 10;\n padding-top: 20px;\n padding-bottom: 20px;\n color: #fff;\n text-align: center;\n text-shadow: 0 1px 2px rgba(0, 0, 0, 0.6);\n}\n.carousel-caption .btn {\n text-shadow: none;\n}\n@media screen and (min-width: 768px) {\n .carousel-control .glyphicon-chevron-left,\n .carousel-control .glyphicon-chevron-right,\n .carousel-control .icon-prev,\n .carousel-control .icon-next {\n width: 30px;\n height: 30px;\n margin-top: -10px;\n font-size: 30px;\n }\n .carousel-control .glyphicon-chevron-left,\n .carousel-control .icon-prev {\n margin-left: -10px;\n }\n .carousel-control .glyphicon-chevron-right,\n .carousel-control .icon-next {\n margin-right: -10px;\n }\n .carousel-caption {\n right: 20%;\n left: 20%;\n padding-bottom: 30px;\n }\n .carousel-indicators {\n bottom: 20px;\n }\n}\n.clearfix:before,\n.clearfix:after,\n.dl-horizontal dd:before,\n.dl-horizontal dd:after,\n.container:before,\n.container:after,\n.container-fluid:before,\n.container-fluid:after,\n.row:before,\n.row:after,\n.form-horizontal .form-group:before,\n.form-horizontal .form-group:after,\n.btn-toolbar:before,\n.btn-toolbar:after,\n.btn-group-vertical > .btn-group:before,\n.btn-group-vertical > .btn-group:after,\n.nav:before,\n.nav:after,\n.navbar:before,\n.navbar:after,\n.navbar-header:before,\n.navbar-header:after,\n.navbar-collapse:before,\n.navbar-collapse:after,\n.pager:before,\n.pager:after,\n.panel-body:before,\n.panel-body:after,\n.modal-header:before,\n.modal-header:after,\n.modal-footer:before,\n.modal-footer:after {\n display: table;\n content: \" \";\n}\n.clearfix:after,\n.dl-horizontal dd:after,\n.container:after,\n.container-fluid:after,\n.row:after,\n.form-horizontal .form-group:after,\n.btn-toolbar:after,\n.btn-group-vertical > .btn-group:after,\n.nav:after,\n.navbar:after,\n.navbar-header:after,\n.navbar-collapse:after,\n.pager:after,\n.panel-body:after,\n.modal-header:after,\n.modal-footer:after {\n clear: both;\n}\n.center-block {\n display: block;\n margin-right: auto;\n margin-left: auto;\n}\n.pull-right {\n float: right !important;\n}\n.pull-left {\n float: left !important;\n}\n.hide {\n display: none !important;\n}\n.show {\n display: block !important;\n}\n.invisible {\n visibility: hidden;\n}\n.text-hide {\n font: 0/0 a;\n color: transparent;\n text-shadow: none;\n background-color: transparent;\n border: 0;\n}\n.hidden {\n display: none !important;\n}\n.affix {\n position: fixed;\n}\n@-ms-viewport {\n width: device-width;\n}\n.visible-xs,\n.visible-sm,\n.visible-md,\n.visible-lg {\n display: none !important;\n}\n.visible-xs-block,\n.visible-xs-inline,\n.visible-xs-inline-block,\n.visible-sm-block,\n.visible-sm-inline,\n.visible-sm-inline-block,\n.visible-md-block,\n.visible-md-inline,\n.visible-md-inline-block,\n.visible-lg-block,\n.visible-lg-inline,\n.visible-lg-inline-block {\n display: none !important;\n}\n@media (max-width: 767px) {\n .visible-xs {\n display: block !important;\n }\n table.visible-xs {\n display: table !important;\n }\n tr.visible-xs {\n display: table-row !important;\n }\n th.visible-xs,\n td.visible-xs {\n display: table-cell !important;\n }\n}\n@media (max-width: 767px) {\n .visible-xs-block {\n display: block !important;\n }\n}\n@media (max-width: 767px) {\n .visible-xs-inline {\n display: inline !important;\n }\n}\n@media (max-width: 767px) {\n .visible-xs-inline-block {\n display: inline-block !important;\n }\n}\n@media (min-width: 768px) and (max-width: 991px) {\n .visible-sm {\n display: block !important;\n }\n table.visible-sm {\n display: table !important;\n }\n tr.visible-sm {\n display: table-row !important;\n }\n th.visible-sm,\n td.visible-sm {\n display: table-cell !important;\n }\n}\n@media (min-width: 768px) and (max-width: 991px) {\n .visible-sm-block {\n display: block !important;\n }\n}\n@media (min-width: 768px) and (max-width: 991px) {\n .visible-sm-inline {\n display: inline !important;\n }\n}\n@media (min-width: 768px) and (max-width: 991px) {\n .visible-sm-inline-block {\n display: inline-block !important;\n }\n}\n@media (min-width: 992px) and (max-width: 1199px) {\n .visible-md {\n display: block !important;\n }\n table.visible-md {\n display: table !important;\n }\n tr.visible-md {\n display: table-row !important;\n }\n th.visible-md,\n td.visible-md {\n display: table-cell !important;\n }\n}\n@media (min-width: 992px) and (max-width: 1199px) {\n .visible-md-block {\n display: block !important;\n }\n}\n@media (min-width: 992px) and (max-width: 1199px) {\n .visible-md-inline {\n display: inline !important;\n }\n}\n@media (min-width: 992px) and (max-width: 1199px) {\n .visible-md-inline-block {\n display: inline-block !important;\n }\n}\n@media (min-width: 1200px) {\n .visible-lg {\n display: block !important;\n }\n table.visible-lg {\n display: table !important;\n }\n tr.visible-lg {\n display: table-row !important;\n }\n th.visible-lg,\n td.visible-lg {\n display: table-cell !important;\n }\n}\n@media (min-width: 1200px) {\n .visible-lg-block {\n display: block !important;\n }\n}\n@media (min-width: 1200px) {\n .visible-lg-inline {\n display: inline !important;\n }\n}\n@media (min-width: 1200px) {\n .visible-lg-inline-block {\n display: inline-block !important;\n }\n}\n@media (max-width: 767px) {\n .hidden-xs {\n display: none !important;\n }\n}\n@media (min-width: 768px) and (max-width: 991px) {\n .hidden-sm {\n display: none !important;\n }\n}\n@media (min-width: 992px) and (max-width: 1199px) {\n .hidden-md {\n display: none !important;\n }\n}\n@media (min-width: 1200px) {\n .hidden-lg {\n display: none !important;\n }\n}\n.visible-print {\n display: none !important;\n}\n@media print {\n .visible-print {\n display: block !important;\n }\n table.visible-print {\n display: table !important;\n }\n tr.visible-print {\n display: table-row !important;\n }\n th.visible-print,\n td.visible-print {\n display: table-cell !important;\n }\n}\n.visible-print-block {\n display: none !important;\n}\n@media print {\n .visible-print-block {\n display: block !important;\n }\n}\n.visible-print-inline {\n display: none !important;\n}\n@media print {\n .visible-print-inline {\n display: inline !important;\n }\n}\n.visible-print-inline-block {\n display: none !important;\n}\n@media print {\n .visible-print-inline-block {\n display: inline-block !important;\n }\n}\n@media print {\n .hidden-print {\n display: none !important;\n }\n}\n/*# sourceMappingURL=bootstrap.css.map */", "// stylelint-disable\n\n/*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */\n\n//\n// 1. Set default font family to sans-serif.\n// 2. Prevent iOS and IE text size adjust after device orientation change,\n// without disabling user zoom.\n//\n\nhtml {\n font-family: sans-serif; // 1\n -ms-text-size-adjust: 100%; // 2\n -webkit-text-size-adjust: 100%; // 2\n}\n\n//\n// Remove default margin.\n//\n\nbody {\n margin: 0;\n}\n\n// HTML5 display definitions\n// ==========================================================================\n\n//\n// Correct `block` display not defined for any HTML5 element in IE 8/9.\n// Correct `block` display not defined for `details` or `summary` in IE 10/11\n// and Firefox.\n// Correct `block` display not defined for `main` in IE 11.\n//\n\narticle,\naside,\ndetails,\nfigcaption,\nfigure,\nfooter,\nheader,\nhgroup,\nmain,\nmenu,\nnav,\nsection,\nsummary {\n display: block;\n}\n\n//\n// 1. Correct `inline-block` display not defined in IE 8/9.\n// 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.\n//\n\naudio,\ncanvas,\nprogress,\nvideo {\n display: inline-block; // 1\n vertical-align: baseline; // 2\n}\n\n//\n// Prevent modern browsers from displaying `audio` without controls.\n// Remove excess height in iOS 5 devices.\n//\n\naudio:not([controls]) {\n display: none;\n height: 0;\n}\n\n//\n// Address `[hidden]` styling not present in IE 8/9/10.\n// Hide the `template` element in IE 8/9/10/11, Safari, and Firefox < 22.\n//\n\n[hidden],\ntemplate {\n display: none;\n}\n\n// Links\n// ==========================================================================\n\n//\n// Remove the gray background color from active links in IE 10.\n//\n\na {\n background-color: transparent;\n}\n\n//\n// Improve readability of focused elements when they are also in an\n// active/hover state.\n//\n\na:active,\na:hover {\n outline: 0;\n}\n\n// Text-level semantics\n// ==========================================================================\n\n//\n// 1. Remove the bottom border in Chrome 57- and Firefox 39-.\n// 2. Add the correct text decoration in Chrome, Edge, IE, Opera, and Safari.\n//\n\nabbr[title] {\n border-bottom: none; // 1\n text-decoration: underline; // 2\n text-decoration: underline dotted; // 2\n}\n\n//\n// Address style set to `bolder` in Firefox 4+, Safari, and Chrome.\n//\n\nb,\nstrong {\n font-weight: bold;\n}\n\n//\n// Address styling not present in Safari and Chrome.\n//\n\ndfn {\n font-style: italic;\n}\n\n//\n// Address variable `h1` font-size and margin within `section` and `article`\n// contexts in Firefox 4+, Safari, and Chrome.\n//\n\nh1 {\n font-size: 2em;\n margin: 0.67em 0;\n}\n\n//\n// Address styling not present in IE 8/9.\n//\n\nmark {\n background: #ff0;\n color: #000;\n}\n\n//\n// Address inconsistent and variable font size in all browsers.\n//\n\nsmall {\n font-size: 80%;\n}\n\n//\n// Prevent `sub` and `sup` affecting `line-height` in all browsers.\n//\n\nsub,\nsup {\n font-size: 75%;\n line-height: 0;\n position: relative;\n vertical-align: baseline;\n}\n\nsup {\n top: -0.5em;\n}\n\nsub {\n bottom: -0.25em;\n}\n\n// Embedded content\n// ==========================================================================\n\n//\n// Remove border when inside `a` element in IE 8/9/10.\n//\n\nimg {\n border: 0;\n}\n\n//\n// Correct overflow not hidden in IE 9/10/11.\n//\n\nsvg:not(:root) {\n overflow: hidden;\n}\n\n// Grouping content\n// ==========================================================================\n\n//\n// Address margin not present in IE 8/9 and Safari.\n//\n\nfigure {\n margin: 1em 40px;\n}\n\n//\n// Address differences between Firefox and other browsers.\n//\n\nhr {\n box-sizing: content-box;\n height: 0;\n}\n\n//\n// Contain overflow in all browsers.\n//\n\npre {\n overflow: auto;\n}\n\n//\n// Address odd `em`-unit font size rendering in all browsers.\n//\n\ncode,\nkbd,\npre,\nsamp {\n font-family: monospace, monospace;\n font-size: 1em;\n}\n\n// Forms\n// ==========================================================================\n\n//\n// Known limitation: by default, Chrome and Safari on OS X allow very limited\n// styling of `select`, unless a `border` property is set.\n//\n\n//\n// 1. Correct color not being inherited.\n// Known issue: affects color of disabled elements.\n// 2. Correct font properties not being inherited.\n// 3. Address margins set differently in Firefox 4+, Safari, and Chrome.\n//\n\nbutton,\ninput,\noptgroup,\nselect,\ntextarea {\n color: inherit; // 1\n font: inherit; // 2\n margin: 0; // 3\n}\n\n//\n// Address `overflow` set to `hidden` in IE 8/9/10/11.\n//\n\nbutton {\n overflow: visible;\n}\n\n//\n// Address inconsistent `text-transform` inheritance for `button` and `select`.\n// All other form control elements do not inherit `text-transform` values.\n// Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.\n// Correct `select` style inheritance in Firefox.\n//\n\nbutton,\nselect {\n text-transform: none;\n}\n\n//\n// 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`\n// and `video` controls.\n// 2. Correct inability to style clickable `input` types in iOS.\n// 3. Improve usability and consistency of cursor style between image-type\n// `input` and others.\n//\n\nbutton,\nhtml input[type=\"button\"], // 1\ninput[type=\"reset\"],\ninput[type=\"submit\"] {\n -webkit-appearance: button; // 2\n cursor: pointer; // 3\n}\n\n//\n// Re-set default cursor for disabled elements.\n//\n\nbutton[disabled],\nhtml input[disabled] {\n cursor: default;\n}\n\n//\n// Remove inner padding and border in Firefox 4+.\n//\n\nbutton::-moz-focus-inner,\ninput::-moz-focus-inner {\n border: 0;\n padding: 0;\n}\n\n//\n// Address Firefox 4+ setting `line-height` on `input` using `!important` in\n// the UA stylesheet.\n//\n\ninput {\n line-height: normal;\n}\n\n//\n// It's recommended that you don't attempt to style these elements.\n// Firefox's implementation doesn't respect box-sizing, padding, or width.\n//\n// 1. Address box sizing set to `content-box` in IE 8/9/10.\n// 2. Remove excess padding in IE 8/9/10.\n//\n\ninput[type=\"checkbox\"],\ninput[type=\"radio\"] {\n box-sizing: border-box; // 1\n padding: 0; // 2\n}\n\n//\n// Fix the cursor style for Chrome's increment/decrement buttons. For certain\n// `font-size` values of the `input`, it causes the cursor style of the\n// decrement button to change from `default` to `text`.\n//\n\ninput[type=\"number\"]::-webkit-inner-spin-button,\ninput[type=\"number\"]::-webkit-outer-spin-button {\n height: auto;\n}\n\n//\n// 1. Address `appearance` set to `searchfield` in Safari and Chrome.\n// 2. Address `box-sizing` set to `border-box` in Safari and Chrome.\n//\n\ninput[type=\"search\"] {\n -webkit-appearance: textfield; // 1\n box-sizing: content-box; //2\n}\n\n//\n// Remove inner padding and search cancel button in Safari and Chrome on OS X.\n// Safari (but not Chrome) clips the cancel button when the search input has\n// padding (and `textfield` appearance).\n//\n\ninput[type=\"search\"]::-webkit-search-cancel-button,\ninput[type=\"search\"]::-webkit-search-decoration {\n -webkit-appearance: none;\n}\n\n//\n// Define consistent border, margin, and padding.\n//\n\nfieldset {\n border: 1px solid #c0c0c0;\n margin: 0 2px;\n padding: 0.35em 0.625em 0.75em;\n}\n\n//\n// 1. Correct `color` not being inherited in IE 8/9/10/11.\n// 2. Remove padding so people aren't caught out if they zero out fieldsets.\n//\n\nlegend {\n border: 0; // 1\n padding: 0; // 2\n}\n\n//\n// Remove default vertical scrollbar in IE 8/9/10/11.\n//\n\ntextarea {\n overflow: auto;\n}\n\n//\n// Don't inherit the `font-weight` (applied by a rule above).\n// NOTE: the default cannot safely be changed in Chrome and Safari on OS X.\n//\n\noptgroup {\n font-weight: bold;\n}\n\n// Tables\n// ==========================================================================\n\n//\n// Remove most spacing between table cells.\n//\n\ntable {\n border-collapse: collapse;\n border-spacing: 0;\n}\n\ntd,\nth {\n padding: 0;\n}\n", "// stylelint-disable declaration-no-important, selector-no-qualifying-type\n\n/*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */\n\n// ==========================================================================\n// Print styles.\n// Inlined to avoid the additional HTTP request: h5bp.com/r\n// ==========================================================================\n\n@media print {\n *,\n *:before,\n *:after {\n color: #000 !important; // Black prints faster: h5bp.com/s\n text-shadow: none !important;\n background: transparent !important;\n box-shadow: none !important;\n }\n\n a,\n a:visited {\n text-decoration: underline;\n }\n\n a[href]:after {\n content: \" (\" attr(href) \")\";\n }\n\n abbr[title]:after {\n content: \" (\" attr(title) \")\";\n }\n\n // Don't show links that are fragment identifiers,\n // or use the `javascript:` pseudo protocol\n a[href^=\"#\"]:after,\n a[href^=\"javascript:\"]:after {\n content: \"\";\n }\n\n pre,\n blockquote {\n border: 1px solid #999;\n page-break-inside: avoid;\n }\n\n thead {\n display: table-header-group; // h5bp.com/t\n }\n\n tr,\n img {\n page-break-inside: avoid;\n }\n\n img {\n max-width: 100% !important;\n }\n\n p,\n h2,\n h3 {\n orphans: 3;\n widows: 3;\n }\n\n h2,\n h3 {\n page-break-after: avoid;\n }\n\n // Bootstrap specific changes start\n\n // Bootstrap components\n .navbar {\n display: none;\n }\n .btn,\n .dropup > .btn {\n > .caret {\n border-top-color: #000 !important;\n }\n }\n .label {\n border: 1px solid #000;\n }\n\n .table {\n border-collapse: collapse !important;\n\n td,\n th {\n background-color: #fff !important;\n }\n }\n .table-bordered {\n th,\n td {\n border: 1px solid #ddd !important;\n }\n }\n}\n", "// stylelint-disable value-list-comma-newline-after, value-list-comma-space-after, indentation, declaration-colon-newline-after, font-family-no-missing-generic-family-keyword\n\n//\n// Glyphicons for Bootstrap\n//\n// Since icons are fonts, they can be placed anywhere text is placed and are\n// thus automatically sized to match the surrounding child. To use, create an\n// inline element with the appropriate classes, like so:\n//\n// Star\n\n// Import the fonts\n@font-face {\n font-family: \"Glyphicons Halflings\";\n src: url(\"@{icon-font-path}@{icon-font-name}.eot\");\n src: url(\"@{icon-font-path}@{icon-font-name}.eot?#iefix\") format(\"embedded-opentype\"),\n url(\"@{icon-font-path}@{icon-font-name}.woff2\") format(\"woff2\"),\n url(\"@{icon-font-path}@{icon-font-name}.woff\") format(\"woff\"),\n url(\"@{icon-font-path}@{icon-font-name}.ttf\") format(\"truetype\"),\n url(\"@{icon-font-path}@{icon-font-name}.svg#@{icon-font-svg-id}\") format(\"svg\");\n}\n\n// Catchall baseclass\n.glyphicon {\n position: relative;\n top: 1px;\n display: inline-block;\n font-family: \"Glyphicons Halflings\";\n font-style: normal;\n font-weight: 400;\n line-height: 1;\n -webkit-font-smoothing: antialiased;\n -moz-osx-font-smoothing: grayscale;\n}\n\n// Individual icons\n.glyphicon-asterisk { &:before { content: \"\\002a\"; } }\n.glyphicon-plus { &:before { content: \"\\002b\"; } }\n.glyphicon-euro,\n.glyphicon-eur { &:before { content: \"\\20ac\"; } }\n.glyphicon-minus { &:before { content: \"\\2212\"; } }\n.glyphicon-cloud { &:before { content: \"\\2601\"; } }\n.glyphicon-envelope { &:before { content: \"\\2709\"; } }\n.glyphicon-pencil { &:before { content: \"\\270f\"; } }\n.glyphicon-glass { &:before { content: \"\\e001\"; } }\n.glyphicon-music { &:before { content: \"\\e002\"; } }\n.glyphicon-search { &:before { content: \"\\e003\"; } }\n.glyphicon-heart { &:before { content: \"\\e005\"; } }\n.glyphicon-star { &:before { content: \"\\e006\"; } }\n.glyphicon-star-empty { &:before { content: \"\\e007\"; } }\n.glyphicon-user { &:before { content: \"\\e008\"; } }\n.glyphicon-film { &:before { content: \"\\e009\"; } }\n.glyphicon-th-large { &:before { content: \"\\e010\"; } }\n.glyphicon-th { &:before { content: \"\\e011\"; } }\n.glyphicon-th-list { &:before { content: \"\\e012\"; } }\n.glyphicon-ok { &:before { content: \"\\e013\"; } }\n.glyphicon-remove { &:before { content: \"\\e014\"; } }\n.glyphicon-zoom-in { &:before { content: \"\\e015\"; } }\n.glyphicon-zoom-out { &:before { content: \"\\e016\"; } }\n.glyphicon-off { &:before { content: \"\\e017\"; } }\n.glyphicon-signal { &:before { content: \"\\e018\"; } }\n.glyphicon-cog { &:before { content: \"\\e019\"; } }\n.glyphicon-trash { &:before { content: \"\\e020\"; } }\n.glyphicon-home { &:before { content: \"\\e021\"; } }\n.glyphicon-file { &:before { content: \"\\e022\"; } }\n.glyphicon-time { &:before { content: \"\\e023\"; } }\n.glyphicon-road { &:before { content: \"\\e024\"; } }\n.glyphicon-download-alt { &:before { content: \"\\e025\"; } }\n.glyphicon-download { &:before { content: \"\\e026\"; } }\n.glyphicon-upload { &:before { content: \"\\e027\"; } }\n.glyphicon-inbox { &:before { content: \"\\e028\"; } }\n.glyphicon-play-circle { &:before { content: \"\\e029\"; } }\n.glyphicon-repeat { &:before { content: \"\\e030\"; } }\n.glyphicon-refresh { &:before { content: \"\\e031\"; } }\n.glyphicon-list-alt { &:before { content: \"\\e032\"; } }\n.glyphicon-lock { &:before { content: \"\\e033\"; } }\n.glyphicon-flag { &:before { content: \"\\e034\"; } }\n.glyphicon-headphones { &:before { content: \"\\e035\"; } }\n.glyphicon-volume-off { &:before { content: \"\\e036\"; } }\n.glyphicon-volume-down { &:before { content: \"\\e037\"; } }\n.glyphicon-volume-up { &:before { content: \"\\e038\"; } }\n.glyphicon-qrcode { &:before { content: \"\\e039\"; } }\n.glyphicon-barcode { &:before { content: \"\\e040\"; } }\n.glyphicon-tag { &:before { content: \"\\e041\"; } }\n.glyphicon-tags { &:before { content: \"\\e042\"; } }\n.glyphicon-book { &:before { content: \"\\e043\"; } }\n.glyphicon-bookmark { &:before { content: \"\\e044\"; } }\n.glyphicon-print { &:before { content: \"\\e045\"; } }\n.glyphicon-camera { &:before { content: \"\\e046\"; } }\n.glyphicon-font { &:before { content: \"\\e047\"; } }\n.glyphicon-bold { &:before { content: \"\\e048\"; } }\n.glyphicon-italic { &:before { content: \"\\e049\"; } }\n.glyphicon-text-height { &:before { content: \"\\e050\"; } }\n.glyphicon-text-width { &:before { content: \"\\e051\"; } }\n.glyphicon-align-left { &:before { content: \"\\e052\"; } }\n.glyphicon-align-center { &:before { content: \"\\e053\"; } }\n.glyphicon-align-right { &:before { content: \"\\e054\"; } }\n.glyphicon-align-justify { &:before { content: \"\\e055\"; } }\n.glyphicon-list { &:before { content: \"\\e056\"; } }\n.glyphicon-indent-left { &:before { content: \"\\e057\"; } }\n.glyphicon-indent-right { &:before { content: \"\\e058\"; } }\n.glyphicon-facetime-video { &:before { content: \"\\e059\"; } }\n.glyphicon-picture { &:before { content: \"\\e060\"; } }\n.glyphicon-map-marker { &:before { content: \"\\e062\"; } }\n.glyphicon-adjust { &:before { content: \"\\e063\"; } }\n.glyphicon-tint { &:before { content: \"\\e064\"; } }\n.glyphicon-edit { &:before { content: \"\\e065\"; } }\n.glyphicon-share { &:before { content: \"\\e066\"; } }\n.glyphicon-check { &:before { content: \"\\e067\"; } }\n.glyphicon-move { &:before { content: \"\\e068\"; } }\n.glyphicon-step-backward { &:before { content: \"\\e069\"; } }\n.glyphicon-fast-backward { &:before { content: \"\\e070\"; } }\n.glyphicon-backward { &:before { content: \"\\e071\"; } }\n.glyphicon-play { &:before { content: \"\\e072\"; } }\n.glyphicon-pause { &:before { content: \"\\e073\"; } }\n.glyphicon-stop { &:before { content: \"\\e074\"; } }\n.glyphicon-forward { &:before { content: \"\\e075\"; } }\n.glyphicon-fast-forward { &:before { content: \"\\e076\"; } }\n.glyphicon-step-forward { &:before { content: \"\\e077\"; } }\n.glyphicon-eject { &:before { content: \"\\e078\"; } }\n.glyphicon-chevron-left { &:before { content: \"\\e079\"; } }\n.glyphicon-chevron-right { &:before { content: \"\\e080\"; } }\n.glyphicon-plus-sign { &:before { content: \"\\e081\"; } }\n.glyphicon-minus-sign { &:before { content: \"\\e082\"; } }\n.glyphicon-remove-sign { &:before { content: \"\\e083\"; } }\n.glyphicon-ok-sign { &:before { content: \"\\e084\"; } }\n.glyphicon-question-sign { &:before { content: \"\\e085\"; } }\n.glyphicon-info-sign { &:before { content: \"\\e086\"; } }\n.glyphicon-screenshot { &:before { content: \"\\e087\"; } }\n.glyphicon-remove-circle { &:before { content: \"\\e088\"; } }\n.glyphicon-ok-circle { &:before { content: \"\\e089\"; } }\n.glyphicon-ban-circle { &:before { content: \"\\e090\"; } }\n.glyphicon-arrow-left { &:before { content: \"\\e091\"; } }\n.glyphicon-arrow-right { &:before { content: \"\\e092\"; } }\n.glyphicon-arrow-up { &:before { content: \"\\e093\"; } }\n.glyphicon-arrow-down { &:before { content: \"\\e094\"; } }\n.glyphicon-share-alt { &:before { content: \"\\e095\"; } }\n.glyphicon-resize-full { &:before { content: \"\\e096\"; } }\n.glyphicon-resize-small { &:before { content: \"\\e097\"; } }\n.glyphicon-exclamation-sign { &:before { content: \"\\e101\"; } }\n.glyphicon-gift { &:before { content: \"\\e102\"; } }\n.glyphicon-leaf { &:before { content: \"\\e103\"; } }\n.glyphicon-fire { &:before { content: \"\\e104\"; } }\n.glyphicon-eye-open { &:before { content: \"\\e105\"; } }\n.glyphicon-eye-close { &:before { content: \"\\e106\"; } }\n.glyphicon-warning-sign { &:before { content: \"\\e107\"; } }\n.glyphicon-plane { &:before { content: \"\\e108\"; } }\n.glyphicon-calendar { &:before { content: \"\\e109\"; } }\n.glyphicon-random { &:before { content: \"\\e110\"; } }\n.glyphicon-comment { &:before { content: \"\\e111\"; } }\n.glyphicon-magnet { &:before { content: \"\\e112\"; } }\n.glyphicon-chevron-up { &:before { content: \"\\e113\"; } }\n.glyphicon-chevron-down { &:before { content: \"\\e114\"; } }\n.glyphicon-retweet { &:before { content: \"\\e115\"; } }\n.glyphicon-shopping-cart { &:before { content: \"\\e116\"; } }\n.glyphicon-folder-close { &:before { content: \"\\e117\"; } }\n.glyphicon-folder-open { &:before { content: \"\\e118\"; } }\n.glyphicon-resize-vertical { &:before { content: \"\\e119\"; } }\n.glyphicon-resize-horizontal { &:before { content: \"\\e120\"; } }\n.glyphicon-hdd { &:before { content: \"\\e121\"; } }\n.glyphicon-bullhorn { &:before { content: \"\\e122\"; } }\n.glyphicon-bell { &:before { content: \"\\e123\"; } }\n.glyphicon-certificate { &:before { content: \"\\e124\"; } }\n.glyphicon-thumbs-up { &:before { content: \"\\e125\"; } }\n.glyphicon-thumbs-down { &:before { content: \"\\e126\"; } }\n.glyphicon-hand-right { &:before { content: \"\\e127\"; } }\n.glyphicon-hand-left { &:before { content: \"\\e128\"; } }\n.glyphicon-hand-up { &:before { content: \"\\e129\"; } }\n.glyphicon-hand-down { &:before { content: \"\\e130\"; } }\n.glyphicon-circle-arrow-right { &:before { content: \"\\e131\"; } }\n.glyphicon-circle-arrow-left { &:before { content: \"\\e132\"; } }\n.glyphicon-circle-arrow-up { &:before { content: \"\\e133\"; } }\n.glyphicon-circle-arrow-down { &:before { content: \"\\e134\"; } }\n.glyphicon-globe { &:before { content: \"\\e135\"; } }\n.glyphicon-wrench { &:before { content: \"\\e136\"; } }\n.glyphicon-tasks { &:before { content: \"\\e137\"; } }\n.glyphicon-filter { &:before { content: \"\\e138\"; } }\n.glyphicon-briefcase { &:before { content: \"\\e139\"; } }\n.glyphicon-fullscreen { &:before { content: \"\\e140\"; } }\n.glyphicon-dashboard { &:before { content: \"\\e141\"; } }\n.glyphicon-paperclip { &:before { content: \"\\e142\"; } }\n.glyphicon-heart-empty { &:before { content: \"\\e143\"; } }\n.glyphicon-link { &:before { content: \"\\e144\"; } }\n.glyphicon-phone { &:before { content: \"\\e145\"; } }\n.glyphicon-pushpin { &:before { content: \"\\e146\"; } }\n.glyphicon-usd { &:before { content: \"\\e148\"; } }\n.glyphicon-gbp { &:before { content: \"\\e149\"; } }\n.glyphicon-sort { &:before { content: \"\\e150\"; } }\n.glyphicon-sort-by-alphabet { &:before { content: \"\\e151\"; } }\n.glyphicon-sort-by-alphabet-alt { &:before { content: \"\\e152\"; } }\n.glyphicon-sort-by-order { &:before { content: \"\\e153\"; } }\n.glyphicon-sort-by-order-alt { &:before { content: \"\\e154\"; } }\n.glyphicon-sort-by-attributes { &:before { content: \"\\e155\"; } }\n.glyphicon-sort-by-attributes-alt { &:before { content: \"\\e156\"; } }\n.glyphicon-unchecked { &:before { content: \"\\e157\"; } }\n.glyphicon-expand { &:before { content: \"\\e158\"; } }\n.glyphicon-collapse-down { &:before { content: \"\\e159\"; } }\n.glyphicon-collapse-up { &:before { content: \"\\e160\"; } }\n.glyphicon-log-in { &:before { content: \"\\e161\"; } }\n.glyphicon-flash { &:before { content: \"\\e162\"; } }\n.glyphicon-log-out { &:before { content: \"\\e163\"; } }\n.glyphicon-new-window { &:before { content: \"\\e164\"; } }\n.glyphicon-record { &:before { content: \"\\e165\"; } }\n.glyphicon-save { &:before { content: \"\\e166\"; } }\n.glyphicon-open { &:before { content: \"\\e167\"; } }\n.glyphicon-saved { &:before { content: \"\\e168\"; } }\n.glyphicon-import { &:before { content: \"\\e169\"; } }\n.glyphicon-export { &:before { content: \"\\e170\"; } }\n.glyphicon-send { &:before { content: \"\\e171\"; } }\n.glyphicon-floppy-disk { &:before { content: \"\\e172\"; } }\n.glyphicon-floppy-saved { &:before { content: \"\\e173\"; } }\n.glyphicon-floppy-remove { &:before { content: \"\\e174\"; } }\n.glyphicon-floppy-save { &:before { content: \"\\e175\"; } }\n.glyphicon-floppy-open { &:before { content: \"\\e176\"; } }\n.glyphicon-credit-card { &:before { content: \"\\e177\"; } }\n.glyphicon-transfer { &:before { content: \"\\e178\"; } }\n.glyphicon-cutlery { &:before { content: \"\\e179\"; } }\n.glyphicon-header { &:before { content: \"\\e180\"; } }\n.glyphicon-compressed { &:before { content: \"\\e181\"; } }\n.glyphicon-earphone { &:before { content: \"\\e182\"; } }\n.glyphicon-phone-alt { &:before { content: \"\\e183\"; } }\n.glyphicon-tower { &:before { content: \"\\e184\"; } }\n.glyphicon-stats { &:before { content: \"\\e185\"; } }\n.glyphicon-sd-video { &:before { content: \"\\e186\"; } }\n.glyphicon-hd-video { &:before { content: \"\\e187\"; } }\n.glyphicon-subtitles { &:before { content: \"\\e188\"; } }\n.glyphicon-sound-stereo { &:before { content: \"\\e189\"; } }\n.glyphicon-sound-dolby { &:before { content: \"\\e190\"; } }\n.glyphicon-sound-5-1 { &:before { content: \"\\e191\"; } }\n.glyphicon-sound-6-1 { &:before { content: \"\\e192\"; } }\n.glyphicon-sound-7-1 { &:before { content: \"\\e193\"; } }\n.glyphicon-copyright-mark { &:before { content: \"\\e194\"; } }\n.glyphicon-registration-mark { &:before { content: \"\\e195\"; } }\n.glyphicon-cloud-download { &:before { content: \"\\e197\"; } }\n.glyphicon-cloud-upload { &:before { content: \"\\e198\"; } }\n.glyphicon-tree-conifer { &:before { content: \"\\e199\"; } }\n.glyphicon-tree-deciduous { &:before { content: \"\\e200\"; } }\n.glyphicon-cd { &:before { content: \"\\e201\"; } }\n.glyphicon-save-file { &:before { content: \"\\e202\"; } }\n.glyphicon-open-file { &:before { content: \"\\e203\"; } }\n.glyphicon-level-up { &:before { content: \"\\e204\"; } }\n.glyphicon-copy { &:before { content: \"\\e205\"; } }\n.glyphicon-paste { &:before { content: \"\\e206\"; } }\n// The following 2 Glyphicons are omitted for the time being because\n// they currently use Unicode codepoints that are outside the\n// Basic Multilingual Plane (BMP). Older buggy versions of WebKit can't handle\n// non-BMP codepoints in CSS string escapes, and thus can't display these two icons.\n// Notably, the bug affects some older versions of the Android Browser.\n// More info: https://github.com/twbs/bootstrap/issues/10106\n// .glyphicon-door { &:before { content: \"\\1f6aa\"; } }\n// .glyphicon-key { &:before { content: \"\\1f511\"; } }\n.glyphicon-alert { &:before { content: \"\\e209\"; } }\n.glyphicon-equalizer { &:before { content: \"\\e210\"; } }\n.glyphicon-king { &:before { content: \"\\e211\"; } }\n.glyphicon-queen { &:before { content: \"\\e212\"; } }\n.glyphicon-pawn { &:before { content: \"\\e213\"; } }\n.glyphicon-bishop { &:before { content: \"\\e214\"; } }\n.glyphicon-knight { &:before { content: \"\\e215\"; } }\n.glyphicon-baby-formula { &:before { content: \"\\e216\"; } }\n.glyphicon-tent { &:before { content: \"\\26fa\"; } }\n.glyphicon-blackboard { &:before { content: \"\\e218\"; } }\n.glyphicon-bed { &:before { content: \"\\e219\"; } }\n.glyphicon-apple { &:before { content: \"\\f8ff\"; } }\n.glyphicon-erase { &:before { content: \"\\e221\"; } }\n.glyphicon-hourglass { &:before { content: \"\\231b\"; } }\n.glyphicon-lamp { &:before { content: \"\\e223\"; } }\n.glyphicon-duplicate { &:before { content: \"\\e224\"; } }\n.glyphicon-piggy-bank { &:before { content: \"\\e225\"; } }\n.glyphicon-scissors { &:before { content: \"\\e226\"; } }\n.glyphicon-bitcoin { &:before { content: \"\\e227\"; } }\n.glyphicon-btc { &:before { content: \"\\e227\"; } }\n.glyphicon-xbt { &:before { content: \"\\e227\"; } }\n.glyphicon-yen { &:before { content: \"\\00a5\"; } }\n.glyphicon-jpy { &:before { content: \"\\00a5\"; } }\n.glyphicon-ruble { &:before { content: \"\\20bd\"; } }\n.glyphicon-rub { &:before { content: \"\\20bd\"; } }\n.glyphicon-scale { &:before { content: \"\\e230\"; } }\n.glyphicon-ice-lolly { &:before { content: \"\\e231\"; } }\n.glyphicon-ice-lolly-tasted { &:before { content: \"\\e232\"; } }\n.glyphicon-education { &:before { content: \"\\e233\"; } }\n.glyphicon-option-horizontal { &:before { content: \"\\e234\"; } }\n.glyphicon-option-vertical { &:before { content: \"\\e235\"; } }\n.glyphicon-menu-hamburger { &:before { content: \"\\e236\"; } }\n.glyphicon-modal-window { &:before { content: \"\\e237\"; } }\n.glyphicon-oil { &:before { content: \"\\e238\"; } }\n.glyphicon-grain { &:before { content: \"\\e239\"; } }\n.glyphicon-sunglasses { &:before { content: \"\\e240\"; } }\n.glyphicon-text-size { &:before { content: \"\\e241\"; } }\n.glyphicon-text-color { &:before { content: \"\\e242\"; } }\n.glyphicon-text-background { &:before { content: \"\\e243\"; } }\n.glyphicon-object-align-top { &:before { content: \"\\e244\"; } }\n.glyphicon-object-align-bottom { &:before { content: \"\\e245\"; } }\n.glyphicon-object-align-horizontal{ &:before { content: \"\\e246\"; } }\n.glyphicon-object-align-left { &:before { content: \"\\e247\"; } }\n.glyphicon-object-align-vertical { &:before { content: \"\\e248\"; } }\n.glyphicon-object-align-right { &:before { content: \"\\e249\"; } }\n.glyphicon-triangle-right { &:before { content: \"\\e250\"; } }\n.glyphicon-triangle-left { &:before { content: \"\\e251\"; } }\n.glyphicon-triangle-bottom { &:before { content: \"\\e252\"; } }\n.glyphicon-triangle-top { &:before { content: \"\\e253\"; } }\n.glyphicon-console { &:before { content: \"\\e254\"; } }\n.glyphicon-superscript { &:before { content: \"\\e255\"; } }\n.glyphicon-subscript { &:before { content: \"\\e256\"; } }\n.glyphicon-menu-left { &:before { content: \"\\e257\"; } }\n.glyphicon-menu-right { &:before { content: \"\\e258\"; } }\n.glyphicon-menu-down { &:before { content: \"\\e259\"; } }\n.glyphicon-menu-up { &:before { content: \"\\e260\"; } }\n", "//\n// Scaffolding\n// --------------------------------------------------\n\n\n// Reset the box-sizing\n//\n// Heads up! This reset may cause conflicts with some third-party widgets.\n// For recommendations on resolving such conflicts, see\n// https://getbootstrap.com/docs/3.4/getting-started/#third-box-sizing\n* {\n .box-sizing(border-box);\n}\n*:before,\n*:after {\n .box-sizing(border-box);\n}\n\n\n// Body reset\n\nhtml {\n font-size: 10px;\n -webkit-tap-highlight-color: rgba(0, 0, 0, 0);\n}\n\nbody {\n font-family: @font-family-base;\n font-size: @font-size-base;\n line-height: @line-height-base;\n color: @text-color;\n background-color: @body-bg;\n}\n\n// Reset fonts for relevant elements\ninput,\nbutton,\nselect,\ntextarea {\n font-family: inherit;\n font-size: inherit;\n line-height: inherit;\n}\n\n\n// Links\n\na {\n color: @link-color;\n text-decoration: none;\n\n &:hover,\n &:focus {\n color: @link-hover-color;\n text-decoration: @link-hover-decoration;\n }\n\n &:focus {\n .tab-focus();\n }\n}\n\n\n// Figures\n//\n// We reset this here because previously Normalize had no `figure` margins. This\n// ensures we don't break anyone's use of the element.\n\nfigure {\n margin: 0;\n}\n\n\n// Images\n\nimg {\n vertical-align: middle;\n}\n\n// Responsive images (ensure images don't scale beyond their parents)\n.img-responsive {\n .img-responsive();\n}\n\n// Rounded corners\n.img-rounded {\n border-radius: @border-radius-large;\n}\n\n// Image thumbnails\n//\n// Heads up! This is mixin-ed into thumbnails.less for `.thumbnail`.\n.img-thumbnail {\n padding: @thumbnail-padding;\n line-height: @line-height-base;\n background-color: @thumbnail-bg;\n border: 1px solid @thumbnail-border;\n border-radius: @thumbnail-border-radius;\n .transition(all .2s ease-in-out);\n\n // Keep them at most 100% wide\n .img-responsive(inline-block);\n}\n\n// Perfect circle\n.img-circle {\n border-radius: 50%; // set radius in percents\n}\n\n\n// Horizontal rules\n\nhr {\n margin-top: @line-height-computed;\n margin-bottom: @line-height-computed;\n border: 0;\n border-top: 1px solid @hr-border;\n}\n\n\n// Only display content to screen readers\n//\n// See: https://a11yproject.com/posts/how-to-hide-content\n\n.sr-only {\n position: absolute;\n width: 1px;\n height: 1px;\n padding: 0;\n margin: -1px;\n overflow: hidden;\n clip: rect(0, 0, 0, 0);\n border: 0;\n}\n\n// Use in conjunction with .sr-only to only display content when it's focused.\n// Useful for \"Skip to main content\" links; see https://www.w3.org/TR/2013/NOTE-WCAG20-TECHS-20130905/G1\n// Credit: HTML5 Boilerplate\n\n.sr-only-focusable {\n &:active,\n &:focus {\n position: static;\n width: auto;\n height: auto;\n margin: 0;\n overflow: visible;\n clip: auto;\n }\n}\n\n\n// iOS \"clickable elements\" fix for role=\"button\"\n//\n// Fixes \"clickability\" issue (and more generally, the firing of events such as focus as well)\n// for traditionally non-focusable elements with role=\"button\"\n// see https://developer.mozilla.org/en-US/docs/Web/Events/click#Safari_Mobile\n\n[role=\"button\"] {\n cursor: pointer;\n}\n", "// stylelint-disable indentation, property-no-vendor-prefix, selector-no-vendor-prefix\n\n// Vendor Prefixes\n//\n// All vendor mixins are deprecated as of v3.2.0 due to the introduction of\n// Autoprefixer in our Gruntfile. They have been removed in v4.\n\n// - Animations\n// - Backface visibility\n// - Box shadow\n// - Box sizing\n// - Content columns\n// - Hyphens\n// - Placeholder text\n// - Transformations\n// - Transitions\n// - User Select\n\n\n// Animations\n.animation(@animation) {\n -webkit-animation: @animation;\n -o-animation: @animation;\n animation: @animation;\n}\n.animation-name(@name) {\n -webkit-animation-name: @name;\n animation-name: @name;\n}\n.animation-duration(@duration) {\n -webkit-animation-duration: @duration;\n animation-duration: @duration;\n}\n.animation-timing-function(@timing-function) {\n -webkit-animation-timing-function: @timing-function;\n animation-timing-function: @timing-function;\n}\n.animation-delay(@delay) {\n -webkit-animation-delay: @delay;\n animation-delay: @delay;\n}\n.animation-iteration-count(@iteration-count) {\n -webkit-animation-iteration-count: @iteration-count;\n animation-iteration-count: @iteration-count;\n}\n.animation-direction(@direction) {\n -webkit-animation-direction: @direction;\n animation-direction: @direction;\n}\n.animation-fill-mode(@fill-mode) {\n -webkit-animation-fill-mode: @fill-mode;\n animation-fill-mode: @fill-mode;\n}\n\n// Backface visibility\n// Prevent browsers from flickering when using CSS 3D transforms.\n// Default value is `visible`, but can be changed to `hidden`\n\n.backface-visibility(@visibility) {\n -webkit-backface-visibility: @visibility;\n -moz-backface-visibility: @visibility;\n backface-visibility: @visibility;\n}\n\n// Drop shadows\n//\n// Note: Deprecated `.box-shadow()` as of v3.1.0 since all of Bootstrap's\n// supported browsers that have box shadow capabilities now support it.\n\n.box-shadow(@shadow) {\n -webkit-box-shadow: @shadow; // iOS <4.3 & Android <4.1\n box-shadow: @shadow;\n}\n\n// Box sizing\n.box-sizing(@boxmodel) {\n -webkit-box-sizing: @boxmodel;\n -moz-box-sizing: @boxmodel;\n box-sizing: @boxmodel;\n}\n\n// CSS3 Content Columns\n.content-columns(@column-count; @column-gap: @grid-gutter-width) {\n -webkit-column-count: @column-count;\n -moz-column-count: @column-count;\n column-count: @column-count;\n -webkit-column-gap: @column-gap;\n -moz-column-gap: @column-gap;\n column-gap: @column-gap;\n}\n\n// Optional hyphenation\n.hyphens(@mode: auto) {\n -webkit-hyphens: @mode;\n -moz-hyphens: @mode;\n -ms-hyphens: @mode; // IE10+\n -o-hyphens: @mode;\n hyphens: @mode;\n word-wrap: break-word;\n}\n\n// Placeholder text\n.placeholder(@color: @input-color-placeholder) {\n // Firefox\n &::-moz-placeholder {\n color: @color;\n opacity: 1; // Override Firefox's unusual default opacity; see https://github.com/twbs/bootstrap/pull/11526\n }\n &:-ms-input-placeholder { color: @color; } // Internet Explorer 10+\n &::-webkit-input-placeholder { color: @color; } // Safari and Chrome\n}\n\n// Transformations\n.scale(@ratio) {\n -webkit-transform: scale(@ratio);\n -ms-transform: scale(@ratio); // IE9 only\n -o-transform: scale(@ratio);\n transform: scale(@ratio);\n}\n.scale(@ratioX; @ratioY) {\n -webkit-transform: scale(@ratioX, @ratioY);\n -ms-transform: scale(@ratioX, @ratioY); // IE9 only\n -o-transform: scale(@ratioX, @ratioY);\n transform: scale(@ratioX, @ratioY);\n}\n.scaleX(@ratio) {\n -webkit-transform: scaleX(@ratio);\n -ms-transform: scaleX(@ratio); // IE9 only\n -o-transform: scaleX(@ratio);\n transform: scaleX(@ratio);\n}\n.scaleY(@ratio) {\n -webkit-transform: scaleY(@ratio);\n -ms-transform: scaleY(@ratio); // IE9 only\n -o-transform: scaleY(@ratio);\n transform: scaleY(@ratio);\n}\n.skew(@x; @y) {\n -webkit-transform: skewX(@x) skewY(@y);\n -ms-transform: skewX(@x) skewY(@y); // See https://github.com/twbs/bootstrap/issues/4885; IE9+\n -o-transform: skewX(@x) skewY(@y);\n transform: skewX(@x) skewY(@y);\n}\n.translate(@x; @y) {\n -webkit-transform: translate(@x, @y);\n -ms-transform: translate(@x, @y); // IE9 only\n -o-transform: translate(@x, @y);\n transform: translate(@x, @y);\n}\n.translate3d(@x; @y; @z) {\n -webkit-transform: translate3d(@x, @y, @z);\n transform: translate3d(@x, @y, @z);\n}\n.rotate(@degrees) {\n -webkit-transform: rotate(@degrees);\n -ms-transform: rotate(@degrees); // IE9 only\n -o-transform: rotate(@degrees);\n transform: rotate(@degrees);\n}\n.rotateX(@degrees) {\n -webkit-transform: rotateX(@degrees);\n -ms-transform: rotateX(@degrees); // IE9 only\n -o-transform: rotateX(@degrees);\n transform: rotateX(@degrees);\n}\n.rotateY(@degrees) {\n -webkit-transform: rotateY(@degrees);\n -ms-transform: rotateY(@degrees); // IE9 only\n -o-transform: rotateY(@degrees);\n transform: rotateY(@degrees);\n}\n.perspective(@perspective) {\n -webkit-perspective: @perspective;\n -moz-perspective: @perspective;\n perspective: @perspective;\n}\n.perspective-origin(@perspective) {\n -webkit-perspective-origin: @perspective;\n -moz-perspective-origin: @perspective;\n perspective-origin: @perspective;\n}\n.transform-origin(@origin) {\n -webkit-transform-origin: @origin;\n -moz-transform-origin: @origin;\n -ms-transform-origin: @origin; // IE9 only\n transform-origin: @origin;\n}\n\n\n// Transitions\n\n.transition(@transition) {\n -webkit-transition: @transition;\n -o-transition: @transition;\n transition: @transition;\n}\n.transition-property(@transition-property) {\n -webkit-transition-property: @transition-property;\n transition-property: @transition-property;\n}\n.transition-delay(@transition-delay) {\n -webkit-transition-delay: @transition-delay;\n transition-delay: @transition-delay;\n}\n.transition-duration(@transition-duration) {\n -webkit-transition-duration: @transition-duration;\n transition-duration: @transition-duration;\n}\n.transition-timing-function(@timing-function) {\n -webkit-transition-timing-function: @timing-function;\n transition-timing-function: @timing-function;\n}\n.transition-transform(@transition) {\n -webkit-transition: -webkit-transform @transition;\n -moz-transition: -moz-transform @transition;\n -o-transition: -o-transform @transition;\n transition: transform @transition;\n}\n\n\n// User select\n// For selecting text on the page\n\n.user-select(@select) {\n -webkit-user-select: @select;\n -moz-user-select: @select;\n -ms-user-select: @select; // IE10+\n user-select: @select;\n}\n", "// WebKit-style focus\n\n.tab-focus() {\n // WebKit-specific. Other browsers will keep their default outline style.\n // (Initially tried to also force default via `outline: initial`,\n // but that seems to erroneously remove the outline in Firefox altogether.)\n outline: 5px auto -webkit-focus-ring-color;\n outline-offset: -2px;\n}\n", "// stylelint-disable media-feature-name-no-vendor-prefix, media-feature-parentheses-space-inside, media-feature-name-no-unknown, indentation, at-rule-name-space-after\n\n// Responsive image\n//\n// Keep images from scaling beyond the width of their parents.\n.img-responsive(@display: block) {\n display: @display;\n max-width: 100%; // Part 1: Set a maximum relative to the parent\n height: auto; // Part 2: Scale the height according to the width, otherwise you get stretching\n}\n\n\n// Retina image\n//\n// Short retina mixin for setting background-image and -size. Note that the\n// spelling of `min--moz-device-pixel-ratio` is intentional.\n.img-retina(@file-1x; @file-2x; @width-1x; @height-1x) {\n background-image: url(\"@{file-1x}\");\n\n @media\n only screen and (-webkit-min-device-pixel-ratio: 2),\n only screen and ( min--moz-device-pixel-ratio: 2),\n only screen and ( -o-min-device-pixel-ratio: 2/1),\n only screen and ( min-device-pixel-ratio: 2),\n only screen and ( min-resolution: 192dpi),\n only screen and ( min-resolution: 2dppx) {\n background-image: url(\"@{file-2x}\");\n background-size: @width-1x @height-1x;\n }\n}\n", "// stylelint-disable selector-list-comma-newline-after, selector-no-qualifying-type\n\n//\n// Typography\n// --------------------------------------------------\n\n\n// Headings\n// -------------------------\n\nh1, h2, h3, h4, h5, h6,\n.h1, .h2, .h3, .h4, .h5, .h6 {\n font-family: @headings-font-family;\n font-weight: @headings-font-weight;\n line-height: @headings-line-height;\n color: @headings-color;\n\n small,\n .small {\n font-weight: 400;\n line-height: 1;\n color: @headings-small-color;\n }\n}\n\nh1, .h1,\nh2, .h2,\nh3, .h3 {\n margin-top: @line-height-computed;\n margin-bottom: (@line-height-computed / 2);\n\n small,\n .small {\n font-size: 65%;\n }\n}\nh4, .h4,\nh5, .h5,\nh6, .h6 {\n margin-top: (@line-height-computed / 2);\n margin-bottom: (@line-height-computed / 2);\n\n small,\n .small {\n font-size: 75%;\n }\n}\n\nh1, .h1 { font-size: @font-size-h1; }\nh2, .h2 { font-size: @font-size-h2; }\nh3, .h3 { font-size: @font-size-h3; }\nh4, .h4 { font-size: @font-size-h4; }\nh5, .h5 { font-size: @font-size-h5; }\nh6, .h6 { font-size: @font-size-h6; }\n\n\n// Body text\n// -------------------------\n\np {\n margin: 0 0 (@line-height-computed / 2);\n}\n\n.lead {\n margin-bottom: @line-height-computed;\n font-size: floor((@font-size-base * 1.15));\n font-weight: 300;\n line-height: 1.4;\n\n @media (min-width: @screen-sm-min) {\n font-size: (@font-size-base * 1.5);\n }\n}\n\n\n// Emphasis & misc\n// -------------------------\n\n// Ex: (12px small font / 14px base font) * 100% = about 85%\nsmall,\n.small {\n font-size: floor((100% * @font-size-small / @font-size-base));\n}\n\nmark,\n.mark {\n padding: .2em;\n background-color: @state-warning-bg;\n}\n\n// Alignment\n.text-left { text-align: left; }\n.text-right { text-align: right; }\n.text-center { text-align: center; }\n.text-justify { text-align: justify; }\n.text-nowrap { white-space: nowrap; }\n\n// Transformation\n.text-lowercase { text-transform: lowercase; }\n.text-uppercase { text-transform: uppercase; }\n.text-capitalize { text-transform: capitalize; }\n\n// Contextual colors\n.text-muted {\n color: @text-muted;\n}\n.text-primary {\n .text-emphasis-variant(@brand-primary);\n}\n.text-success {\n .text-emphasis-variant(@state-success-text);\n}\n.text-info {\n .text-emphasis-variant(@state-info-text);\n}\n.text-warning {\n .text-emphasis-variant(@state-warning-text);\n}\n.text-danger {\n .text-emphasis-variant(@state-danger-text);\n}\n\n// Contextual backgrounds\n// For now we'll leave these alongside the text classes until v4 when we can\n// safely shift things around (per SemVer rules).\n.bg-primary {\n // Given the contrast here, this is the only class to have its color inverted\n // automatically.\n color: #fff;\n .bg-variant(@brand-primary);\n}\n.bg-success {\n .bg-variant(@state-success-bg);\n}\n.bg-info {\n .bg-variant(@state-info-bg);\n}\n.bg-warning {\n .bg-variant(@state-warning-bg);\n}\n.bg-danger {\n .bg-variant(@state-danger-bg);\n}\n\n\n// Page header\n// -------------------------\n\n.page-header {\n padding-bottom: ((@line-height-computed / 2) - 1);\n margin: (@line-height-computed * 2) 0 @line-height-computed;\n border-bottom: 1px solid @page-header-border-color;\n}\n\n\n// Lists\n// -------------------------\n\n// Unordered and Ordered lists\nul,\nol {\n margin-top: 0;\n margin-bottom: (@line-height-computed / 2);\n ul,\n ol {\n margin-bottom: 0;\n }\n}\n\n// List options\n\n// Unstyled keeps list items block level, just removes default browser padding and list-style\n.list-unstyled {\n padding-left: 0;\n list-style: none;\n}\n\n// Inline turns list items into inline-block\n.list-inline {\n .list-unstyled();\n margin-left: -5px;\n\n > li {\n display: inline-block;\n padding-right: 5px;\n padding-left: 5px;\n }\n}\n\n// Description Lists\ndl {\n margin-top: 0; // Remove browser default\n margin-bottom: @line-height-computed;\n}\ndt,\ndd {\n line-height: @line-height-base;\n}\ndt {\n font-weight: 700;\n}\ndd {\n margin-left: 0; // Undo browser default\n}\n\n// Horizontal description lists\n//\n// Defaults to being stacked without any of the below styles applied, until the\n// grid breakpoint is reached (default of ~768px).\n\n.dl-horizontal {\n dd {\n &:extend(.clearfix all); // Clear the floated `dt` if an empty `dd` is present\n }\n\n @media (min-width: @dl-horizontal-breakpoint) {\n dt {\n float: left;\n width: (@dl-horizontal-offset - 20);\n clear: left;\n text-align: right;\n .text-overflow();\n }\n dd {\n margin-left: @dl-horizontal-offset;\n }\n }\n}\n\n\n// Misc\n// -------------------------\n\n// Abbreviations and acronyms\n// Add data-* attribute to help out our tooltip plugin, per https://github.com/twbs/bootstrap/issues/5257\nabbr[title],\nabbr[data-original-title] {\n cursor: help;\n}\n\n.initialism {\n font-size: 90%;\n .text-uppercase();\n}\n\n// Blockquotes\nblockquote {\n padding: (@line-height-computed / 2) @line-height-computed;\n margin: 0 0 @line-height-computed;\n font-size: @blockquote-font-size;\n border-left: 5px solid @blockquote-border-color;\n\n p,\n ul,\n ol {\n &:last-child {\n margin-bottom: 0;\n }\n }\n\n // Note: Deprecated small and .small as of v3.1.0\n // Context: https://github.com/twbs/bootstrap/issues/11660\n footer,\n small,\n .small {\n display: block;\n font-size: 80%; // back to default font-size\n line-height: @line-height-base;\n color: @blockquote-small-color;\n\n &:before {\n content: \"\\2014 \\00A0\"; // em dash, nbsp\n }\n }\n}\n\n// Opposite alignment of blockquote\n//\n// Heads up: `blockquote.pull-right` has been deprecated as of v3.1.0.\n.blockquote-reverse,\nblockquote.pull-right {\n padding-right: 15px;\n padding-left: 0;\n text-align: right;\n border-right: 5px solid @blockquote-border-color;\n border-left: 0;\n\n // Account for citation\n footer,\n small,\n .small {\n &:before { content: \"\"; }\n &:after {\n content: \"\\00A0 \\2014\"; // nbsp, em dash\n }\n }\n}\n\n// Addresses\naddress {\n margin-bottom: @line-height-computed;\n font-style: normal;\n line-height: @line-height-base;\n}\n", "// Typography\n\n.text-emphasis-variant(@color) {\n color: @color;\n a&:hover,\n a&:focus {\n color: darken(@color, 10%);\n }\n}\n", "// Contextual backgrounds\n\n.bg-variant(@color) {\n background-color: @color;\n a&:hover,\n a&:focus {\n background-color: darken(@color, 10%);\n }\n}\n", "// Text overflow\n// Requires inline-block or block for proper styling\n\n.text-overflow() {\n overflow: hidden;\n text-overflow: ellipsis;\n white-space: nowrap;\n}\n", "//\n// Code (inline and block)\n// --------------------------------------------------\n\n\n// Inline and block code styles\ncode,\nkbd,\npre,\nsamp {\n font-family: @font-family-monospace;\n}\n\n// Inline code\ncode {\n padding: 2px 4px;\n font-size: 90%;\n color: @code-color;\n background-color: @code-bg;\n border-radius: @border-radius-base;\n}\n\n// User input typically entered via keyboard\nkbd {\n padding: 2px 4px;\n font-size: 90%;\n color: @kbd-color;\n background-color: @kbd-bg;\n border-radius: @border-radius-small;\n box-shadow: inset 0 -1px 0 rgba(0, 0, 0, .25);\n\n kbd {\n padding: 0;\n font-size: 100%;\n font-weight: 700;\n box-shadow: none;\n }\n}\n\n// Blocks of code\npre {\n display: block;\n padding: ((@line-height-computed - 1) / 2);\n margin: 0 0 (@line-height-computed / 2);\n font-size: (@font-size-base - 1); // 14px to 13px\n line-height: @line-height-base;\n color: @pre-color;\n word-break: break-all;\n word-wrap: break-word;\n background-color: @pre-bg;\n border: 1px solid @pre-border-color;\n border-radius: @border-radius-base;\n\n // Account for some code outputs that place code tags in pre tags\n code {\n padding: 0;\n font-size: inherit;\n color: inherit;\n white-space: pre-wrap;\n background-color: transparent;\n border-radius: 0;\n }\n}\n\n// Enable scrollable blocks of code\n.pre-scrollable {\n max-height: @pre-scrollable-max-height;\n overflow-y: scroll;\n}\n", "//\n// Grid system\n// --------------------------------------------------\n\n\n// Container widths\n//\n// Set the container width, and override it for fixed navbars in media queries.\n\n.container {\n .container-fixed();\n\n @media (min-width: @screen-sm-min) {\n width: @container-sm;\n }\n @media (min-width: @screen-md-min) {\n width: @container-md;\n }\n @media (min-width: @screen-lg-min) {\n width: @container-lg;\n }\n}\n\n\n// Fluid container\n//\n// Utilizes the mixin meant for fixed width containers, but without any defined\n// width for fluid, full width layouts.\n\n.container-fluid {\n .container-fixed();\n}\n\n\n// Row\n//\n// Rows contain and clear the floats of your columns.\n\n.row {\n .make-row();\n}\n\n.row-no-gutters {\n margin-right: 0;\n margin-left: 0;\n\n [class*=\"col-\"] {\n padding-right: 0;\n padding-left: 0;\n }\n}\n\n\n// Columns\n//\n// Common styles for small and large grid columns\n\n.make-grid-columns();\n\n\n// Extra small grid\n//\n// Columns, offsets, pushes, and pulls for extra small devices like\n// smartphones.\n\n.make-grid(xs);\n\n\n// Small grid\n//\n// Columns, offsets, pushes, and pulls for the small device range, from phones\n// to tablets.\n\n@media (min-width: @screen-sm-min) {\n .make-grid(sm);\n}\n\n\n// Medium grid\n//\n// Columns, offsets, pushes, and pulls for the desktop device range.\n\n@media (min-width: @screen-md-min) {\n .make-grid(md);\n}\n\n\n// Large grid\n//\n// Columns, offsets, pushes, and pulls for the large desktop device range.\n\n@media (min-width: @screen-lg-min) {\n .make-grid(lg);\n}\n", "// Grid system\n//\n// Generate semantic grid columns with these mixins.\n\n// Centered container element\n.container-fixed(@gutter: @grid-gutter-width) {\n padding-right: ceil((@gutter / 2));\n padding-left: floor((@gutter / 2));\n margin-right: auto;\n margin-left: auto;\n &:extend(.clearfix all);\n}\n\n// Creates a wrapper for a series of columns\n.make-row(@gutter: @grid-gutter-width) {\n margin-right: floor((@gutter / -2));\n margin-left: ceil((@gutter / -2));\n &:extend(.clearfix all);\n}\n\n// Generate the extra small columns\n.make-xs-column(@columns; @gutter: @grid-gutter-width) {\n position: relative;\n float: left;\n width: percentage((@columns / @grid-columns));\n min-height: 1px;\n padding-right: (@gutter / 2);\n padding-left: (@gutter / 2);\n}\n.make-xs-column-offset(@columns) {\n margin-left: percentage((@columns / @grid-columns));\n}\n.make-xs-column-push(@columns) {\n left: percentage((@columns / @grid-columns));\n}\n.make-xs-column-pull(@columns) {\n right: percentage((@columns / @grid-columns));\n}\n\n// Generate the small columns\n.make-sm-column(@columns; @gutter: @grid-gutter-width) {\n position: relative;\n min-height: 1px;\n padding-right: (@gutter / 2);\n padding-left: (@gutter / 2);\n\n @media (min-width: @screen-sm-min) {\n float: left;\n width: percentage((@columns / @grid-columns));\n }\n}\n.make-sm-column-offset(@columns) {\n @media (min-width: @screen-sm-min) {\n margin-left: percentage((@columns / @grid-columns));\n }\n}\n.make-sm-column-push(@columns) {\n @media (min-width: @screen-sm-min) {\n left: percentage((@columns / @grid-columns));\n }\n}\n.make-sm-column-pull(@columns) {\n @media (min-width: @screen-sm-min) {\n right: percentage((@columns / @grid-columns));\n }\n}\n\n// Generate the medium columns\n.make-md-column(@columns; @gutter: @grid-gutter-width) {\n position: relative;\n min-height: 1px;\n padding-right: (@gutter / 2);\n padding-left: (@gutter / 2);\n\n @media (min-width: @screen-md-min) {\n float: left;\n width: percentage((@columns / @grid-columns));\n }\n}\n.make-md-column-offset(@columns) {\n @media (min-width: @screen-md-min) {\n margin-left: percentage((@columns / @grid-columns));\n }\n}\n.make-md-column-push(@columns) {\n @media (min-width: @screen-md-min) {\n left: percentage((@columns / @grid-columns));\n }\n}\n.make-md-column-pull(@columns) {\n @media (min-width: @screen-md-min) {\n right: percentage((@columns / @grid-columns));\n }\n}\n\n// Generate the large columns\n.make-lg-column(@columns; @gutter: @grid-gutter-width) {\n position: relative;\n min-height: 1px;\n padding-right: (@gutter / 2);\n padding-left: (@gutter / 2);\n\n @media (min-width: @screen-lg-min) {\n float: left;\n width: percentage((@columns / @grid-columns));\n }\n}\n.make-lg-column-offset(@columns) {\n @media (min-width: @screen-lg-min) {\n margin-left: percentage((@columns / @grid-columns));\n }\n}\n.make-lg-column-push(@columns) {\n @media (min-width: @screen-lg-min) {\n left: percentage((@columns / @grid-columns));\n }\n}\n.make-lg-column-pull(@columns) {\n @media (min-width: @screen-lg-min) {\n right: percentage((@columns / @grid-columns));\n }\n}\n", "// Framework grid generation\n//\n// Used only by Bootstrap to generate the correct number of grid classes given\n// any value of `@grid-columns`.\n\n.make-grid-columns() {\n // Common styles for all sizes of grid columns, widths 1-12\n .col(@index) { // initial\n @item: ~\".col-xs-@{index}, .col-sm-@{index}, .col-md-@{index}, .col-lg-@{index}\";\n .col((@index + 1), @item);\n }\n .col(@index, @list) when (@index =< @grid-columns) { // general; \"=<\" isn't a typo\n @item: ~\".col-xs-@{index}, .col-sm-@{index}, .col-md-@{index}, .col-lg-@{index}\";\n .col((@index + 1), ~\"@{list}, @{item}\");\n }\n .col(@index, @list) when (@index > @grid-columns) { // terminal\n @{list} {\n position: relative;\n // Prevent columns from collapsing when empty\n min-height: 1px;\n // Inner gutter via padding\n padding-right: floor((@grid-gutter-width / 2));\n padding-left: ceil((@grid-gutter-width / 2));\n }\n }\n .col(1); // kickstart it\n}\n\n.float-grid-columns(@class) {\n .col(@index) { // initial\n @item: ~\".col-@{class}-@{index}\";\n .col((@index + 1), @item);\n }\n .col(@index, @list) when (@index =< @grid-columns) { // general\n @item: ~\".col-@{class}-@{index}\";\n .col((@index + 1), ~\"@{list}, @{item}\");\n }\n .col(@index, @list) when (@index > @grid-columns) { // terminal\n @{list} {\n float: left;\n }\n }\n .col(1); // kickstart it\n}\n\n.calc-grid-column(@index, @class, @type) when (@type = width) and (@index > 0) {\n .col-@{class}-@{index} {\n width: percentage((@index / @grid-columns));\n }\n}\n.calc-grid-column(@index, @class, @type) when (@type = push) and (@index > 0) {\n .col-@{class}-push-@{index} {\n left: percentage((@index / @grid-columns));\n }\n}\n.calc-grid-column(@index, @class, @type) when (@type = push) and (@index = 0) {\n .col-@{class}-push-0 {\n left: auto;\n }\n}\n.calc-grid-column(@index, @class, @type) when (@type = pull) and (@index > 0) {\n .col-@{class}-pull-@{index} {\n right: percentage((@index / @grid-columns));\n }\n}\n.calc-grid-column(@index, @class, @type) when (@type = pull) and (@index = 0) {\n .col-@{class}-pull-0 {\n right: auto;\n }\n}\n.calc-grid-column(@index, @class, @type) when (@type = offset) {\n .col-@{class}-offset-@{index} {\n margin-left: percentage((@index / @grid-columns));\n }\n}\n\n// Basic looping in LESS\n.loop-grid-columns(@index, @class, @type) when (@index >= 0) {\n .calc-grid-column(@index, @class, @type);\n // next iteration\n .loop-grid-columns((@index - 1), @class, @type);\n}\n\n// Create grid for specific class\n.make-grid(@class) {\n .float-grid-columns(@class);\n .loop-grid-columns(@grid-columns, @class, width);\n .loop-grid-columns(@grid-columns, @class, pull);\n .loop-grid-columns(@grid-columns, @class, push);\n .loop-grid-columns(@grid-columns, @class, offset);\n}\n", "// stylelint-disable selector-max-type, selector-max-compound-selectors, selector-no-qualifying-type\n\n//\n// Tables\n// --------------------------------------------------\n\n\ntable {\n background-color: @table-bg;\n\n // Table cell sizing\n //\n // Reset default table behavior\n\n col[class*=\"col-\"] {\n position: static; // Prevent border hiding in Firefox and IE9-11 (see https://github.com/twbs/bootstrap/issues/11623)\n display: table-column;\n float: none;\n }\n\n td,\n th {\n &[class*=\"col-\"] {\n position: static; // Prevent border hiding in Firefox and IE9-11 (see https://github.com/twbs/bootstrap/issues/11623)\n display: table-cell;\n float: none;\n }\n }\n}\n\ncaption {\n padding-top: @table-cell-padding;\n padding-bottom: @table-cell-padding;\n color: @text-muted;\n text-align: left;\n}\n\nth {\n text-align: left;\n}\n\n\n// Baseline styles\n\n.table {\n width: 100%;\n max-width: 100%;\n margin-bottom: @line-height-computed;\n // Cells\n > thead,\n > tbody,\n > tfoot {\n > tr {\n > th,\n > td {\n padding: @table-cell-padding;\n line-height: @line-height-base;\n vertical-align: top;\n border-top: 1px solid @table-border-color;\n }\n }\n }\n // Bottom align for column headings\n > thead > tr > th {\n vertical-align: bottom;\n border-bottom: 2px solid @table-border-color;\n }\n // Remove top border from thead by default\n > caption + thead,\n > colgroup + thead,\n > thead:first-child {\n > tr:first-child {\n > th,\n > td {\n border-top: 0;\n }\n }\n }\n // Account for multiple tbody instances\n > tbody + tbody {\n border-top: 2px solid @table-border-color;\n }\n\n // Nesting\n .table {\n background-color: @body-bg;\n }\n}\n\n\n// Condensed table w/ half padding\n\n.table-condensed {\n > thead,\n > tbody,\n > tfoot {\n > tr {\n > th,\n > td {\n padding: @table-condensed-cell-padding;\n }\n }\n }\n}\n\n\n// Bordered version\n//\n// Add borders all around the table and between all the columns.\n\n.table-bordered {\n border: 1px solid @table-border-color;\n > thead,\n > tbody,\n > tfoot {\n > tr {\n > th,\n > td {\n border: 1px solid @table-border-color;\n }\n }\n }\n > thead > tr {\n > th,\n > td {\n border-bottom-width: 2px;\n }\n }\n}\n\n\n// Zebra-striping\n//\n// Default zebra-stripe styles (alternating gray and transparent backgrounds)\n\n.table-striped {\n > tbody > tr:nth-of-type(odd) {\n background-color: @table-bg-accent;\n }\n}\n\n\n// Hover effect\n//\n// Placed here since it has to come after the potential zebra striping\n\n.table-hover {\n > tbody > tr:hover {\n background-color: @table-bg-hover;\n }\n}\n\n\n// Table backgrounds\n//\n// Exact selectors below required to override `.table-striped` and prevent\n// inheritance to nested tables.\n\n// Generate the contextual variants\n.table-row-variant(active; @table-bg-active);\n.table-row-variant(success; @state-success-bg);\n.table-row-variant(info; @state-info-bg);\n.table-row-variant(warning; @state-warning-bg);\n.table-row-variant(danger; @state-danger-bg);\n\n\n// Responsive tables\n//\n// Wrap your tables in `.table-responsive` and we'll make them mobile friendly\n// by enabling horizontal scrolling. Only applies <768px. Everything above that\n// will display normally.\n\n.table-responsive {\n min-height: .01%; // Workaround for IE9 bug (see https://github.com/twbs/bootstrap/issues/14837)\n overflow-x: auto;\n\n @media screen and (max-width: @screen-xs-max) {\n width: 100%;\n margin-bottom: (@line-height-computed * .75);\n overflow-y: hidden;\n -ms-overflow-style: -ms-autohiding-scrollbar;\n border: 1px solid @table-border-color;\n\n // Tighten up spacing\n > .table {\n margin-bottom: 0;\n\n // Ensure the content doesn't wrap\n > thead,\n > tbody,\n > tfoot {\n > tr {\n > th,\n > td {\n white-space: nowrap;\n }\n }\n }\n }\n\n // Special overrides for the bordered tables\n > .table-bordered {\n border: 0;\n\n // Nuke the appropriate borders so that the parent can handle them\n > thead,\n > tbody,\n > tfoot {\n > tr {\n > th:first-child,\n > td:first-child {\n border-left: 0;\n }\n > th:last-child,\n > td:last-child {\n border-right: 0;\n }\n }\n }\n\n // Only nuke the last row's bottom-border in `tbody` and `tfoot` since\n // chances are there will be only one `tr` in a `thead` and that would\n // remove the border altogether.\n > tbody,\n > tfoot {\n > tr:last-child {\n > th,\n > td {\n border-bottom: 0;\n }\n }\n }\n\n }\n }\n}\n", "// Tables\n\n.table-row-variant(@state; @background) {\n // Exact selectors below required to override `.table-striped` and prevent\n // inheritance to nested tables.\n .table > thead > tr,\n .table > tbody > tr,\n .table > tfoot > tr {\n > td.@{state},\n > th.@{state},\n &.@{state} > td,\n &.@{state} > th {\n background-color: @background;\n }\n }\n\n // Hover states for `.table-hover`\n // Note: this is not available for cells or rows within `thead` or `tfoot`.\n .table-hover > tbody > tr {\n > td.@{state}:hover,\n > th.@{state}:hover,\n &.@{state}:hover > td,\n &:hover > .@{state},\n &.@{state}:hover > th {\n background-color: darken(@background, 5%);\n }\n }\n}\n", "// stylelint-disable selector-no-qualifying-type, property-no-vendor-prefix, media-feature-name-no-vendor-prefix\n\n//\n// Forms\n// --------------------------------------------------\n\n\n// Normalize non-controls\n//\n// Restyle and baseline non-control form elements.\n\nfieldset {\n // Chrome and Firefox set a `min-width: min-content;` on fieldsets,\n // so we reset that to ensure it behaves more like a standard block element.\n // See https://github.com/twbs/bootstrap/issues/12359.\n min-width: 0;\n padding: 0;\n margin: 0;\n border: 0;\n}\n\nlegend {\n display: block;\n width: 100%;\n padding: 0;\n margin-bottom: @line-height-computed;\n font-size: (@font-size-base * 1.5);\n line-height: inherit;\n color: @legend-color;\n border: 0;\n border-bottom: 1px solid @legend-border-color;\n}\n\nlabel {\n display: inline-block;\n max-width: 100%; // Force IE8 to wrap long content (see https://github.com/twbs/bootstrap/issues/13141)\n margin-bottom: 5px;\n font-weight: 700;\n}\n\n\n// Normalize form controls\n//\n// While most of our form styles require extra classes, some basic normalization\n// is required to ensure optimum display with or without those classes to better\n// address browser inconsistencies.\n\ninput[type=\"search\"] {\n // Override content-box in Normalize (* isn't specific enough)\n .box-sizing(border-box);\n\n // Search inputs in iOS\n //\n // This overrides the extra rounded corners on search inputs in iOS so that our\n // `.form-control` class can properly style them. Note that this cannot simply\n // be added to `.form-control` as it's not specific enough. For details, see\n // https://github.com/twbs/bootstrap/issues/11586.\n -webkit-appearance: none;\n appearance: none;\n}\n\n// Position radios and checkboxes better\ninput[type=\"radio\"],\ninput[type=\"checkbox\"] {\n margin: 4px 0 0;\n margin-top: 1px \\9; // IE8-9\n line-height: normal;\n\n // Apply same disabled cursor tweak as for inputs\n // Some special care is needed because
^ViB2&_DtcdL^I-|a!&-TsYlD=6C z=0Ps<20HW|>paAlq>H*@DaFeGbPNJ2cZ^L7X<&pX5^zvWUaU=y)d3^BL?)bLsMrzV zh6a$fwQ%`_-~twP#RA0Z`sWStBu(&RO2kS98shYItcLKHmfQr~ z3VCD(mZXSz7j?nAG1oJM%?#64*p%9Yr0u3-7<%(SLtDG)G&^bZ@9HvZQ3RBejtX9c!V=9~KOZRkcNBo|)9#pr#t4lP`RDX!frgs++ zHnJg%Ay&ZP)=~onFR9P!6m}Bf-cGO~2Y@Nio`*JVVA13Y@>n`G(3pSXpTW-4Dr_NK&prlXP(GyZGUc8 z)NyOm8q_-?R!7{$(_yeQBCB3O%r`J5*2ybWjChs;>NaH22!FK zNbSxH3=M2a7qLSKKgGU5yqWu!^yNbt2>f;=LvN-KI*Yj->1<(h3R|;1CcT^6p>VK} zH5A0*ZYwxfkHyHY8A8_NU@c9bGn8YrOrZl654|m@M79U}8t5?1#Sg|NZ*G_5y^3us z@ow%%Qz9IDIfg1^xYYs~!^LUco$ekgrrWcjRjUW;h{bsend=BxP`kJ1b6E^G=w}Gm zF@T7Co3U*E61in4Tg(ik)xW$g?6(y=y1G`Wt=5Kt;L4G1PL_vsSUmrRYkfBLs?psI2sk9hpI8T$RJ2 zMOCQRru44L0c2+V6_c=gDm4VQ>h8*6tFYr+ImGf8-DNA!RAyv3dJD)pjX5 z=v70#y_KTJHX_PWRkn(k7pnAKj^CKN48mPmwi`28Fv`(wS?mbAV+Uo4LjKiKC{Nnb zpGj3fw}BqB#SXCgG`6fNL;&Gcz-|WD25(Ej4j>$yl^{yDC5@wvNWXe}x_ifY+cP*Jf$5h<@9LYCpm0|ZY!>2xM2frx&!6!< zyO^2A>j1}0Ytiq-N%(i^YXr zs3UeoG(umLn%ncrKl`yw5r$?UYjOdNA*B;qaWG;yj8|~k$!Li5ZVLJ$hU=e`+oer0 z1dmC;mXyzIqncvHdo-_os91oY&q31#6z-y|q>AKz#A?)BIGU>po1(KoT;yMNHiGmPEI3nuyIc9kcNexyj4aF=cvSOE8tuj&rF)|^d$8E zMO|H4;+WG$bbYEX4Xs+=c5A0~clY*G7I<%DO&SsjDQ}tmt@$o6Sf>~kHN6Pb33J2QIVraZY$2;hzmEDm3 zg~41wa)c<5&)~R@;9+1$7p{BBQ!VDaJSHt9N9zUkWFsGlgi*QmW5c)0j5Mm_n@;de za08T0s{px?6ecRAv`k%&pw$Nx7Y=1XBSmB7M2&jbFP=uK$;DjeGU4{3AA^%Ew7k)- zX7krAOh0D9%cmekvozA26eA8|U@S@xY@?uz{m9--x+e??MPBxYV3B`z4U8_>=h&$j z^jjF8+!PkORDXzBi=AEZ3}VYt=$+hv(s&ppu3c*n#1w8*hW{6YdEx|L+cymajeQR)|8;7rsANGKIC7e4!|A83{EI=wMhk+hz?1CTnrvBHLIV#9AEM!knk4t*{Y0)|q~~ zGoG6nI|Bm()Y4#JC&k*=Psj)yPAOI#o*W>4oa%Oa&f?cBt)viQSR1uU=#Y8d$mve{ z!eYuI^Y-Ac^*V!`gcXMR`s4&xSb~_ILLXVMcsSof54OU=STzH8*brPHOy%q&QpeD< z&00-NxN1oP*z$A@3zN60xkLQx(nVpY;@Rm=$D8)vF!q{sH|8URY8Ss<)c>tCsq_zf z_!5j*T_p{;(ttR)I*21WcOc##bP-SDLroQbr@w8e7`CzutFqvx+#2j<$^nV87&QU!JOiWOIo7-IKsRT)#fFbq=~7k9W{E52^` z1&jK0k3igFl@V84VQm2iHoyZ4VeVn=SIH4~@;Pw=313b0A2Etc+UMR89&19TcmCx<^v_g(a>KpC6 z?y5BU)XLf_W{MpHr@0Mh-fA!|x`nS~cVfn*@ClHIwEDh7b=x3l%#uzu1(Lbc*_xZg zADtQ&uj<2V^(?AJ$VDF`f&Z6%pk!j_pj`}}iI(cpnudAYmgRmCaBad7u>A0pYPgdY zNk|Rq#8Q(V7R_#yUiOrCoT$;I2o;lYae^R@KS`iS`X!FEw1I- zvMc8YY)lPrOS9XexMC}fqrgU24;6~Jfhd-%$yu2m=)n;_%n%&aL&KWHEaS-5-7qH8 z{vRcGZCDF6;9T7tC=YDQ>e_;oss0gTp$pwcL6n79E|98V$G$Tcg}L3$jgZ=L2G9vD zGG9t@oWP|xJH(}EE;8Y|6wkE+8s-WfMJNt$!Eu5@6kQHW*~OC*xEHjxAEx>!rcO&) zOtz%^Q@h3Gg}W}+P3>Zo5ThJHA!1NVKJVkWjjBgSqj*s*@i}SM%fRXvtS8#P4f1@^3r&S%+p%gG zoUt<}FOe3tM%O}Ym#t7b-q%;_+%lDkoCl`gJww6O*vK~dlie~mLbEaPC;+Y7DJ1z zrVI60tiRxEiVO|>I7CclumLM^KYEl0COUI|OtJK8B8VQ)s?`l8j1;CG5HaVbdMNFy z3*4{EZL-RcgdP$lwp~;q;kY9QO#^$WI=rTe*rnK=R8>p|BnntAqTx{kbT}p^rr8^N zvbc2Q%ueNXQL;=Sa`!mHfR#jG9Kv8hs~%-3cbc4&`x~so2~&}EywD)0mJxwwEa?0s z7&zEvkaIJ;(>)zH@?f^{%!Rmccmz_lINjQs_UX)?iGdKbI=`WJlu90|08A4vdBA9S z9>S^V${)j_+Rl`Wfr^2Zx?K>KScO!z(1X#Fq9z=O{fINie_!cQjO)M?h z9%3v>&?y8?hn@2@!0;1l2?Limy#z%@(8FbVGzwG6;2_*m`SRR)P7OUA$It`&&friH z+p5my8ioi_lgIKrKD07QOKn-0nh`&Yl;*eXEP?hEO7G|?F5x6bXDr&tvrdcyQF+vG zyTc@Th59oHOU&rZpvNiIK9bGxg{koLlXP+A5X|x3OdoWk%E3KqMZtFaN& zViOiLYac^quval4Zp&)0lbRty2VD3qo0m5F{vrQMY!``|sB?#FoI|j5(1Gv8V0suX zz?Jn(PXn?_-9c<$f_ta)uC&*hH}zw0>oS%ntZQnqrIzlT(H4rs4A@9*h4a$={jf?5 zqSRz5!7Fq^!z(IHh9}v36 z!8uU3>EksJX7f;CJIv0-?FK>ykf6-)WR8q@^K^$qEAnObVn0uzNk(lT!Sl1 zwxdT{3f-BE8O%6#g<&x;5Gjva1xX#tz z{1eizc4wh%nAondoONdgYlg5!^I=!oGOgr}hiG&>2!&WOzh>Kz~&PaC* z4{Xcz%N$UCv#VpjG(%33N)i(tZ@ikDe@MLoT{b%#Il=XNboGI zY?vYvr5BbZaR@=Xh_baIXg_&`&9HD?h#K!)Pbd?@5<=wz z3M~drPbpD(jjnN0Rw_rt40^UZ&GQ;ONv5c?bD6C4rXIyK-EtyRF!4i}(#Itz*4QpC zSkG`UG4${_qVs@usGqqNCB|ah*lxk`X^n+-BJ!|+XvYN~Xbo)ZNqLC=QiSSZYD)3q ziCuu(BOY#R7T<+=ek+Unx&?YxPhF4rWf(UFV<{@igiel>nSw4>sZxFJM2Pjt=@4~W zF;N$w%oQ=DwNu1z^cZn+ju_COd<|c$#aB)lD~OW3tpkj4D@++Yb`Kr~ALY@~_%`my zH+z_r<~B+U{{U0GvFTp>QLq1jFKAS*JBrr0X#3E^iFEGyA)bXAvWG6FaN^W`L1@;& zM2h2_pJ8(7tnbBT$0%_HiLV+Dj8;{^^2+iNlpI z^e{WiZ$jLlJ@stbVB$lCgkj6sSrct2@fblo?5yEI7+Yz9FAIuxWy*rWTWQKduyv8n zQ@bk*p)gp65;RH?6W8&w(Lh}A#)x#k5HMow*#9CAj)710^ti6Pl`*aRGeT-+9il!cYOulsSB&P!zERG;5Y?)I9~j!Yw9Qp z!U<3yLt&SKw7Pl>2dM~$HljGPI~jSE6GwiRuZUR@+U8t>P4kq4lr$867Ekk03*9zvYo5&A50Gua)Eo9xQ*44JtgGia!>+H=0)MQMg&WucfF7&M!6 zgCj4+uR(zBM1HbVnH@V(c=~du3gS%D<)MuO_CkKkmp9wk3SL&B1f!oEYJV%n|HRJ6 z>p?sH5W(U_mW^SoJ<<Sy93fY17VJ3no7s!-NBvYMg< zw2p?DgEwkP%)c?~5}THvCC|nC@h=Z=&f|S0t z(swB9=!_J>LevlIFGgQJSuMy0WW`#9qqP}(RvX!h_=nXL=ci03^cd>|SqVnvLdSMd z^_@6voHuPUg+nivl@!jYx}~pjgasysV<@N&J{kcGc`@ubJTaQbag<6IwZWDn7wgDw z_F%4`qMr`xS#qK_k4*)B1g_d7vVp21ANpbtNtjsO4aiU4vbf8^aIB8Pc;!4}9%Z1$ zdWovuiREML+GYdV^dy$`QF@6XY;8+$VeYmMY-*7QtlJK?y%YjkF}u(Cw86Uiqdnvl zVvXXld{~Uc2#0qVp__ZbdBkkf!7$YQDG|ufn2dX~SFC$bgF=2Qmjj7S%S!IyjX?${ z(e>^ip)6h5k&7PYdmR@Gv7z$226bpB2oKh&Y@OVIx6WNWlZ`;kYLGCUuQO9^z;21+ zw8g!$=MsxR+K$JObMkRiCp$Qf(!%37s18;gj^oLAh6dv}wM~Gb#A?I(aT6$pEXI5g z0i))*PSKAPBRu<+cXCA-#*AaS-8oaSDX@jg@i_{^F<-CP^N4pJt-;})OU2iBzK={g zhM<}pLtvIsB#+_PW@T@VZBc4qp`v;E1@NPXSX!MJag_FC443vZ;oTFigtRS5sKsrt z8+&?<6$^2YTkT=)5Y<+?GjBS}F~|ctGISZ}0A-<8CN9IX;bllDKWv6G*I-YpEQ)2% z7<^qL%41kMD@&P$^*`2Ll0}DIHE4M*3$zr*V|TGImJmaLZe#wU->v+>05UrkGq*y) zEe0YFA&W;TlD6+s92Ddsd=cg@3>OAo`SWgTJFRpds%$p8>({)@+Pq~Hm1GyjFf#Zt z46P>EU_uX-MK0~$iV?gnE(>?v>>WnM^r;xF3`y2khExKNtYqa8M9M8gb8Kxzxg}WA zDJt8Sp`-KOWkDW=#yV5$Cnw3u(r8$8ZC6=@Y-zoe#$p9TR2D-sFQKy-Hl)57R>bP^ z$U>H}h*3Ak&?3RbFx>cdv=|HE$9FMA)cP12xADjYh-RqL2l%?F!B6pJuBfajbHh3* zo`?Xd>ZrqNrq(Blr*mUgS|`O*>x3@B!!Oo{V<|f`xgqD(4FVgMldlpAtA?#VrG;~4 zk?joZPGD0*D!Y+88U_YbK(ST9Fp@98!+i_9>2;mtwhgD&HoC_};?DWp*`aOC^^O;2>(9J$M$t0;nYU%Mj> z*;X3BAeCmjhbsoE9x3LD%BjkNT-M&*na-dQk#Kln6wZf)9B;W5(s)bM@=j+goF9FD zuwn)7nUcLiut@fQDAhR||ET#^Djqf#@77fRWQ>TWA`%oDAj^ka1h2IcWZ(9LPKE9N z1_qOF97GenE-UE|?`}iet?VTl-ED_a8IYda$dfFsS`ID96eL=@94auFsj zX-D|deTaDWw2H{~x%{S2f%}7x>?AUhGFXT$Hu~JY}W4q49 z3oFJtFP2|BHf?z+6pu8jS)5iTth@zl<;AztxT#C52|iXCX((V@3!CXIx4IcComU89 zWe>*q&MF;LJlpz%jthYu8#g2VfRCsO(4P(z&GrvACi;g8IFwSMsU`hYA%-Xq5Vk4= z>9-Y5Xp}9}3bAZ0WHl&M2!~=Tx7Jh$%9VY!r=NGbVeP{j;9oH$>qQJ9GKPyT1{9}u zIV2S%=iaG5kOWJK({N>@0wRVO6~QwkKT@%WBN=<%ZPe*b(<2pTXB|0*4SvFm;)bNr)5klNh zLxYvBj{B`5f-sJYNQWw1(co(DIy`f7+9bGe9ULXxSv zQj*b#8R+$t1-AgN$)xZN6wX_A7i2oiWhFA|;?#DKGvtr~yYg{~bp|?jY7SmqbP*T9&883LiYN%eM@qF9>lKmsOfh26DJFX!y zbA#y8ow%B$ESNSXe87|s!}IPEl7jFY$b`_zVY9WjgXl;rHo~EPh!y!OGj@a1$;#q! zj{-NtTVdIyas|@l)*^Q^-Gv|pm~i>k9Of>qUj-u*6~_j|!>+Pg;G2_hau_1(r7Oyv3G3fXQM>>29^k$MP=h+uN000pSW4 zC4kO=X-r8TEgoU#H;SDeeYJ=pjyNZ@8={C9zC5cpVuG!_X@JrL&tk?dUbXCpL8W)H zdO;vsoh}|uCs%mqs27svcXQq7SiRrV3qd}Xv^}I9Nl$Rmh1y9xp-HxbmtYj|YXjW0 zvL5Pj*mF{1EZ~5&_g#Cz$UYbc8AKq)v>xF(@IntF0dl3^n$7EPhlPP84LOBe9t6dS zLYB+M5|8uB!o++bk8$3I=M4%5hcI%xJijoKg6WBFDJ9P>cw47Z$w*>jr(oKYd>|=2 zs}e4rkl&rz?ocNup)T>F5_*T6IC(`*^UnofZpETt_(<;IZXp`tJ{~ILQt<^L{HREm zBwy>p*FTDMdZKE4f@XbDA&$QO)`WbGD4TMabLv4Al?PbMWr61>LN`J~_kbSuFBmze z#%aSd7_wbyahuX?A5Q!^EGdQi*C?$lOk^&QB+jHF*wI?#hwiHZh&Y;{2t^cxLa=2dE zCm4Wm+3N)Z?XHbCFc?T3fE<&G7d46)Q8~n8QKI(B-ZB$COCHgni`U!B$u zp`b&^*K|%S;O=sR`+TUO)qU`bl_~x`u@|BP>mj1EogUJ%t4Ln+!ytv}=7lo~c!5~D z^EuIlpbufGz9Q)RG6?-2K9nQJZ{Q6E4+A-70yHAPyl}E%R^XG z2hW6{C$Y8($%ca=T@CGfh{tZc;Jo*1BVY&0L+}-bJ+K%GJ)x8&0%92RK+(z#Fmn1| zIJ`$6Bd>v_O1P!&iZ_U=99%i5)Tl;=0FLhq40`cOAw0P&a)xJe8zqTSWe1L27hNup zKeIhJW{5t=$A5AnQR^=3QJvf%R++CgzWC~q4_PIg)0=|2{|$y^uhwQZviWQ$w_8my zk5c`(#{+^E#2*?WpzKD0SeZPZmw%k~hlY5~o$IoPqJgjk720CFXvKJ{Zns@H3WF2V zn&r`>L}TGj7#t-U2Rj~>RXWIoK9!78hOEr-xT49%Q9YiFs$E+79^1;+btRVy*WLfIbD+Q8lA(mAR6rrzDs&b9N+B8O~zNh?z zk<0U`6suEy6Wo5zA=)0l7{g~OstQ7=E--K)Rm8|T6QQ2<^`$gxwqKL!%OD~f?gX`X z2x-U4kOg7Vp$GFAaxbnthO$AWQ>m6pu(K*jwsC|Xs+1=7Cm9yEBSJx1@3awCXBQJ^ z*k>_v_TNVoyKF3yMHJw1FV8NobAmhESO-y|PKaiZ@pb!FP4}S0bPq)s>*X&DV8&P< zSfrIcEn+(^y8vb6V8I!-DA*_PDPRdQt%b^VkSFJzm0?xvw{Y$VskZ{Ra>7C%vb$MQ zf9&y~_Qh0xI{YLP!zjwU2IDBNEKpofR`aE4^BB8)|lI${WP zfDOWNMI;ybrgb+~8-6uIRo>b=qCj!4+>Q%C#|i?k3Tk-d0Z$kg+SAx@9GumYS{yU|>W zA;mB<>MqxILogV0&YWWU)4lAIo-Mos#mG%4{Njwl5<$r3{rCHwr^`d76Cy5TC+Pd z_;C|)E3Z|)Em=Euj?Et2^DMG`h;j_xg!{ErmF1`|kLTIbc53mDyya>GY|ye6g!{qR zemt1{U|s7fa*WsMIP1EtjTPIekC4%q zh24w5e4@oj10*XqT@)1^D6@Vm>28>0&Pwk_ClRuN zl>c_CiXblChbB%g(9mEUCP+aXB$hgfx-#NNUGy?|HA#w$jNj~o4N|h-jJ@W}ZYr33 z317lzGjJC4C0|CZ8ny?!WQ43cI$q0jsv3g(FctPDM!D#6+==ffSS9A1ODOG-Z z+TgP!`~yz?vFKLs21BNi8BIsb)V9-(#7}yGJT7k4cNyl_P-ve>uR0-a z2k`zTqF|Mg|$Dk6Wh|6y`@e9Q+EWcZ8EAy!x-K5P7Q#8Y7P+S9M z$Y9q1xNYK3!PN&>77tF~neJF@{9di;1s1nKAq_69gKLIK0ruGU3<-t!fz-VS>4wWp z&q--nvktx}=T2J-b4&+ZtOb6h$TXNWW|i55diCSqtZp?}kP(7kJqBbsMU*?k)3RpiI+?aVI$6G6X!jY4YYW$Wr{pAg3FjIG*0~>{5XB7zA>&v z=9nBP<}zSemy&v*2RRO-hNOuZVO=wrQ-i1zXQ|GI zO0!+c7}trq_8~2Do1?SO-FgK4B*50vN zIrJ>+i)}dM(q}f?{z{v8ZUtkGD_YJ|K7SFqfOXJ*?J?~hm3IJNK0nAihJY7NH;!Y* z8H9W;Zn5=buf=&6c`o@dN3tzehR#F$;5%|*Dz<+HU@xGnwe;$qe`dFm+2m|y=OR0u z%p4Z&Ze^k@h{VR?1`(efM8C2sR*fl$(R2(~){wDeMTSd)n1OtAV4pJ#2}fg-cuAg2 zg&!ps0@plQ-Zpd&34x(A%=w5rfLg9WE=4eTGHo#9))s`31+uHSs5tWS2_-MBaEnfb zE}5x4qLai;FiwCWsTs;SWu$T{6$BDsr)89V<^nl(fW8?do#CRELx7I9BXM z#|X^yh)q`{!Refk(WGD;P7wAuS&o?)4>vP8V!IK}#UGbmB7V1!FsBZC->i0QAs$m( z8;?th&?QNkoid`iApd#jol5jX>S;s$n3B{>8YT0J1Q5~y>%um0=~e0>O;I$#M^?tn z8Hpv7Fz=Zo#S43PopW)1#78+A{mSDUW2@6R;t{*`81ZqA8CDEE(O*c{p>DXodPOdI<~-dN4Y45|48MnOhX2v>;^=)kVIEHjLe4Mpz3aaF)gO$g$rZ^ay*OL~@`pG<&Y4V5EYCR(PbUa7}VT&NeiGjpHI% zxd;ta;v$dLyjdwtQ?$!G26dVv*?3n$JekFLTQ2ORg+r1b7qD*3H5ZyLbCFqKE;jSb zT(i3YPlFH5FGxLL3e^l zBuKR(2e%HW&_bee9L41^AF)(1GfS1ra0K1z7}be&=i2JhN1~6J>Tr>?V@`?Om2-0w z9}J>uo-v23xX4wDEvD=OIyi-NFmhcOk0~T>$42yCKhjc2Q!3?@R5h1*W~8@B%^cP3 zNJXfv)gD-go`@zn$`^^Dly&)3=z1kqlRf+A81gU`!gL9RodVUHg9@=gvho7_PA-mw zFrUjP=P1vGyhZczb8wB>C5=`dphN38LPS)N-n4%({_6*avYdN1wEbH6RJ-;E*xQFqoR5c2JSz>z7NLDZZ{SCew+&CVOHD zT=6Q4NGfPEf377dJK3TUasBBp*tEkqVE}8+de?JYa~Yp`v1E>puD03^6}gCw_m5+( zr(wmK0fw{!X@lAsfEQv~T#U8QO;a)xvQm_Kq7&iV#2_UN;-B;quEyh{322s;+Hzpp zMg2&H-N;cH8~d6pw;ijlvmuyzSH4WKJx_8zR#KK(werQ)2^LJ@)GN-tO1zzNoywKe zP?#T=d!5m$hmf1;vhPeSoP8t}rif->MCOinLiS%;c}1zDK1Vr$18k)HmJxoUViSj# z9G3&EB90O%r;KU}T=qH1E9fs1*(O(en3yJWdT{7;!ht`pY(+k70apT@3M#N^Da5ku zNF2~wg^K-=YDCyrn(v;6)=Fn_DbJ&ORU&ip472RT!?#wSs;c8Mj?Tyk@iP!$pjstz zHh*Y21C-LEE-YWfD|LCB*&r!#z>PC_$w-|*35U#`bnCi*2Wr9P!fd1+g3BO%4(k@T zO6@71H#3k{)n7`O>m_HiK)dubgmKRFW5$r|`oQCxO(XuB&1vX0RqIV)s@{az9QwzE zR#UjPqMaK&$*v9Q;!Cutns3Z08>KfQUQ~$>lk+-JiR7bZ0B7}JOI&S(^&RLHN`@po zE~r}96lOX}n^Tf~#=?>kNl4TZ zS$MoDES5xfIdaK}%bBE@(pA(isX!Ju>k`O&P6fCMmFL4*aTThWg)|5O{Y1uzREDd7 z=aZ8-y$F$5M>-bnx8($5PCvnGlbQv|Wi*yrV9tl~uo1&K1Ez5 zxVB)>TcL)KkKorq5Qpv-r0XDl<|QDY-C*~PVE@YyX8~$P*>o*r(^JrnKw{)Zi?QPp zgf2kriy;Hgg+$yC#%3N@#eAjVC!-%$iu`;b>eh-pqP$$Kmr`C z$&D_ZTg>`R$TT7jHyBqz&e6fR3RQH2ah2G~bztar1H(>pUFvtkRTwBY7)xb{h#7eR z{d`Kh{`DN1@^TI|EIJ6I4+!IM!jVWYjBozn|9{=jIek7JH?PkJMR0zf51Qz}n^Z*V z(HXr-=Jh5BFUkR~f{QWQB@S0&Qe}JiUW=jjyQ~qcP=~n*8lamsjsQ61D{c7F3gL4> z0?e%mB(qFrkj`f2#IB2%RGC=HOC2e{xma$ru1k==s~5|iXJ@;sH#KCf31@Y@PAg>& z#<7ea=K(IU~S=6LMp-I&ll}{;Z zY=>R;wdKIof=Zg?v4pEbsgxP7i(AfBAEtb4mR3qdYrnGzkax1LR8Dn5nSqR`dUIS# zG)>Ve9<6w^{7?|-lbquAAG6i1o=%AI?aiE-tmlEGeXjHzPpWDZGR(vbHi{@Ss77Jx z&k(lUhIl7qbzOj+igs)Q2T++BNAl^o#+YHw!)@8<=0UIt^yh+Y5 zSmgmBLIFbP1iVThl(FPRpaeo#e*m$j1EOYt7fB7ccAq0TtBbYjkOhXNsf#(DgfufC z)S4=kklTXZaFRPmrq8xKE{v<4g*_6-kJg{0ONzV{0!ddQXYAR>traJ(wTPt0;Uu%v zfl+B)iz=7PNjQ;hk>Z;YsSX#XLwvJBcV60<*H7p9l&wn81-WoX;=8;WY)Dv{^c8t5g&4?C}cZ@rL+d- zxHYKHh|12M=g-4*;ZRpnjw9kymKCX(5&Q5BVH9miG8Ds^C*^qHy+%^yfV%d3^mRmrXWcBOJOvF*9PuPZu)e6iOz}1lR zwqSyBhjtUgIWuYp#*8wpvP~E~ z4sQX5<4E?c`Z`$MBGw`@fV!C<-&$tP$RBn?(11N^E9=+}oDzHoLVP;m$m?Wr;~J%R zb^=ZmpN7zb8{@ggm!gBsQ?-2Lc8IK%)E@PhKPSrV6%|=)@|mN`^OX!gnk`yiiVftvN*Roi#bW2@ zL<>q}4hxpimT=(O(XvBpj^p?+MNRYT>g+R8&-T}vX9JdAQZr7uqvo{cuv9a#9lh3q z9-?g(X0a>PBB}M!_Hq`Hy2*ul@K)iB#ssDCXs(bWI=-c|V?gM5H}Gdj-|WVSbfA3l zuFc3H+9E*NGfNE={yY-#WLEqv9>=z{_e@EgH8KXSZ%Gv>X-Nylj{HaYh(9k~{keX! zmXSS+LRz#19^V?LJx*5yo=)NnmPPKI)yReWn@UaWF@{IIbT0hPjN|h`$KBjA7Yb z-i)AXCMNt$E;%P2j6u-UQVN9}T5Dz0nX^!etNBTgWM@L&TmdQcM02LOROHZ=Xq~B_ zFFKvJu+mXW?OQGxPJ$%MVeibal4mO>(?*otiY0OlYB0mhLYS!{%M#au@(HFgt4m2A z7vxS%m7tc(B_!c-CqkH1o0pk*CG^Rw5qc#U7na^JCrS!z)2}bjTjlkws1s|{iJC?E zla-BF^JQ&9TY3gb#Zjk$M0KI`rnW<6Ulc*jqDs<}t7D}USVXQauXzVpH}wVf1qC9N z_G!`Egpk%)OBk*i$7Uy>ywy4J#IafFr%C#}Ht_u22?He&_&Gx<6zE6c{el4X*RX{m?Xe%bSas)O*R($dg z<;MQ%$%c{7>ejUrZP`>FnIY%VG|ayb7*>x~YVuwD6uIQd>OuLcqPjGb>QV&)Ehi!+ zZxCn|cgwEC1467?i3iiD>J+S}oa$=!(CvPjSFeBphld7E$22<=E5dBp3#ry!1oHt| z!a_{KlfVq-!`Fc4WIVLoU5E*LF_cBJ1XERy2k*nl;JBWVP|0z*X=5&2RRLQr|1vG^ zxByhH-Hg6re~~vY6XM_q@YIOz^9o^4btRsM{_H_|m>@28o_xHB|e~)mkNHf2$-~mP{(XLbC>x z*|~km+<2CX+JNfpn!B+L*Nve*S^V`rx z>Mrk#ktevWJF2#Ea=Ehga{`_nHee`>rp}z^RA~_OC~mee9cxBnAP|C zmEmelmDNn-qNL?S{xw@oLf>9y$7)P(8tx92Uf6v?fHVg{<1iVx*P^I5mqu# zMOj4pE1S(GQLn08wNf(^E2}FGxqM!Xh$LQ4EY+S=xMrtB7Kw6!3&VWn7HOW6JWF>I z(3KG9Tz-d8=7{8vLv26G9{#^7+q54V8I<>bG>#+%-=t2??9Qc9YVvIZ9A(NHw8&D6 zBoUH$In_C0WG=Lha3w*mEoE}_o z7F0Xdq5c&qEd9SZ%Irb1R?~f;x#(hYwsDTQe$}`88c(HOC&a5H+=F>3XSiN-8U6@s zo?OzDU6Wck`$z-m?ew9vgZ*8ZW0W(qh_+D5H3uq%3JT8*kve_rEPL-zO68eKS}%1m zn**g&z8NeWsC<944y8PoE;3edHqo|chW2RSqTJHGj6-jHoOUl( z+C7vil(+hInLdY?+dN=3o300#oo#|sfs45cBp9#B@o=P&&w1y{nDSWgJWi9=jqpd` zG|_;o8!!DbjrsW;7pu}EvBWvaxyP773(8g#Dfh}8Tjg>`cCBYIDYbEOa+9bu#|^+x zb!Mq5b5kWD%T)7&`<^MXAevgW`^D)}jUHT(wI3++b6JkmVka?@JVqD8%9-jMm>q==JYm{ru9cY{%?p3&}nnGCLr;pZrl$}XQVmDh${UOpB4RhWb0cNtgUZAhgi zVTO`yRCaO}c@XQKdqyvqMNlwyLM`csC)9jVi{tKBrCiI@^c*2}mWp?3mXE|h)g@_k zk1e#*H_0qyC{wc|w#oeA&OaJ3#))30R)r|D=Z?{v#4L2bel*FRjT(8~)EyY^Gcu0q zE6d?7-A-qZ_lUBCa{vdf7Bf@cz#(EKN3TZtd{Xf=B1IiNr{$LP-N99jMV0WT1NYL%3zSpq4yJPcgpF6uE>kfPukw_PYNE~L z2G`$Gwi~?^DH|(5B-oa!rlm`>ww$^)XArxdJlbueMdPoV>bkOVHu*bGC^NST7$^UX zT!#Cmh(kxUt8#w6Wl778h=M!>9O7o6Zy4NNDac+gd(e=r? z=3ET%T=%uio_8OJkU2!Y?&4&84vK!EP)bTs19Z(%ZqAwKcn}!~hut4mnu5HlW)4&@ zGGK14u=J5Rpj!~iSMox)6551n1Di==NF&HZFTv6GV z@t!1E`plZcS*ZzR*9W9>GA^H`aQWBsI-}E9`JlVObt}r>ytI)vbV<@d7_Fkde8Z}d z)2bZo=#M;w(~zLbl+FkxfxY{M9tPmq~5OUR_ zb;}NP0!?k4dt4DX2>N|=xhBGHIS8&ldId&a70YRb8)3UqAywL`G%K_5x93=?>kiBu zMz565q1gAnGPo6f5~n)=U49fnl+c4&uwTDQln+k%@M(q7KLU@fHs%7)UIBlQwaiJJ# zE}K0!9JqR%E#*oriE-rpy7GBco(t6uRd5b&e9Chu?V!rsesmuDnzed=zE&=nT#d(E z$uRU#ks6kCnd!&4l#e1;zyp|cNCup&yb^<4Q3`zZk>$YT{0I2etPUnuZnC4UK4*@Ooac?blZe&wN*PKBGM3|Dq=_3K}@ssZ{n`2kA5{Pi#0Z)vI64MvbU zloAhRzRv*-iiSUQuq7xzabxz{Oq*e;2Qu9s9E0snBw&AAC@0)gdi47MF@{ zw;Z?^USEEDfC??^1jFO9J^CTC3g_F-TMa&OsAuNY{KthVegL-{HBi10phkLChi}1( zZo+ZqLoRRRAMW5f_{GX~Xa(=0QK?z;qaGWj)>LtEmz+pM+HsWRE)$Mnrqd+qpC-|i z;aNl5H-apY`>M2O`!`Tc7$eiw4>BsSFI!ZhD z+<&0Nr8^~Lt&W{Ln+{FuoSJG_WDGLP$V^DQlO>djX^(0M^^P^kyqc#0T0?G6!jV)pkglI`K(#V!<$p|cLz!(V| z%JMQjGc9J~*32+!fs}~2f6c7O+FnROR>|TlY>6!;r6hP4@8Yc3RZ@6kS4W-21wFgiP4|W2?3jsps9_=bn4+x#ygF?tR@s|1CChF$EW7 zR=T@&?dJwuz}~tWOqRYw8PCdR=;v~G*R7uqzP(-h48LRBD{o^STicVE4}y)C<}Zb) zrQM>OVUdw7y)mpu8FObDs^4iPYe3`ziW&3K1?M4$4eK?)r za$8V>%u*iZo`8J;a=iRonkRA9r;KWj|Kf6~a<0?Auf0sP)yk72K_@)E&a&9R4pv|K z0+)DKJq6df`F-av@{yRFdzW?9_xu4we`zD!7tN$on{9me7msC2`-8J+V^$^;I! zzMJ|weU&BP=2Yq^`0#F@R=mh?e7jjvR);Y`<{I7^%A-WwyC}S} z@!=a8?WJ2_z4jn^>o``5-nnDrOQdbz{P$N+|6ug=-TQ8=eRJdB^B>vzCwkE-(V0sm zQe8YUD-{j(NbAw1%%QICl~Fb^7=-#HED`0yH9=}+RB0qKm2Z$$`AQDj&B~p*U{DBUk@HqC7*IKzh$^pi z<-$ZdbUjA(b%OC4C@JGL$}hx`i`{gXsb1ep!FR(Hi&e8t}~1($D{HfSU%gQ zRM{tbavcdDP3O9ZMun&lSF@xgph%eIkz%AFPf;k#*cm~V{t2SmX(3WoWWXXTGu3NC zQm&->YI~KF%V@OP$do4bHwmjOs*w~8)mBOB)n2z48gjO!&6nfp7t0g=gdMzzmo?vH8(QbUlTh9AJS;?*z@&mq z?O;-sNOuvY!6~3|SCYZsk<2BAqGINL#yA~D#c*&S0bBcimA57cg=P^D(L+%oZO!)e z^2WGLaxp5bqDixXjmx*YT!EECaXKq_2x|sH-#(^+Ywuttx_g9rvDqU?IAk9(#2)I4 zQK>9M1?CLMm4#45tSqFGVbr)gQ+e39HD$Q(x96Cil?7X`3%1t4EGqN{9Yay&(db}Q z2v;P#hq7Hm*_D~f;|Wl-AjwQJ-(i2-j8(ob3f&fVcPad2x2xIFZBk=8>8|(h`nK7<6M2?(1c_P5as@;+C1pF`6@g z=xG)9!+IjJlR|xxP%$hAH>#ZA;|p9uy*{DG`LJ8$T@$3$?khs^3+kem1s}(?j9Mit zax713EXiD^!8J;5@mMI}X9ja3hs0qE!CtF62aq)Zi?HEh8f}glJ!5_Q2;-D^c&dX; zN46^rphT(wQZh)FgNY`Fj|g|>v_X%f+Gnq1U1I?`<9V*NB)%lK4T=%~H>#3T2~CUzR) z31j;+N!Y&f%{9Doh;X)ec11E3hS{jGCu*#S8Us;dcU0Z3+KoN-Tw%`vd+yF9J0PNT z#}Ol^W1A`RT&yGw1EWAmYMG!x)_x@s9fL_L-ysBHCY~(xC1Z_Ysrb7{$|S`ivx+=$ zU^%XyYGsz1nI&7UZg?kb0ayBH8ENDEDD!7_L&;wn|{J*Dw={_)DYHD zG@5EcfqYXE7qv=MJBAnmc2p~CLAUC_0ES583$CX}d`}8}PbJq=DJr#kQZy>H_f*mh z6_87*T*$-^U{d50QVh@^qAyE!h^Ul@YZB0kDwq){0SPj(pU^7x$U>0Rs+ekV8M#@_Wps;)rI=Rag#nDsQ%`h_%|15{m*c7^Ihi0)hvM@{-kr6@uU@ zpbt}yoljYps^?-_1HMybKH)GjCh^%#kSaf6R*Ffbbt^5l5n?}Yo z$L@rnt#DUkFvqxEZmZg58?F8+`e{vKu;=YvEcbR>3>@mDun3Z35u?Exf%ab z*VEL9L?(on$rmP_|0d#3YYrq|TO}E*DFGyXqW|F8u?CQ)VlDC%X-X1(!ZWVcpA^#1 zs!?K%>?$7@149pbYT}ttpUBi0P2Z=bUGo-XU}+T3(BXh5zOCox7@h%gzgR`kSP_H4 za>aZ~1L${XQl?bKY1lUb=*Q$(>p8<*c)M6f_h8Tm+$NTAu>2ZS{|iv9r>S_ynvw*0G^S?XpqW+thGx(7=sB`fq|nW5G-jd+ z4LF9P@Ip{gDp-?Od=rI+1VU2fh#PeFE69A|?CPHPbrniQqpB!_TamIvqA^(*)}DA1 zUu5hUG8Sqg$shw-aV)Csl+vl~gx01dqw1J4s$-a@W>9nwB!VGRX6a@dQ(d*~8sWD< zVX%#6@zfYWz6FSZm~wGR)FN=4B|t9$$Qr%Wq~dFSm2Qn zhKMKQg0G=aHOyEs#v2UY(@IJg9Cj6dRHJRNO3oK7sWI<63Gp(G3zGhVybGZY}To;p#varf^mvwYlP-yu%m%rBM z$6=ndFkQ%d{D$L<;U?<4eH(=i${wGiP;2+1%f8iT$Kfbx13v13Z;vy!H-X>b+bDEU z_W2xzF6VBaqtNB-_c?L6leG1;vk7?2S5fF1P5K;#$mroIn>nhi%Ty3%s=MGd@MKC0(LDlR z`!+r)k+z7IUpV2cJfjO)p~+llx8`jC$~qRn9DH*23gW^d#jeI+Nm$1)4dE z(dYUyp;I}I(dW|y>9jcSV3+33el^=SukTjAKq-7tAPtDnoj_376Jg+A* z(y*-xl8Mr4C(V?n6@XY2UMiu1kDK%`=R$Rbv)&#eH;K?v$W)32T|vsNyrb2llq2=YrW_zd(rc34(Sj^`L%?Gx!N>LCd$cJ7j9+bJZJY~GzlRmeegI;uQJL{8SM`CY2j ztZ{TTN+vUikrh$p`y3CzwOy1OQ}wddj~jO5gHLBg_3A<*v+&9Xk%-lYEyYY-19mCG zFRF--c;kzje--#3bJUhO!xd$#52q!t7vf5`pQjDRPYefKQz^C{4oaV8`-Eg;1CnDw zWsb@-Qu!Xj<0||}QT0(L^Q(_%s*l4^-_obrg`f)MT&A23q!g-;_n|D2IF%nFVY&vA zok(*>eN9Z+z~aJtcx$rD$nKYet;z+T^=mq09PQQ!X&;31omwMs-kZ6$G8>-Bze!b z_33o8)q#Xs;n^FVsxRKJ?_>#m7OGr|~QNDLc8JlUzeQ>;~; z6RCcL9;rZy1FjIPCALN1h1a8n*Ca8X4pUh~Z&dv?W@J?otLOr@6w`MyTDa(dMvYN1 zY-2n7xWT5fYm6>uZB@T)I6x9y{%ZY3v-OXftzqXTdUo`I5rk_8f$I#AJTylD>O~_ z(IQreEDsx7esW8<$ zluq?z-HPpCMfOVFcl4$+wI3pQIB-aJWNL3hPLu|~djYjFnTZzrkQE(W-Km~ld-V5V zR)ntAKv!G5yDgq-i}$p}wTZ`Fn{CVL$Fd0fw5U5!c1+LW05f0${mT)vx(M+d`z)@4 zapbgg^QbClM&@Xd88~gp=S+;=C6Fk?WHxg&?CXa<@Ha<~gSfmfd_ooXC$-cd5i&kg z-%m~In6&kbZtfVJQ`t;3mA!2m(wXY>{Xr*BB)L%>R#A$8vK@UY+aWub$pB;WzD|ZU z*%3D(pFGt=m=W0X_Z@_9TGemHRSo(#btsmpz9>V@cl2$m_U$FrzAYnQF^5QXrZa2& ze(hb-vi`{DXa@jsu2~0hBJKSOzJ={~Ob|K%5;JktsPMjl4(Gndzt^IXx&PQBSs3>B zbi@t7KzOYMFGFOl>4&I_8^4hUBlzOGWcj6#cjwZ|k)E;x)Y0VfXmK4Y(Jil zX8ZV1vNvk5U*%ZE1QLBTwgU|IWre~PSomf(AfvS!YEK&IM`)qsqI#{pq0ab7wl>!K z1mx2PMdyTO?evh}m)OW$i?%2RU_5+RW*cJ>K?|(8L$Qv=lg`xfKunQZ!KE&rFP0~-rB0SMQIaWo$S=?#d_Q!u5KJaY_qk= zE+=B&p;~&-IAdgei#=LgSI=`oy!_tyW`{-FYH~FH`#U zNE;6(k-D`rVG7G#HWw}j1G=I)_Ew&m^IARI8 zeWs7~X%#K*v)q*6xTxy-X7Slr%(*Ni$ym3LFaqk!oCPVkvI#ghi%T&dpeYrEcbutC z_E>+;SLM4=_N|u9*z5gj5l*-jv#EX%J1udWqiH}Y2`lc`juu?qjikkXQrja8v-Psp+Di7V00N-J+Y zD+Ip3I(bDp3^R)j!zQYi!b|@_1oV78!&(4eYIL(r?@EVoDnT;Wksj(wrJDR-e>t*y zKJ}}qs|!C`??j{x`WVHsWYPcG#w58ZjS6^>S1{7Pp|$kQ%myZAB^E zJ<&bsY<3mWrj8fSb<yV}$am(ehRZR-S`<&GabTsi z9Wwt_M-WI{*5#h&f)c0w-3YNx_LQk8Se76dX#3w6aI*{}UVrR5J5%CUBHb9l>_Y*x zIHl=_XB)co%$1EFRhJz zBzcOr>*u2Sw;akt$z_%-lQiBs@A8#w>|Uw8Ui~~DmuvBt4baYyCEpX(Pg&#RR*E=1 z64e_~{Ux-?P6Lp4X?q^0w$*qcs-KDK&myf^gY^?p{V}PW`Z?d~%4E`jJ|YP9FHp%r zlR6aQ%6Fe!vd41HTFqDNNiV($-Dwl3Ca#Fy)zB6<9iMYa&49(_5{WZiJgUDy9k$*$ zfSOo1HCx{a6YIFxv?XSfv^3`iZuxI_(nn$mh61XagQz}*uUa&eSw z93`8c*@_}|;?XWgw-UGAn{sV-&(S||?hR@<&26x{lun0$=UgTcK8&5r=BHU-HAO4+ z>ON|GRdN|m1fMpH@;+I)L26(=P{y8;#|_EI*Ksx71`{?!C2)m}D)!mWGla%3XeFhj zx2q5HLD=>5^rR?6rYNQf5#cu^uTZ--nC)?amB?}bXdxxO4L>xSIkq-Q*sK1+`s6@+ zoA!9vBjBRYlq1v&HtC)MBC8)Z41}fEU0qZ+{$QEzWIkcsMAn@u;5Q)k zh9dH!@RZxloU!$iFLIIBLA<0o^-|JK9nxtesdikM#yUOg`z_8oO5oFaT2?u3@ygRU zz5Gs+tE#PiB$70~TcQgj$YWpGMuu{tz1>NNF<^kDGsj4KmbOj1yMtNyCyJ-BqG~nc?wGC-Dl`dJG{e zHiVubgDK2ZzG34fH1n2QI6}oiqKZiHoMo+NL%8?_xyNv`0=&Uou5(775&*DFLOzl1 z&`8_0F1KKv+LZ)r7Y%b|r*-D8&9iQNIXL}Gpo%Rj-w=uGVw9+Q+!K0CsoLEdoo=Qm z)Ws8px^E$v{(=DQmHUz})un>AQsAoe9Jw}ZT_910b^y$~*wEcSQRaCv;hOlOiL$f| z6~0aw57I{NvM;#o*8K{XeUa=d1c)A%(8(3+qPN3_8w`T}BQn@l)A6v;39M~)76O|c z=E*Jy7}MHK02kAlzgANA)hf(*xh_!#zH{)rWWZ zaGwwF_ThdXj`?tsP+Yk%CGoPrHAfEM-FaNfCVxQcpz<<@7}+G}lhs=g)_Su*AD#M| zYH>T;n|zTw+P=jIp$&fAWQCkL6`YOjPo3h`ceqbVR+lPBs?~RCgIT{x2QwTC8dX7s z#c%?-jf2tdgH}^)O}MVDoB}2zdsMFDn@D?)xih4~^x3qIOp z>ZAhCh4zH5jz4)IPZkECPEpRs01i9o&sk!-uW+WV!cJ{bV+V-H;!Zc4JJj|f?Xh(j zgLsbjd?2*w?qT}-dT{~k48Xq3-PntZoDCeOSj;jl{GM1lLhh#8uG~q*OX1p9e9@H& zZflcz3EadIxC!TSWDBethUS&mHjfc=NZ;)Y02F!`d$bO8pf*}q5UgR_L!=Nm`1E<0 z-LDf;^Y6tO&Ap(%S>m?}G}k7LOvw-0>fWLSkViWT2kuJSD2+7JalYHjj?fC3T5Fa2 zlLd31!o-cWum%&%Cak4d21BQVooVW2S$UG5rU^PLLGV}*1l=JI(s%CNwK3=n_?h`cQ2fiEyJ^Rt?f=Zj|MK7edG6D9 z&42!nD{DV~^ts3W`bS51RQ}hW{`#-}m$9#A-89WM-yFGeH1mVc{M#qP|N75%jMlFDlfV5@?rh(c zADjN`3!8p^b^WVz7k}wL6+Rk%?umcA_vX+3#i^HG_;}%i;qP{)zzJM$4Wh}(Bn!ye!@TIA`$ikT$sMc znS;D`!zp0pH#@pB>vUb~NoBih^osZk@;agM@sh>;{d_G}Nfzt_8dulL#&I?RJ&Xz7 zvzBGL&fa*yTkaJ;HOh3&IW~_YdhF-X0E*IQy;!$6v*h{)v4IVs}XiqJ6 zvRg{h@FIf?pdMX2xS`8qg7Z3$>RH1KpJXF%F}us9dx2V`t=n0ue?s*~bT74a0|`Zh zX_J*ztqo4bt}e>eIwcA!QZiENs*jIk)4n4PWV?8yiWf*!b;&Ie4aMcy=|knX30kY7 ze2(E=1rJMPuy;p5TGs}`?qv+}ZuNuUG2%wmJ$BPl)8t`G1qluoZy_sM$sx=f+CkiE zv<9cRK5lf=@V~}8MQP@y`ulo(-Fo;=Ogtx$ERTWL8aB>1As@7{FT>a&+yN6WeRaMJczvlT<%(?zFJ@WktJZu&% z-mM257A+cIzQ}Molq!iWrLMeGZ35dT*gT^8s2=C^IM1Vz=dpN9^s}v|@2N)(-A3Po zU{guVI|I~uK#ztVFX(a1TG&1+j@3(a+E_(t<5nJ(FZ)?~C{zt?P!>YJdvLoX$Aw|& z!Y4ZHFlO=+TCw6x@&_tcV93I3Vl4@{y;Mexq9w1$^1I(IDCT63*l ztD^A23O&{f%A-80fs#k!VH^+R>N){$=4!eYj%hHmz(_QdQ(dda_ITiS&&~~)jXn(? zQSn`hJt0(OyXy)>>t>aTo^%JFehuJ2bT!?Xr&)AqTl`C|Fs+WkVQIKqO@N0NO)xE- zf=mzbR}}o`nuAEgTEe~hYkG)fs$W)(3$}E16GEvscvQZp!V5ea8sfrRJQhW$#xReX zVv8bU?a5fsVy=;{iAswaXxB`uX#uW(vwT#s+7cnj_$I{4_S`UaAhFPblXJRR$VF# zql4WzR&tr*b-pV+1c+P#^B*on#$t z6Oid6TDUrD%Xjf$2gTMZuh;bmY!F;ivaBh&Q1a1KJY;!WRx>zNqhxByz@|itDDPSp z(hQDTNROyiPNiIK$-yhN!7H`FD=mRnVu~WX%}h~OJ_Ir}va~SYZa)I1mH3%!a$U{((HJdTR+1%*1D@4Dxe^Dw zvcW4uUEYqD6|YlFdGe(3Epfypj#y&9O9*-FD@)*hQ(~t}D4=E50B&dDT4Z+|*%L=@ zjU#u&k$pr~<+|8DGq>Q1=r!>?z_dRDCD~@IAJ8l6x?RYY8m`d#%tqz@TnFC(Fn|mk zU}1rPt=4>^lOY-H~3^gk2UH>%Pq08dzuo-scRlcQwuMHsdIrViehmfln=6Mlu zk7MHW=D6mi2q$;~!U_Y3I?SeZsaPnZVBqm(Zst%vEE9JADzJgb5oNQc#iPvU#jK2y zRl@#Vw_>z}i1;G9b_+<0ff=uJkDEKo9wN1sW!0Y@81V1CpS9D3HNmR*Z92;^pC=N6 z#kT_40&)C%X=a?myzU)AGF9fA@HP~F2(Zz$X&1r3ULhnatUX?!rLHkwYE=$R^tDSe zH3~abr?wXa$C*z?bqZr#4wK3`7l)Dj8(NiDOV+bpurNvo!B`WkV-NK7i?Xogj2V|Kz zBZRgwZmoByn%K2qx15VV8+YGczl9$$^N%*G8An=H3tH>-sSPo-xBCV!SKZN>9Z@@h zht~wT7!39w$xG0IwAKVn(c5hMl!l4upI`5LjvZWa_(shCX8)c?MSi2C_Cn zEN)V&g&6JD$ip5+Lr=3JxeFt z(kE{46fvb)mQHh(?W=)^A}=(3W^Uo~xf`AC8=KBv4t?Es3c(^&$Jll0SfeWympBA0 zbwwLkz}xEby=B%l`#aX`4I9uwHyAEuRz%swTX-~U8XhiX-+W|>ImJ{QL-*m?uN=ox zvaVze!5#K)2E7dB6WuDleCgHs1Q(FnN=36J?U7(2%H=>qZqE8(w$-`#_KG$jG8u$f z<$QFk`NpH*E{7d$rMZbYuhoWOh4h6%*g#2;$!alYlYrYh0QlftE0b?F#bVCY0mCX_ zC4pINOGdi=e+=f}yFH9c-xn~t%T*EtP|+4!Ru8r%oZeV_RnCB3+JXz?m1hjwV_~;A zva$X>IZhXk0R@iK8sv%>h}g`lf6Tq(QDayWY2^^5+80d%gPY>I9-r;W997UuAnUL( zjHM(WJ_hB03`R~e&#np}{iVoMzpNbvl&hZAg)y)&HXXALKq#AI%wwL;&`fti_Q!?R zV5cm;=pL?$Y3%svTwL$F={`9b2Js%+;lCTwh7E1r=$G(AZa7hiIYDa3RyiWG51YtM z6A5Y}7~&%9tv;OM{7M&Nuq;&(>4nl)z)k9uNs#(58vyoYjJeqjee1SN{4GJTm=;2( zwT0v6vrevd@_~6Yu8MbjUm7qju7zo^!z&7o4)7^6Ij{b_-0d%YVcqI}5z_ zn9I;Ul&dp$!;x;TIR>lW&8YA_YHYRBHZS#cq1)kAg=D|oD1ANlv}oe6>}!um@{2^V z4~B30a8TRwoXo79Zplpip@LxNZ|Y1=8tW8lM5bDR(gF&z;{9PaB@$^61O@<2QF{cA z6C^{&YI3Pq4Nf!Vfq|w8NxOVwUD`BRj1o=)PrG{0HPvZMdYhkC?#ZM^i(|HJByKJ$ zFB-HhqmMf^lra|X_}=`Q!ZAGKv{ zwcrKYW(`QX)%vwF(@cKXBAm_Ybqlx{)`Y_p@Bwq4={|ZNU{3Ux=6h*$YmoCt9{7Mg zVW2)MqVlR1i6j*ftOLiY^;K54f$Jd@K=!OOZ43jRslC>v`V0`4{`#S!?sZB`)n7K^ z)z3pbrP!C_B_K*Yd%;C->4qHx9kL#-GBCNjq^N&T%)Y7pc{e;QAJAAc=TWr}K_LTFfwtq@kULV$C<> zab7PYjN_=^W<1V|8ceibrn-z57%l3fLZY!pm@-hA9lEYqPBTkwq*(@`8pE0tur-QU zvjKbNJQLQ3dj_Bk%ZK|>j+nzq_)|GoaBfIos*D?~ym5hO40fVprHR7g**ZPhKQv%5d1p7 z!_98HIT37E-An8 z%UD>Ix6C0Z8y;*^1nhF~{Ao`?2JCoGhMnosorvLWC#14Av=vgh;GRG?q+9Q$ue43= zo8XN{&?*UXQ>>_ew}p8~7O!yQrSK=LU*RKXA2L-tB#c|5X073Z(*$Tw*wF5aP<05+ zgq(w-PUbnvGy>VIb<>h{d?`xSODNOU3^^5V*mbVspn*q}?^!3EXqzmh$GUj1XR};X4_`$iQvk8Q^i~>FISo#pD)ZG-4Fyj z62a(=vvWu1r|+98=hjVJo7**0o}Hd4=5`$(pFf%_%uMDcW@pOt)8mKBv-5{?oAUY5 z-1P(-w*^79kO-=uX#w7_uXw1uK6l6A@zV6f$BRdIbdv!tluE$;sl##K`#YcyVNWytrvoeq`&&$kt6;4@?wC zfiXP3b=&ypw&4SX1EX8FZJr#>AJ{rMzOArr%jD)Q`SFpB6ExX6x@mHJ^QJ;!qF5ZB z7#|rQEo|F3UMz0jTqqVNw&wH2jR!Vu9NjiDF+5%Kz?g+V#}6|!&~#4wv2C^7~RU~w~R~{Hy1`H^An6_%f`*) z`AvlbHbJX4+yXNNBf2uft2zJ=mW@m~sf>nb`+(<=I@J^kCuWp*N#mU_G(cF!*GY6*cJ3L?9?XdZj^|A*R z7Vr(6F7HkRAHM5QQT^s_nK@K0%uEz>1m)?8+=1z0X)-rWZm}?#n>~=5m@iTQRx`y1 zEnl?{IUsG+yt6nrUpxfujA*ybP8LfWRJ^M+T{v_*$?LZ7EgUHBDwUKtB-(8af{!MG zkGu;Yw-x5*K;iOWHf;`qn-jsVcL8TF6fVsF6fn%>o1V}SHCq8 ze6+3lJM;jX|6RZ)6T!W0+@_Hr_<8PR z{vUL**ZBSauB(qFf}7g9vgy68IDa2JdPf2AFn^r_Qa3%oinvirb3!wJ-S&9CizYla zHLru{G6=tV;nZ4cPvOvQh4REy|GuMhMP?S6Q!euR1^(^`l@VwDPDx11I6r8+Q(^#7 zkL)URzeFYR)f4u9yl9wUGpHi|NM7T+F2a!Nb#QuSrZ}${b2BkNJqL>}ZA8PLb&Zy( zk%^hhw~DJxpg{{L)%nX;Lu2cfs9_{@{Q!lmj|$OvNUkC#OHf_zq~hV}5>i=u+R48| zCg2b@P1cei)}op(9`G}gdvI!cV#>+sGEEQ8A-~2;#oU9_<*8g@3L$v??1Agc(+3gH zlunmSzU5&0!l6UOgX5*6Ijn+%2bt^*xqD_0BPJ2Uz8?wL3HUg7Uy)I3mETa9DU^=> z0%%gj=Qd@pRh6kB9M$&yj!D~B$4A^K-=CWu|9O}y773EnrZ&)D*fZ-A!TZ`)?=50h z&qp>oFW)g;GSIL0o#^-fJ@xiBr~lp24%@P#MG>ra5!s>r=&jiYZ$r0F&y|Ye`z#eg zN|xO+GermG;^f<^$x7`MAYR=KI&Uc#4`M5P382UKF}DYc6H|qm=|cyZw?f%X-b4we z((J>!v$;ca#fj+y@E40PH-kNM$nojS^-|fBh55-1IcKSeod8)b+=qp6WDcuyx(s8s zY4O97M!pltlNmF5cmXdF>@*aS4ar}$HOy~<3?+h9H_jfODd%?NesN-obv0j{*QmE)reW)kpst$o1zFQtvZAEFf-)~{`KD4 zpC5j1S8Cr)cf9h?OS5~AU48xRi9huPj_oX*ByzJL8C@xtEU3P$#QzViN^|5Qj^`^FQ05F~E919XEu z{GI(`XK;4b&6&!Dye^-=pTE?XI)l_)tBkBbm(|<<-MM%7-t()U|5v4LSKt0mUOjbo z$8Y@0|0ozY+E6w$crAljFhOJ-arIYzaK5bPP)9p1tOO z-u|Os|J(kn-ru+O)1VapyI=8KoLU-AwABlOdr?=rOQqY8#KFNs6PPB&4U;8)8%FRSFz$1ssk1$%>g zdEUe?WbO@a2|f|rPWl#}Hxt*t=R5!EZ^iW;o(1CY!&b@*7lc|X?f-U@NC36K8z(pO zb42<%uI7(EQO1iTJonj;6U_vNC~y62k%RM0XIl44!AWne=!cE&y9}iNPR9vG9seKZ z*Z80T<6T9*e#EHtlW1&D=+XW9;63zrkY4peXJy8!AGOkN5>C@zKbSOcKPeXk?*&Q> zXO8?C@^81cNH+iPL&&Z~6F2u$OcRFl98ld)F{$e1`c(cVPF7m&KLsxHP^8svW3Yvv zx7*BL-u~3)L&0*|h@$!h(Ro7s2v-ZU%k{N^pXaild!qfX2HR+VD{b$ymZH=gV-uzC zgGRVUjCxD+a=aik!D~RdKtCc@rj6#MXz9a7IsN>Xs5D6!|Gb}Ij`QA;>T6^!zvz7!yu}f5>&v$n4x2Dc6T#AUm(E`M+^Nk6Y_4}P3jI*oLFnRs(DU-`+ Date: Mon, 6 Oct 2025 14:46:11 +0300 Subject: [PATCH 05/19] updated to newer version of docs and contracts --- articles/LCPublicAPI/api/Public-API.v1.json | 31888 +++++++++------- articles/LCPublicAPI/docs/API-rate-limits.md | 5 + articles/LCPublicAPI/docs/Language-codes.md | 2 +- articles/LCPublicAPI/docs/Whats-New.md | 48 +- .../java/Java-Client-Upgrade-Guide.md | 169 + .../docs/api-clients/java/Java-Client.md | 39 +- .../docs/api-clients/java/Java-Samples.md | 211 +- .../docs/api-clients/net/Net-Samples.md | 48 +- .../docs/translations/Translations.md | 313 + .../docs/webhooks/Batched-webhooks.md | 3 +- .../docs/webhooks/Webhooks-payload.md | 3 +- 11 files changed, 18495 insertions(+), 14234 deletions(-) create mode 100644 articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md create mode 100644 articles/LCPublicAPI/docs/translations/Translations.md diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 504ba14..1811773 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -21,6 +21,10 @@ "name": "Account", "description": "Account" }, + { + "name": "Connected AI", + "description": "Connected AI" + }, { "name": "Custom Field", "description": "Custom Field" @@ -129,6 +133,10 @@ "name": "TQA Profile", "description": "TQA Profile" }, + { + "name": "Translation Domain", + "description": "Translation Domain" + }, { "name": "Translation Engine", "description": "Translation Engine" @@ -145,6 +153,10 @@ "name": "Translation Memory Import", "description": "Translation Memory Import" }, + { + "name": "Translation", + "description": "Translation" + }, { "name": "User", "description": "User" @@ -239,6 +251,77 @@ "operationId": "ListMyAccounts" } }, + "/connected-ai/llm-configurations": { + "get": { + "summary": "List LLM Configurations", + "tags": [ + "Connected AI" + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-llm-configurations-response" + } + } + } + }, + "400": { + "description": "\"invalid\": Invalid input in the query parameter mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "ListLlmConfigurations", + "x-stoplight": { + "id": "inxxqoo6ktslt" + }, + "description": "List the account configured Large Language Models.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + } + }, "/customers/{customerId}": { "put": { "tags": [ @@ -1372,7 +1455,7 @@ "/files": { "post": { "summary": "Upload Zip File", - "description": "Uploads an archive with source files in a .zip format, to be extracted and used at project creation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoint. Alternatively, they can be used to [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "operationId": "UploadZipFile", "requestBody": { "content": { @@ -1420,7 +1503,7 @@ } }, "400": { - "description": "In case of:\n* empty or missing file in request\n* no valid multipart request\n* other file attachment extension than \".zip\"", + "description": "Error code “invalid” in case of:\n * Empty or missing file in request\n * Not valid multipart request\n * File parameter contains other extension than the one expected by specification.", "content": { "application/json": { "schema": { @@ -1456,28 +1539,16 @@ }, "parameters": [] }, - "/files/{fileId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "fileId", - "in": "path", - "required": true, - "description": "The uploaded file id" - } - ], - "get": { - "summary": "Poll Upload Zip File", - "operationId": "PollUploadZipFile", + "/files/analysis": { + "post": { + "summary": "Request File Analysis", "responses": { - "200": { + "202": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/file-metadata-response" + "$ref": "#/components/schemas/file-analysis-operation-response" } } }, @@ -1487,52 +1558,71 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\r\n* “invalid”: Invalid input in the request body parameter mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read uploaded files.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to read resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the file could not be found by id.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the resource could not be found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } } } }, + "operationId": "RequestFileAnalysis", + "x-stoplight": { + "id": "t57g1xy8y9r75" + }, "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -1541,37 +1631,117 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "description": "Monitors the unzipping operation for a previously uploaded archive and gets details on the extracted files.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "fileIds", + "sourceLanguage", + "languageProcessingRuleId" + ], + "properties": { + "fileIds": { + "type": "array", + "x-stoplight": { + "id": "azlzt85a5lkl5" + }, + "description": "The file identifiers for which the analysis will be performed.", + "items": { + "x-stoplight": { + "id": "g73xta7jy2re2" + }, + "type": "string" + } + }, + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request", + "x-stoplight": { + "id": "86x0qedyrl4rv" + }, + "description": "The source language." + }, + "languageProcessingRuleId": { + "type": "string", + "x-stoplight": { + "id": "1g8puz69o0xu8" + }, + "description": "The identifier of the Language Processing Rule to be used when determining word count." + }, + "fileProcessingConfigurationId": { + "type": "string", + "x-stoplight": { + "id": "hu1k8l2pqv2o8" + }, + "description": "The identifier of the File Processing Configuration to be used when converting a file for analysis.
\r\nA default configuration will be used if not specified." + }, + "quotingOptions": { + "type": "object", + "x-stoplight": { + "id": "5l3iznluoo6kn" + }, + "description": "Set these resources to calculate an estimated translation cost.", + "required": [ + "pricingModelId", + "targetLanguages" + ], + "properties": { + "pricingModelId": { + "type": "string", + "x-stoplight": { + "id": "5rf92aw1gkge2" + }, + "description": "The identifier of the Pricing Model to be used when calculating the cost." + }, + "targetLanguages": { + "type": "array", + "x-stoplight": { + "id": "vyfoxy7wp48vl" + }, + "description": "The target languages for which the cost will be calculated.", + "items": { + "$ref": "#/components/schemas/target-language-request", + "x-stoplight": { + "id": "pwvr1t18i9dym" + } + } + } + } + } + } + } + } + } + }, + "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) / [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis~1{operationId}/get) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] - } + }, + "parameters": [] }, - "/folders/{folderId}": { - "get": { - "tags": [ - "Folder" - ], - "summary": "Get Folder", - "description": "Retrieves a folder by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "/files/analysis/{operationId}": { + "parameters": [ + { + "schema": { + "type": "string" }, - { - "$ref": "#/components/parameters/fields" - } - ], + "name": "operationId", + "in": "path", + "required": true, + "description": "The file analysis operation identifier." + } + ], + "get": { + "summary": "Poll File Analysis", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/folder" + "$ref": "#/components/schemas/file-analysis-response" } } }, @@ -1582,7 +1752,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\r\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -1598,65 +1768,54 @@ }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to read resource.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the folder.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the quoting operation could not be found.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the Folder could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "GetFolder" - }, - "parameters": [ - { - "$ref": "#/components/parameters/folderId" - } - ] - }, - "/folders/root": { - "get": { - "tags": [ - "Folder" - ], - "summary": "Get Root Folder", - "description": "Retrieves the Root folder in the account.", + "operationId": "PollFileAnalysis", + "x-stoplight": { + "id": "8iqm2m3c577th" + }, "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -1668,13 +1827,231 @@ "$ref": "#/components/parameters/fields" } ], + "description": "Monitor the [File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "tags": [ + "File" + ] + } + }, + "/files/{fileId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "fileId", + "in": "path", + "required": true, + "description": "The uploaded file id" + } + ], + "get": { + "summary": "Poll Upload Zip File", + "operationId": "PollUploadZipFile", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/folder" + "$ref": "#/components/schemas/file-metadata-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read uploaded files.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the file could not be found by id.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) details like word counts and estimated costs.\r\n", + "tags": [ + "File" + ] + } + }, + "/folders/{folderId}": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get Folder", + "description": "Retrieves a folder by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/folder" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the folder.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Folder could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetFolder" + }, + "parameters": [ + { + "$ref": "#/components/parameters/folderId" + } + ] + }, + "/folders/root": { + "get": { + "tags": [ + "Folder" + ], + "summary": "Get Root Folder", + "description": "Retrieves the Root folder in the account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/folder" } } }, @@ -3519,28 +3896,14 @@ } }, "operationId": "ListPricingModels" - } - }, - "/pricing-models/{pricingModelId}": { - "get": { + }, + "post": { + "summary": "Create Pricing Model", "tags": [ "Pricing Model" ], - "summary": "Get Pricing Model", - "description": "Retrieves a pricing model by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ], "responses": { - "200": { + "201": { "description": "", "content": { "application/json": { @@ -3556,81 +3919,56 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response. \r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "401": { - "description": "The user could not be identified.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the pricing model.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\r\n* “forbidden”: The authenticated user is not allowed to create the pricing model\r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "GetPricingModel" - }, - "parameters": [ - { - "$ref": "#/components/parameters/pricingModelId" - } - ] - }, - "/projects": { - "get": { - "tags": [ - "Project" - ], - "summary": "List Projects", - "description": "Retrieves a list of all the projects in the account.", + "operationId": "CreatePricingModel", + "x-stoplight": { + "id": "5xf6yyxydnib9" + }, + "description": "Creates a new pricing model.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -3638,148 +3976,37 @@ { "$ref": "#/components/parameters/X-LC-Tenant" }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" - }, { "$ref": "#/components/parameters/fields" - }, - { - "schema": { - "type": "boolean" - }, - "in": "query", - "name": "excludeOnline", - "description": "Excludes projects that are being worked on exclusively in the Online Editor" - }, - { - "schema": { - "type": "string", - "enum": [ - "created", - "inProgress", - "completed", - "archived" - ] - }, - "in": "query", - "name": "status", - "description": "Filter the list to include projects that have this status." - }, - { - "schema": { - "type": "string", - "format": "date-time", - "example": "2022-11-28T16:46:00.00Z" - }, - "in": "query", - "name": "createdFrom", - "description": "Filter the list to include only projects created after the specified date and time." - }, - { - "schema": { - "type": "string", - "format": "date-time", - "example": "2022-11-28T16:46:00.00Z" - }, - "in": "query", - "name": "createdTo", - "description": "Filter the list to include only projects created before the specified date and time." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "createdBy", - "description": "Filter the list of projects to projects that were created by this user." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "projectTemplateId", - "description": "Filter the list of projects to projects that were created using this project template." - }, - { - "schema": { - "type": "array", - "items": { - "type": "string" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model-create-request" } - }, - "in": "query", - "name": "projectIds", - "description": "Filter the list of projects to projects have these project identifiers." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "sourceLanguage", - "description": "Filter the list of projects to projects that were created using this source language." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "targetLanguage", - "description": "Filter the list of projects to projects that were created using this target language." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "projectName", - "description": "Filter the list of projects to projects that were created using this project name." - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "dueFrom", - "description": "Filter the list of projects to projects that are due after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" - }, + } + } + } + } + }, + "/pricing-models/{pricingModelId}": { + "get": { + "tags": [ + "Pricing Model" + ], + "summary": "Get Pricing Model", + "description": "Retrieves a pricing model by identifier.", + "parameters": [ { - "schema": { - "type": "string" - }, - "in": "query", - "name": "dueTo", - "description": "Filter the list of projects to projects that are due before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + "$ref": "#/components/parameters/Authorization" }, { - "schema": { - "type": "string" - }, - "in": "query", - "name": "lastModifiedFrom", - "description": "Filter the list of projects to projects that are last modified after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + "$ref": "#/components/parameters/X-LC-Tenant" }, { - "schema": { - "type": "string" - }, - "in": "query", - "name": "lastModifiedTo", - "description": "Filter the list of projects to projects that are last modified before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + "$ref": "#/components/parameters/fields" } ], "responses": { @@ -3788,82 +4015,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-projects-response" - }, - "examples": { - "numbers": { - "value": { - "itemCount": 1, - "items": [ - { - "id": "test-id", - "quote": { - "additionalCosts": [ - { - "name": "test-additional-cost-name", - "count": 1, - "runningTotal": 1 - } - ] - } - } - ] - } - }, - "missing-required-integer": { - "value": { - "items": [ - { - "id": "test-id", - "quote": { - "additionalCosts": [ - { - "name": "test-additional-cost-name", - "count": 1, - "runningTotal": 1 - } - ] - } - } - ] - } - }, - "missing-optional-integer": { - "value": { - "itemCount": 1, - "items": [ - { - "id": "test-id", - "quote": { - "additionalCosts": [ - { - "name": "test-additional-cost-name", - "runningTotal": 1 - } - ] - } - } - ] - } - }, - "missing-optional-double": { - "value": { - "itemCount": 1, - "items": [ - { - "id": "test-id", - "quote": { - "additionalCosts": [ - { - "name": "test-additional-cost-name", - "count": 1 - } - ] - } - } - ] - } - } + "$ref": "#/components/schemas/pricing-model" } } }, @@ -3903,8 +4055,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the pricing model.", "content": { "application/json": { "schema": { @@ -3917,51 +4069,13 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "ListProjects" - }, - "post": { - "tags": [ - "Project" - ], - "summary": "Create Project", - "description": "Creates a new project.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when creating projects.\n\nThe values from a selected project template will take precedence over the individual resources when creating a new project.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-create-request" - } - } }, - "required": true - }, - "responses": { - "201": { - "description": "", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "minimal": { - "value": { - "id": "string" - } - } + "$ref": "#/components/schemas/error-response" } } }, @@ -3970,82 +4084,96 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "GetPricingModel" + }, + "parameters": [ + { + "$ref": "#/components/parameters/pricingModelId" + } + ], + "put": { + "summary": "Update Pricing Model", + "tags": [ + "Pricing Model" + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "description": "Error codes:\r\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\r\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\r\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\r\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. ", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to update the pricing model.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n\"forbidden\": \n- The authenticated user is not allowed to create the project in the specified location.\n- Your subscription does not include access to the requested type of benefit.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "CreateProject" - } - }, - "/projects/{projectId}": { - "get": { - "tags": [ - "Project" - ], - "summary": "Get Project", - "description": "Retrieves a project by identifier.", + "operationId": "UpdatePricingModel", + "x-stoplight": { + "id": "519y1mm5q2twn" + }, + "description": "Updates a pricing model.", "parameters": [ - { - "$ref": "#/components/parameters/fields" - }, { "$ref": "#/components/parameters/Authorization" }, @@ -4053,93 +4181,24 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project" - }, - "examples": { - "valid-response": { - "value": { - "id": "test-id", - "name": "test-name", - "description": "test-description", - "dueBy": "2042-07-28T11:13:36.000Z", - "createdAt": "2021-07-28T11:13:36.000Z", - "status": "completed", - "languageDirections": [ - { - "id": "language-direction-id", - "sourceLanguage": { - "languageCode": "test-source-languageCode", - "isNeutral": false - }, - "targetLanguage": { - "languageCode": "test-target-languageCode", - "isNeutral": true - } - } - ] - } - }, - "missing-required-string": { - "value": { - "name": "test-name", - "description": "test-description", - "dueBy": "2042-07-28T11:13:36.000Z", - "createdAt": "2021-07-28T11:13:36.000Z", - "status": "completed" - } - }, - "missing-optional-string": { - "value": { - "id": "test-id", - "description": "test-description", - "dueBy": "2042-07-28T11:13:36.000Z", - "createdAt": "2021-07-28T11:13:36.000Z", - "status": "completed" - } - }, - "missing-optional-datetime": { - "value": { - "id": "test-id", - "name": "test-name", - "description": "test-description", - "createdAt": "2021-07-28T11:13:36.000Z", - "status": "completed" - } - }, - "missing-optional-enum": { - "value": { - "id": "test-id", - "name": "test-name", - "description": "test-description", - "dueBy": "2042-07-28T11:13:36.000Z", - "createdAt": "2021-07-28T11:13:36.000Z" - } - }, - "missing-optional-boolean": { - "value": { - "id": "test-id", - "languageDirections": [ - { - "id": "language-direction-id", - "sourceLanguage": { - "languageCode": "test-source-languageCode" - }, - "targetLanguage": { - "languageCode": "test-target-languageCode" - } - } - ] - } - } - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/pricing-model-update-request" } - }, + } + } + } + }, + "delete": { + "summary": "Delete Pricing Model", + "tags": [ + "Pricing Model" + ], + "responses": { + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4163,36 +4222,36 @@ }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\r\n* \"forbidden\": the authenticated user is not allowed to delete the pricing model.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "Error codes:\r\n* \"notFound\": the pricing model could not be found by identifier.", "content": { "application/json": { "schema": { @@ -4207,14 +4266,10 @@ } } }, - "operationId": "GetProject" - }, - "put": { - "tags": [ - "Project" - ], - "summary": "Update Project", - "description": "Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). \n\nProject rescheduling (updating dueBy) is permitted only if: \n* there is no Customer Quote Approval task in the associated flow \n* at least one Customer Quote Approval was closed(in case multiple project batches) \n\nUpdate `projectPlan.taskConfigurations` are now permitted before project is started. Elements are now pre-populated at project creation time.", + "operationId": "DeletePricingModel", + "x-stoplight": { + "id": "48vkxmoxbdoz0" + }, "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -4223,19 +4278,252 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-update-request" - } - } - }, - "required": true - }, + "description": "Deletes a pricing model." + } + }, + "/projects": { + "get": { + "tags": [ + "Project" + ], + "summary": "List Projects", + "description": "Retrieves a list of all the projects in the account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "schema": { + "type": "boolean" + }, + "in": "query", + "name": "excludeOnline", + "description": "Excludes projects that are being worked on exclusively in the Online Editor" + }, + { + "schema": { + "type": "string", + "enum": [ + "created", + "inProgress", + "completed", + "archived" + ] + }, + "in": "query", + "name": "status", + "description": "Filter the list to include projects that have this status." + }, + { + "schema": { + "type": "string", + "format": "date-time", + "example": "2022-11-28T16:46:00.00Z" + }, + "in": "query", + "name": "createdFrom", + "description": "Filter the list to include only projects created after the specified date and time." + }, + { + "schema": { + "type": "string", + "format": "date-time", + "example": "2022-11-28T16:46:00.00Z" + }, + "in": "query", + "name": "createdTo", + "description": "Filter the list to include only projects created before the specified date and time." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "createdBy", + "description": "Filter the list of projects to projects that were created by this user." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "projectTemplateId", + "description": "Filter the list of projects to projects that were created using this project template." + }, + { + "schema": { + "type": "array", + "items": { + "type": "string" + } + }, + "in": "query", + "name": "projectIds", + "description": "Filter the list of projects to projects have these project identifiers." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "sourceLanguage", + "description": "Filter the list of projects to projects that were created using this source language." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "targetLanguage", + "description": "Filter the list of projects to projects that were created using this target language." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "projectName", + "description": "Filter the list of projects to projects that were created using this project name." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "dueFrom", + "description": "Filter the list of projects to projects that are due after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "dueTo", + "description": "Filter the list of projects to projects that are due before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "lastModifiedFrom", + "description": "Filter the list of projects to projects that are last modified after this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "lastModifiedTo", + "description": "Filter the list of projects to projects that are last modified before this date and time.
Accepted format: ISO-8601 `YYYY-MM-DDThh:mm:ss.sssZ`" + } + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-projects-response" + }, + "examples": { + "numbers": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1, + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-required-integer": { + "value": { + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1, + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-optional-integer": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "runningTotal": 1 + } + ] + } + } + ] + } + }, + "missing-optional-double": { + "value": { + "itemCount": 1, + "items": [ + { + "id": "test-id", + "quote": { + "additionalCosts": [ + { + "name": "test-additional-cost-name", + "count": 1 + } + ] + } + } + ] + } + } + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4243,7 +4531,7 @@ } }, "400": { - "description": "Error responses:\n\n* “invalid”: invalid input on update quote model\n* “invalidStatus”: the quote cannot be edited, the project is in a phase which doesn't allow the quote to be edited\n* \"conflict\": the project does not have a quote to be updated\n* \"limit.exceeded\": a maximum number of users per task was assigned\n \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -4272,8 +4560,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Project.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -4286,13 +4574,51 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier.", - "content": { + } + }, + "operationId": "ListProjects" + }, + "post": { + "tags": [ + "Project" + ], + "summary": "Create Project", + "description": "Creates a new project.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when creating projects.\n\nThe values from a selected project template will take precedence over the individual resources when creating a new project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-create-request" + } + } + }, + "required": true + }, + "responses": { + "201": { + "description": "", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/project" + }, + "examples": { + "minimal": { + "value": { + "id": "string" + } + } } } }, @@ -4302,8 +4628,8 @@ } } }, - "409": { - "description": "Error responses:\n\n* “invalidStatus”: a field cannot be edited, because the project is in a status which doesn't allow the field to be edited. `details.name` will provide the field name which is not allowed to be edited.\n\n* updateNotAllowed: a field of the project cannot be edited before the completion of customer approval.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"missing\": Missing required field for the value mentioned in the \"name\" field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { @@ -4316,32 +4642,6 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "UpdateProject" - }, - "delete": { - "tags": [ - "Project" - ], - "summary": "Delete Project", - "description": "Deletes a project.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } }, "401": { "description": "The user could not be identified.", @@ -4359,7 +4659,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project.", + "description": "Error codes:\n\"forbidden\": \n- The authenticated user is not allowed to create the project in the specified location.\n- Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { @@ -4374,7 +4674,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -4389,25 +4689,111 @@ } } }, - "operationId": "DeleteProject" - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - } - ] + "operationId": "CreateProject" + } }, - "/projects/{projectId}/configuration": { + "/projects/{projectId}": { "get": { - "summary": "Get Project Configuration", - "description": "Get the configuration settings of an existing project.", + "tags": [ + "Project" + ], + "summary": "Get Project", + "description": "Retrieves a project by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project-configuration" + "$ref": "#/components/schemas/project" + }, + "examples": { + "valid-response": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed", + "languageDirections": [ + { + "id": "language-direction-id", + "sourceLanguage": { + "languageCode": "test-source-languageCode", + "isNeutral": false + }, + "targetLanguage": { + "languageCode": "test-target-languageCode", + "isNeutral": true + } + } + ] + } + }, + "missing-required-string": { + "value": { + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-string": { + "value": { + "id": "test-id", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-datetime": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "createdAt": "2021-07-28T11:13:36.000Z", + "status": "completed" + } + }, + "missing-optional-enum": { + "value": { + "id": "test-id", + "name": "test-name", + "description": "test-description", + "dueBy": "2042-07-28T11:13:36.000Z", + "createdAt": "2021-07-28T11:13:36.000Z" + } + }, + "missing-optional-boolean": { + "value": { + "id": "test-id", + "languageDirections": [ + { + "id": "language-direction-id", + "sourceLanguage": { + "languageCode": "test-source-languageCode" + }, + "targetLanguage": { + "languageCode": "test-target-languageCode" + } + } + ] + } + } } } }, @@ -4448,7 +4834,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to get the project configuration.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -4478,32 +4864,35 @@ } } }, - "operationId": "GetProjectConfiguration", + "operationId": "GetProject" + }, + "put": { + "tags": [ + "Project" + ], + "summary": "Update Project", + "description": "Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386). \n\nProject rescheduling (updating dueBy) is permitted only if: \n* there is no Customer Quote Approval task in the associated flow \n* at least one Customer Quote Approval was closed(in case multiple project batches) \n\nUpdate `projectPlan.taskConfigurations` are now permitted before project is started. Elements are now pre-populated at project creation time.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], - "tags": [ - "Project" - ] - }, - "put": { - "summary": "Update Project Configuration", - "description": "Updates the configuration settings for an existing project.", - "operationId": "UpdateProjectConfiguration", - "tags": [ - "Project" - ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-update-request" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "", + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4511,7 +4900,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error responses:\n\n* “invalid”: invalid input on update quote model\n* “invalidStatus”: the quote cannot be edited, the project is in a phase which doesn't allow the quote to be edited\n* \"conflict\": the project does not have a quote to be updated\n* \"limit.exceeded\": a maximum number of users per task was assigned\n \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { @@ -4541,7 +4930,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Project.", "content": { "application/json": { "schema": { @@ -4556,7 +4945,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier.", "content": { "application/json": { "schema": { @@ -4569,58 +4958,42 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-configuration-request" + }, + "409": { + "description": "Error responses:\n\n* “invalidStatus”: a field cannot be edited, because the project is in a status which doesn't allow the field to be edited. `details.name` will provide the field name which is not allowed to be edited.\n\n* updateNotAllowed: a field of the project cannot be edited before the completion of customer approval.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" } } } }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ] + "operationId": "UpdateProject" }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - } - ] - }, - "/projects/{projectId}/pricing-model": { - "put": { + "delete": { "tags": [ "Project" ], - "summary": "Update Project Pricing Model", - "description": "Update project pricing model only during Customer Quote Review task type.", - "operationId": "UpdateProjectPricingModel", + "summary": "Delete Project", + "description": "Deletes a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], "responses": { "204": { - "description": "", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalidPricingModel”: There is mismatch configuration between the project and the new pricing model.\n* \"differentCurrencyCode\": There is a mismatch between the provided pricing model currency and the pricing model currency in the project.\n* “differentFuzzyBands”: There is a mismatch between the provided pricing model fuzzy bands and the pricing model fuzzy bands in the project.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4643,7 +5016,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project.", "content": { "application/json": { "schema": { @@ -4658,7 +5031,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { @@ -4673,27 +5046,7 @@ } } }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-pricing-model-update-request" - } - } - }, - "required": true - }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "x-stoplight": { - "id": "ypm1hf7wad9at" - } + "operationId": "DeleteProject" }, "parameters": [ { @@ -4701,36 +5054,17 @@ } ] }, - "/projects/{projectId}/start": { - "put": { - "tags": [ - "Project" - ], - "summary": "Start Project", - "description": "Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "/projects/{projectId}/configuration": { + "get": { + "summary": "Get Project Configuration", + "description": "Get the configuration settings of an existing project.", "responses": { - "202": { - "description": "Accepted", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/project-configuration" } } }, @@ -4740,8 +5074,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -4755,8 +5089,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to start the project.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -4770,8 +5104,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to get the project configuration.", "content": { "application/json": { "schema": { @@ -4785,8 +5119,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": the project's status doesn't permit the start operation.\n* \"missingTranslatableFile\": there was no translatable file attached to the project.\n* \"missingWorkflow\": there was no workflow associated with the project.\n* \"invalidWorkflow\" : the workflow associated with the project is invalid or has errors.\n* \"missingConfigurations\": not all manual task templates have configurations.", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -4801,32 +5135,32 @@ } } }, - "operationId": "StartProject" - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - } - ] - }, - "/projects/{projectId}/complete": { - "put": { - "tags": [ - "Project" - ], - "summary": "Complete Project", - "description": "Marks a project as \"completed\".", + "operationId": "GetProjectConfiguration", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], + "tags": [ + "Project" + ] + }, + "put": { + "summary": "Update Project Configuration", + "description": "Updates the configuration settings for an existing project.", + "operationId": "UpdateProjectConfiguration", + "tags": [ + "Project" + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4849,7 +5183,7 @@ } }, "401": { - "description": "Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -4864,7 +5198,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the project.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", "content": { "application/json": { "schema": { @@ -4892,24 +5226,25 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "409": { - "description": "Error codes:\n* \"projectAlreadyCompleted\": the project it is already in completed state.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-configuration-request" } } } }, - "operationId": "CompleteProject" + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] }, "parameters": [ { @@ -4917,43 +5252,17 @@ } ] }, - "/projects/{projectId}/source-files": { - "get": { + "/projects/{projectId}/pricing-model": { + "put": { "tags": [ - "Source File" - ], - "summary": "List Source Files", - "description": "Retrieves the source files in a project.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "$ref": "#/components/parameters/fields" - } + "Project" ], + "summary": "Update Project Pricing Model", + "description": "Update project pricing model only during Customer Quote Review task type.", + "operationId": "UpdateProjectPricingModel", "responses": { - "200": { + "204": { "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/list-source-files-response" - } - } - }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -4961,7 +5270,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalidPricingModel”: There is mismatch configuration between the project and the new pricing model.\n* \"differentCurrencyCode\": There is a mismatch between the provided pricing model currency and the pricing model currency in the project.\n* “differentFuzzyBands”: There is a mismatch between the provided pricing model fuzzy bands and the pricing model fuzzy bands in the project.", "content": { "application/json": { "schema": { @@ -4991,7 +5300,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": not authorized to retrieve source files on the project.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project configuration.", "content": { "application/json": { "schema": { @@ -5006,7 +5315,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -5019,31 +5328,43 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-pricing-model-update-request" } } - } + }, + "required": true }, - "operationId": "ListSourceFiles" - }, - "post": { + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "x-stoplight": { + "id": "ypm1hf7wad9at" + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/start": { + "put": { "tags": [ - "Source File" + "Project" ], - "summary": "Add Source File", - "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.", + "summary": "Start Project", + "description": "Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -5052,38 +5373,21 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "required": [ - "properties", - "file" - ], - "properties": { - "properties": { - "$ref": "#/components/schemas/source-file-request" - }, - "file": { - "type": "string", - "format": "binary", - "description": "The source file (binary string)." - } - } + "responses": { + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" } } }, - "required": true, - "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.md)." - }, - "responses": { - "201": { - "description": "", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/source-file" + "$ref": "#/components/schemas/error-response" } } }, @@ -5093,8 +5397,8 @@ } } }, - "400": { - "description": "Error responses:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -5108,8 +5412,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to start the project.", "content": { "application/json": { "schema": { @@ -5123,8 +5427,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a source file to the project.", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -5139,7 +5443,7 @@ } }, "409": { - "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"projectAlreadyCompleted\": resource can not be added because the project it is in completed state.", + "description": "Error codes:\n* \"invalidStatus\": the project's status doesn't permit the start operation.\n* \"missingTranslatableFile\": there was no translatable file attached to the project.\n* \"missingWorkflow\": there was no workflow associated with the project.\n* \"invalidWorkflow\" : the workflow associated with the project is invalid or has errors.\n* \"missingConfigurations\": not all manual task templates have configurations.", "content": { "application/json": { "schema": { @@ -5154,19 +5458,29 @@ } } }, - "operationId": "AddSourceFile" + "operationId": "StartProject" }, "parameters": [ { "$ref": "#/components/parameters/projectId" } - ], + ] + }, + "/projects/{projectId}/complete": { "put": { "tags": [ - "Source File" + "Project" + ], + "summary": "Complete Project", + "description": "Marks a project as \"completed\".", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } ], - "summary": "Update Source Files", - "operationId": "UpdateSourceFiles", "responses": { "204": { "description": "No Content", @@ -5177,311 +5491,223 @@ } }, "400": { - "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "401": { + "description": "Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "401": { - "description": "The user could not be identified.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the source file.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "409": { + "description": "Error codes:\n* \"projectAlreadyCompleted\": the project it is already in completed state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." - } - }, - "description": "Updates multiple source files. If any of the files fails to be updated, an error will be returned for each file. ", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/source-files-update-request" + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" } } } + }, + "operationId": "CompleteProject" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" } - } + ] }, - "/projects/{projectId}/source-files/attach-files": { + "/projects/{projectId}/files/exports": { "post": { "tags": [ - "Source File" + "Project" ], - "summary": "Attach Source Files", - "description": "Adds multiple source files to the project. Files must be uploaded before attaching them to a project. When a file is attached after the project was started, a new start project request should be performed.\n\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", + "summary": "Export Project Files", + "operationId": "ExportProjectFiles", + "description": "Generates an asynchronous export operation. To monitor the progress until completion, use the [Poll Project Files Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}/get) endpoint. \n\nThis operation triggers the packaging of the project files into a `zip` format.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/source-file-attachment-request" - } - } - }, - "required": true, - "description": "" - }, "responses": { - "201": { - "description": "", + "200": { + "description": "Export Operation was triggered successfully", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/source-file-attachment-response" + "$ref": "#/components/schemas/zip-file-export-response" } } - }, + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "400": { - "description": "Error codes:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to trigger an export on the specified project, or does not have access to the project.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to attach a source file on the project.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"duplicate\": duplicate fileUrl inside a project is not allowed.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/zip-file-export-request" } } } }, - "operationId": "AddSourceFiles" + "x-stoplight": { + "id": "5hbbqpkqxmfyt" + } }, "parameters": [ { - "name": "projectId", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The project identifier." + "$ref": "#/components/parameters/projectId" } ] }, - "/projects/{projectId}/source-files/{sourceFileId}": { + "/projects/{projectId}/files/exports/{exportId}": { "get": { "tags": [ - "Source File" - ], - "summary": "Get Source File", - "description": "Retrieves a source file from the project.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } + "Project" ], + "summary": "Poll Project Files Export", + "operationId": "ExportProjectFilesStatus", + "description": "Retrieves the state of the export operation. \n\n Once the state is marked as `done`, you can download the generated `zip` file using the following endpoint: [Download Exported Project Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}~1download/get).", "responses": { "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/source-file" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/zip-file-export-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "operationId": "GetSourceFile" - }, - "put": { - "tags": [ - "Source File" - ], - "summary": "Update Source File", - "operationId": "UpdateSourceFile", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "400": { @@ -5515,7 +5741,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to retrieve the details of the export.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -5530,7 +5756,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the export operation could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -5543,57 +5769,58 @@ } } } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, - "description": "Updates a source file.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/source-file-rename-request" - } - } + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "schema": { + "type": "string" + }, + "name": "exportId", + "in": "path", + "required": true, + "description": "The export identifier." } - }, - "parameters": [] + ], + "x-stoplight": { + "id": "uyc9zdzlangtw" + } }, "parameters": [ { "$ref": "#/components/parameters/projectId" - }, - { - "$ref": "#/components/parameters/sourceFileId" } ] }, - "/projects/{projectId}/source-files/{sourceFileId}/versions": { + "/projects/{projectId}/files/exports/{exportId}/download": { "get": { "tags": [ - "Source File" + "Project" ], - "summary": "List Source File Versions", - "description": "Retrieves all the versions of a source file.", + "summary": "Download Exported Project Files", + "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports/post) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/list-source-file-versions-response" + "type": "string", + "format": "binary" } } }, @@ -5604,7 +5831,22 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -5618,8 +5860,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -5633,8 +5875,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the source file versions.", + "404": { + "description": "Error codes:\n* \"notFound\": the file could not be found by identifier.\n", "content": { "application/json": { "schema": { @@ -5648,8 +5890,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", + "409": { + "description": "Error codes:\n* \"conflict\": the export operation is not done yet.\n", "content": { "application/json": { "schema": { @@ -5664,51 +5906,67 @@ } } }, - "operationId": "ListSourceFileVersions" - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - }, - { - "$ref": "#/components/parameters/sourceFileId" + "x-codegen-download": true, + "operationId": "DownloadFile", + "x-stoplight": { + "id": "r8ac4c1ortxtw" } - ] - }, - "/tasks/{taskId}/source-files/{sourceFileId}/versions": { + }, "parameters": [ { - "name": "sourceFileId", - "in": "path", - "required": true, "schema": { "type": "string" }, - "description": "The source file identifier." + "name": "projectId", + "in": "path", + "required": true, + "description": "The identifier of the project." }, { "schema": { "type": "string" }, - "name": "taskId", + "name": "exportId", "in": "path", "required": true, - "description": "The task identifier." + "description": "The identifier of the export operation." } - ], - "post": { - "summary": "Add Source File Version", + ] + }, + "/projects/{projectId}/source-files": { + "get": { "tags": [ "Source File" ], - "operationId": "AddSourceFileVersion", + "summary": "List Source Files", + "description": "Retrieves the source files in a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], "responses": { - "201": { - "description": "Created", + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/source-file-version-response" + "$ref": "#/components/schemas/list-source-files-response" } } }, @@ -5719,7 +5977,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in body is not correct. `properties` must be the first, followed by `file`.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -5749,7 +6007,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "description": "Error codes:\n* \"forbidden\": not authorized to retrieve source files on the project.", "content": { "application/json": { "schema": { @@ -5764,7 +6022,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the source file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as source file and is used a target file identifier.", + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { @@ -5778,8 +6036,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding source file version is not allowed when the task is completed.\n* \"unsupported\" : you cannot add a source file version for this task.\n* \"duplicate\": a file with the same name already exists.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -5794,6 +6052,22 @@ } } }, + "operationId": "ListSourceFiles" + }, + "post": { + "tags": [ + "Source File" + ], + "summary": "Add Source File", + "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) endpoint.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], "requestBody": { "content": { "multipart/form-data": { @@ -5805,8 +6079,7 @@ ], "properties": { "properties": { - "$ref": "#/components/schemas/source-file-version-properties-create-request", - "description": "Source file properties sent as a JSON inside a text part." + "$ref": "#/components/schemas/source-file-request" }, "file": { "type": "string", @@ -5817,45 +6090,16 @@ } } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." - }, - "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.md) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}/put).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint.\n\nThe [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ] - } - }, - "/projects/{projectId}/source-files/{sourceFileId}/versions/{fileVersionId}/download": { - "get": { - "tags": [ - "Source File" - ], - "summary": "Download Source File Version", - "description": "Downloads a source file version.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "required": true, + "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.md)." + }, "responses": { - "200": { + "201": { "description": "", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/source-file" } } }, @@ -5865,8 +6109,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error responses:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -5880,8 +6124,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -5895,8 +6139,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project, the source file or the file version could not be found by identifier.\n", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a source file to the project.", "content": { "application/json": { "schema": { @@ -5910,8 +6154,8 @@ } } }, - "422": { - "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", + "409": { + "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"projectAlreadyCompleted\": resource can not be added because the project it is in completed state.", "content": { "application/json": { "schema": { @@ -5926,43 +6170,155 @@ } } }, - "x-codegen-download": true, - "operationId": "DownloadSourceFileVersion" + "operationId": "AddSourceFile" }, "parameters": [ { "$ref": "#/components/parameters/projectId" + } + ], + "put": { + "tags": [ + "Source File" + ], + "summary": "Update Source Files", + "operationId": "UpdateSourceFiles", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the source file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } }, - { - "$ref": "#/components/parameters/sourceFileId" - }, - { - "$ref": "#/components/parameters/fileVersionId" + "description": "Updates multiple source files. If any of the files fails to be updated, an error will be returned for each file. ", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-files-update-request" + } + } + } } - ] + } }, - "/tasks/{taskId}/source-files/{sourceFileId}": { - "get": { + "/projects/{projectId}/source-files/attach-files": { + "post": { "tags": [ "Source File" ], - "summary": "Get Source File Properties", - "description": "Retrieves the properties for a source file.", + "summary": "Attach Source Files", + "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-attachment-request" + } + } + }, + "required": true, + "description": "" + }, "responses": { - "200": { + "201": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/source-file-properties-response" + "$ref": "#/components/schemas/source-file-attachment-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": invalid input on for the value mentioned in the “name” field on the error response.\n* \"empty\": missing input for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" } } }, @@ -5988,7 +6344,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to attach a source file on the project.", "content": { "application/json": { "schema": { @@ -6002,8 +6358,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the task or source file could not be found by id.\n", + "409": { + "description": "Error codes:\n* \"duplicate\": duplicate source file name inside a project is not allowed.\n* \"duplicate\": duplicate fileUrl inside a project is not allowed.", "content": { "application/json": { "schema": { @@ -6018,37 +6374,48 @@ } } }, - "operationId": "GetSourceFileProperties" + "operationId": "AddSourceFiles" }, "parameters": [ { - "schema": { - "type": "string" - }, - "name": "taskId", + "name": "projectId", "in": "path", "required": true, - "description": "The task identifier." - }, - { "schema": { "type": "string" }, - "name": "sourceFileId", - "in": "path", - "required": true, - "description": "The source file identifier." + "description": "The project identifier." } - ], - "put": { - "summary": "Update Source File Properties", + ] + }, + "/projects/{projectId}/source-files/{sourceFileId}": { + "get": { "tags": [ "Source File" ], - "operationId": "UpdateSourceProperties", + "summary": "Get Source File", + "description": "Retrieves a source file from the project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -6056,7 +6423,7 @@ } }, "400": { - "description": "Error responses:\n* “invalid”: invalid input on update source file properties.", + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -6086,7 +6453,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the resource.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -6101,137 +6468,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - the specified task or the source file was not found.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "409": { - "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"taskCompleted\": updating the source file properties is not allowed when the task is completed.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](../reference/Public-API.v1.json/paths/~1file-processing-configurations/get) endpoint.", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/source-file-properties-update-request" - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ] - } - }, - "/projects/{projectId}/target-files/{targetFileId}": { - "get": { - "tags": [ - "Target File" - ], - "summary": "Get Target File", - "description": "Retrieves a target file from a project.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/target-file" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "content": { "application/json": { "schema": { @@ -6246,14 +6483,14 @@ } } }, - "operationId": "GetTargetFile" + "operationId": "GetSourceFile" }, "put": { "tags": [ - "Target File" + "Source File" ], - "summary": "Update Target File", - "operationId": "UpdateTargetFile", + "summary": "Update Source File", + "operationId": "UpdateSourceFile", "responses": { "204": { "description": "No Content", @@ -6309,7 +6546,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -6327,33 +6564,34 @@ "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, - "description": "Updates a target file.", + "description": "Updates a source file.", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/target-file-rename-request" + "$ref": "#/components/schemas/source-file-rename-request" } } } - } + }, + "parameters": [] }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { - "$ref": "#/components/parameters/targetFileId" + "$ref": "#/components/parameters/sourceFileId" } ] }, - "/projects/{projectId}/target-files": { + "/projects/{projectId}/source-files/{sourceFileId}/versions": { "get": { "tags": [ - "Target File" + "Source File" ], - "summary": "List Target Files", - "description": "Retrieves the target files for a project.", + "summary": "List Source File Versions", + "description": "Retrieves all the versions of a source file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6361,38 +6599,6 @@ { "$ref": "#/components/parameters/X-LC-Tenant" }, - { - "name": "targetFileIds", - "in": "query", - "description": "Filter target files by identifiers.", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "sourceFileIds", - "in": "query", - "description": "Filter target files by the identifiers of the source file they were generated from.", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, { "$ref": "#/components/parameters/fields" } @@ -6403,7 +6609,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-target-files-response" + "$ref": "#/components/schemas/list-source-file-versions-response" } } }, @@ -6444,7 +6650,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the target files on the project.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the source file versions.", "content": { "application/json": { "schema": { @@ -6459,7 +6665,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project or the source file could not be found by identifier.", "content": { "application/json": { "schema": { @@ -6472,13 +6678,53 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "ListSourceFileVersions" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/sourceFileId" + } + ] + }, + "/tasks/{taskId}/source-files/{sourceFileId}/versions": { + "parameters": [ + { + "name": "sourceFileId", + "in": "path", + "required": true, + "schema": { + "type": "string" }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "description": "The source file identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." + } + ], + "post": { + "summary": "Add Source File Version", + "tags": [ + "Source File" + ], + "operationId": "AddSourceFileVersion", + "responses": { + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/source-file-version-response" } } }, @@ -6487,131 +6733,145 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "ListTargetFiles" - }, - "put": { - "tags": [ - "Target File" - ], - "summary": "Update Target Files", - "operationId": "UpdateTargetFiles", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } }, "400": { - "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in body is not correct. `properties` must be the first, followed by `file`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "401": { "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the file.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the source file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as source file and is used a target file identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "409": { + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding source file version is not allowed when the task is completed.\n* \"unsupported\" : you cannot add a source file version for this task.\n* \"duplicate\": a file with the same name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, - "description": "Updates multiple target files. If any of the files fails to be updated, an error will be returned for each file. ", "requestBody": { "content": { - "application/json": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/target-files-update-request" + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/source-file-version-properties-create-request", + "description": "Source file properties sent as a JSON inside a text part." + }, + "file": { + "type": "string", + "format": "binary", + "description": "The source file (binary string)." + } + } } } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + }, + "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.md) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}/put).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint.\n\nThe [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - } - ] + ] + } }, - "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}": { + "/projects/{projectId}/source-files/{sourceFileId}/versions/{fileVersionId}/download": { "get": { "tags": [ - "Target File" + "Source File" ], - "summary": "Get Target File Version", - "description": "Retrieves one version of a target file.", + "summary": "Download Source File Version", + "description": "Downloads a source file version.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/target-file-version" + "type": "string", + "format": "binary" } } }, @@ -6621,8 +6881,8 @@ } } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -6636,8 +6896,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -6651,8 +6911,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "404": { + "description": "Error codes:\n* \"notFound\": the project, the source file or the file version could not be found by identifier.\n", "content": { "application/json": { "schema": { @@ -6666,8 +6926,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project, the target file or its version could not be found by identifier.", + "422": { + "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", "content": { "application/json": { "schema": { @@ -6682,36 +6942,34 @@ } } }, - "operationId": "GetTargetFileVersion" + "x-codegen-download": true, + "operationId": "DownloadSourceFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { - "$ref": "#/components/parameters/targetFileId" + "$ref": "#/components/parameters/sourceFileId" }, { "$ref": "#/components/parameters/fileVersionId" } ] }, - "/projects/{projectId}/target-files/{targetFileId}/versions": { + "/tasks/{taskId}/source-files/{sourceFileId}": { "get": { "tags": [ - "Target File" + "Source File" ], - "summary": "List Target File Versions", - "description": "Retrieves the versions of a target file.", + "summary": "Get Source File Properties", + "description": "Retrieves the properties for a source file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], "responses": { @@ -6720,22 +6978,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-target-file-versions-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/source-file-properties-response" } } }, @@ -6761,7 +7004,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve versions on the target file.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -6776,7 +7019,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the task or source file could not be found by id.\n", "content": { "application/json": { "schema": { @@ -6791,42 +7034,49 @@ } } }, - "operationId": "ListTargetFileVersions" + "operationId": "GetSourceFileProperties" }, "parameters": [ { - "$ref": "#/components/parameters/projectId" + "schema": { + "type": "string" + }, + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." }, { - "$ref": "#/components/parameters/targetFileId" + "schema": { + "type": "string" + }, + "name": "sourceFileId", + "in": "path", + "required": true, + "description": "The source file identifier." } - ] - }, - "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports": { - "post": { + ], + "put": { + "summary": "Update Source File Properties", "tags": [ - "Target File" - ], - "summary": "Export Target File Version", - "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}/get) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/export-format" - } + "Source File" ], + "operationId": "UpdateSourceProperties", "responses": { - "202": { - "description": "", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error responses:\n* “invalid”: invalid input on update source file properties.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/file-version-export" + "$ref": "#/components/schemas/error-response" } } }, @@ -6852,7 +7102,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to export the target file version.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the resource.", "content": { "application/json": { "schema": { @@ -6867,7 +7117,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project, the target file or the version could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": - the specified task or the source file was not found.", "content": { "application/json": { "schema": { @@ -6882,7 +7132,7 @@ } }, "409": { - "description": "Error codes:\n* \"invalidType\": The type of the target file doesn't allow the export operation.\n* \"conflict\": A target file version export is already in progress.", + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"taskCompleted\": updating the source file properties is not allowed when the task is completed.", "content": { "application/json": { "schema": { @@ -6897,27 +7147,16 @@ } } }, - "operationId": "ExportTargetFileVersion" - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - }, - { - "$ref": "#/components/parameters/targetFileId" + "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](../reference/Public-API.v1.json/paths/~1file-processing-configurations/get) endpoint.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/source-file-properties-update-request" + } + } + } }, - { - "$ref": "#/components/parameters/fileVersionId" - } - ] - }, - "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}": { - "get": { - "tags": [ - "Target File" - ], - "summary": "Poll Target File Version Export", - "description": "Polls a target file version via an export operation. The new version can be downloaded once the status is \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6925,14 +7164,49 @@ { "$ref": "#/components/parameters/X-LC-Tenant" } - ], - "responses": { - "200": { + ] + } + }, + "/projects/{projectId}/target-files/{targetFileId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Get Target File", + "description": "Retrieves a target file from a project.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/file-version-export" + "$ref": "#/components/schemas/target-file" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" } } }, @@ -6958,7 +7232,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the export.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -6973,7 +7247,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found.", + "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", "content": { "application/json": { "schema": { @@ -6988,118 +7262,97 @@ } } }, - "operationId": "PollTargetFileVersionExport" + "operationId": "GetTargetFile" }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - }, - { - "$ref": "#/components/parameters/targetFileId" - }, - { - "$ref": "#/components/parameters/fileVersionId" - }, - { - "$ref": "#/components/parameters/exportId" - } - ] - }, - "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}/download": { - "get": { + "put": { "tags": [ "Target File" ], - "summary": "Download Exported Target File Version", - "description": "Downloads a completed target file version via an export operation.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "summary": "Update Target File", + "operationId": "UpdateTargetFile", "responses": { - "200": { - "description": "", - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } - }, + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": not allowed to download the exported target file", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the target file.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": the export is not completed\n* \"conflict\": the export is not in a downloadable state due to another export, or the workflow has progressed since this export was requested", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." } }, - "x-codegen-download": true, - "operationId": "DownloadExportedTargetFileVersion" + "description": "Updates a target file.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/target-file-rename-request" + } + } + } + } }, "parameters": [ { @@ -7107,38 +7360,66 @@ }, { "$ref": "#/components/parameters/targetFileId" - }, - { - "$ref": "#/components/parameters/fileVersionId" - }, - { - "$ref": "#/components/parameters/exportId" } ] }, - "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download": { + "/projects/{projectId}/target-files": { "get": { "tags": [ "Target File" ], - "summary": "Download Target File Version", - "description": "Downloads the file version (native or BCM). \n\nIf the `fileVersionId` path parameter represents a native file version, the native file will be downloaded. If the `fileVersionId` is an identifier of a version in [BCM format](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html), the BCM file will be downloaded.", + "summary": "List Target Files", + "description": "Retrieves the target files for a project.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "targetFileIds", + "in": "query", + "description": "Filter target files by identifiers.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "sourceFileIds", + "in": "query", + "description": "Filter target files by the identifiers of the source file they were generated from.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" } ], "responses": { "200": { "description": "", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/list-target-files-response" } } }, @@ -7148,8 +7429,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -7163,8 +7444,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": not allowed to download the file version.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -7178,8 +7459,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the file version could not be found.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the target files on the project.", "content": { "application/json": { "schema": { @@ -7193,8 +7474,8 @@ } } }, - "409": { - "description": "error codes:\n* \"invalidType\": the type of the file version cannot be downloaded.", + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found by identifier.", "content": { "application/json": { "schema": { @@ -7208,8 +7489,8 @@ } } }, - "422": { - "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -7224,64 +7505,129 @@ } } }, - "x-codegen-download": true, - "operationId": "DownloadFileVersion" + "operationId": "ListTargetFiles" }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - }, - { - "$ref": "#/components/parameters/targetFileId" - }, - { - "$ref": "#/components/parameters/fileVersionId" - } - ] - }, - "/projects/{projectId}/target-files/{targetFileId}/versions/imports": { - "post": { + "put": { "tags": [ "Target File" ], - "summary": "Import Target File Version", - "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports~1{importId}/get) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + "summary": "Update Target Files", + "operationId": "UpdateTargetFiles", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "400": { + "description": "Error responses:\n* \"invalid\": invalid input for the value mentioned in the “name” field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - the authenticated user is not allowed to update the file.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the target file could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": a file with the same name already exists." + } + }, + "description": "Updates multiple target files. If any of the files fails to be updated, an error will be returned for each file. ", "requestBody": { "content": { - "multipart/form-data": { + "application/json": { "schema": { - "type": "object", - "required": [ - "file" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The target file (binary string)." - } - } + "$ref": "#/components/schemas/target-files-update-request" } } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Get Target File Version", + "description": "Retrieves one version of a target file.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "required": true, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." - }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/file-version-import" + "$ref": "#/components/schemas/target-file-version" } } }, @@ -7292,7 +7638,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid file uploaded, mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -7322,7 +7668,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to execute operation.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -7337,23 +7683,22 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"notFound\": the project, the target file or its version could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } } }, - "x-codegen-request-body-name": "body", - "operationId": "ImportTargetFileVersion" + "operationId": "GetTargetFileVersion" }, "parameters": [ { @@ -7361,22 +7706,28 @@ }, { "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" } ] }, - "/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}": { + "/projects/{projectId}/target-files/{targetFileId}/versions": { "get": { "tags": [ "Target File" ], - "summary": "Poll Target File Version Import", - "description": "Polls a target file version via an import operation. The new version can be seen on the file versions once the status is \"completed\".", + "summary": "List Target File Versions", + "description": "Retrieves the versions of a target file.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], "responses": { @@ -7385,7 +7736,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/file-version-import" + "$ref": "#/components/schemas/list-target-file-versions-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" } } }, @@ -7410,8 +7776,23 @@ } } }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve versions on the target file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, "404": { - "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", + "description": "Error codes:\n* \"notFound\": the project or the target file could not be found by identifier.", "content": { "application/json": { "schema": { @@ -7426,7 +7807,7 @@ } } }, - "operationId": "PollTargetFileVersionImport" + "operationId": "ListTargetFileVersions" }, "parameters": [ { @@ -7434,61 +7815,34 @@ }, { "$ref": "#/components/parameters/targetFileId" - }, - { - "$ref": "#/components/parameters/importId" } ] }, - "/tasks/{taskId}/target-files/{targetFileId}/versions": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "taskId", - "in": "path", - "required": true, - "description": "The task identifier." - }, - { - "schema": { - "type": "string" - }, - "name": "targetFileId", - "in": "path", - "required": true, - "description": "The target file identifier." - } - ], + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports": { "post": { - "summary": "Add Target File Version", "tags": [ "Target File" ], - "operationId": "AddTargetFileVersion", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/target-file-version-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "summary": "Export Target File Version", + "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}/get) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "400": { - "description": "Error codes:\n\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in the body is not correct. The `properties` must be first and then, file.", + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/export-format" + } + ], + "responses": { + "202": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/file-version-export" } } }, @@ -7514,7 +7868,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a version for the target file.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to export the target file version.", "content": { "application/json": { "schema": { @@ -7529,7 +7883,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the target file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as target file and is used a source file identifier.", + "description": "Error codes:\n* \"notFound\": the project, the target file or the version could not be found by identifier.", "content": { "application/json": { "schema": { @@ -7544,7 +7898,7 @@ } }, "409": { - "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding target file version is not allowed when the task is completed.\n* \"duplicate\": a file with the same name already exists.", + "description": "Error codes:\n* \"invalidType\": The type of the target file doesn't allow the export operation.\n* \"conflict\": A target file version export is already in progress.", "content": { "application/json": { "schema": { @@ -7559,52 +7913,45 @@ } } }, - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "required": [ - "properties", - "file" - ], - "properties": { - "properties": { - "$ref": "#/components/schemas/target-file-version-properties-create-request", - "description": "Target file properties sent as a JSON inside a text part." - }, - "file": { - "type": "string", - "format": "binary", - "description": "The target file (binary string)." - } - } - } - } - }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "operationId": "ExportTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" }, - "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post). More information about file formats can be found on the [File formats](../docs/File-formats.md) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Poll Target File Version Export", + "description": "Polls a target file version via an export operation. The new version can be downloaded once the status is \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } - ] - } - }, - "/projects/{projectId}/files/{fileId}/cancel": { - "put": { - "summary": "Cancel Project File", - "operationId": "CancelProjectFile", + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/file-version-export" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -7627,7 +7974,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to retrieve the export.", "content": { "application/json": { "schema": { @@ -7642,7 +7989,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the resource could not be found.", "content": { "application/json": { "schema": { @@ -7655,73 +8002,48 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "409": { - "description": "Error codes:\r\n* \"alreadyCanceled\": the file was already cancelled.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/error-response" - } - } - } } }, - "description": "Cancels a project file.", - "tags": [ - "Project" - ], - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ] + "operationId": "PollTargetFileVersionExport" }, "parameters": [ { "$ref": "#/components/parameters/projectId" }, { - "$ref": "#/components/parameters/fileId" + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + }, + { + "$ref": "#/components/parameters/exportId" } ] }, - "/projects/{projectId}/quote-report/export": { - "post": { - "summary": "Export Quote Report", - "operationId": "ExportQuoteReport", - "responses": { - "202": { - "description": "Accepted", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/export-quote-report-response", - "description": "Export quote report response.\n\nThe field is optional and will be returned only if a custom quote template is associated with the project.t.\n\nWe currently have this known issue: when the export is not using a Quote Template, the response for this call will be empty. It will be addressed in the future.e." - } - } - } + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports/{exportId}/download": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Download Exported Target File Version", + "description": "Downloads a completed target file version via an export operation.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "400": { - "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "200": { + "description": "", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/error-response" + "type": "string", + "format": "binary" } } }, @@ -7747,7 +8069,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource.", + "description": "Error codes:\n* \"forbidden\": not allowed to download the exported target file", "content": { "application/json": { "schema": { @@ -7762,7 +8084,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found.", + "description": "Error codes:\n* \"notFound\": the resource could not be found.", "content": { "application/json": { "schema": { @@ -7777,7 +8099,7 @@ } }, "409": { - "description": "Error codes:\n* \"conflict\": the project is in a phase which doesn’t allow the quote to be exported.", + "description": "Error codes:\n* \"invalidStatus\": the export is not completed\n* \"conflict\": the export is not in a downloadable state due to another export, or the workflow has progressed since this export was requested", "content": { "application/json": { "schema": { @@ -7792,44 +8114,62 @@ } } }, - "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get) to check when the export is completed.

\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.", + "x-codegen-download": true, + "operationId": "DownloadExportedTargetFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download": { + "get": { + "tags": [ + "Target File" + ], + "summary": "Download Target File Version", + "description": "Downloads the file version (native or BCM). \n\nIf the `fileVersionId` path parameter represents a native file version, the native file will be downloaded. If the `fileVersionId` is an identifier of a version in [BCM format](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html), the BCM file will be downloaded.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/quote-report-format" - }, - { - "$ref": "#/components/parameters/language-id" } ], - "tags": [ - "Quote" - ] - }, - "get": { - "summary": "Poll Quote Report Export", - "operationId": "PollQuoteReportExport", "responses": { "200": { "description": "", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "status": { - "type": "string", - "enum": [ - "inProgress", - "completed" - ] - } - } + "$ref": "#/components/schemas/error-response" } } }, @@ -7839,8 +8179,8 @@ } } }, - "400": { - "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "403": { + "description": "Error codes:\n* \"forbidden\": not allowed to download the file version.", "content": { "application/json": { "schema": { @@ -7854,8 +8194,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "404": { + "description": "Error codes:\n* \"notFound\": the file version could not be found.", "content": { "application/json": { "schema": { @@ -7869,8 +8209,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "409": { + "description": "error codes:\n* \"invalidType\": the type of the file version cannot be downloaded.", "content": { "application/json": { "schema": { @@ -7884,8 +8224,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found.", + "422": { + "description": "error codes:\n* \"maliciousContent\": the file contains malicious content. The infected file cannot be downloaded.", "content": { "application/json": { "schema": { @@ -7900,48 +8240,64 @@ } } }, - "description": "Polls a quote report via an export operation. The quote report can be [downloaded](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) once the status is \"completed\". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.", + "x-codegen-download": true, + "operationId": "DownloadFileVersion" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/fileVersionId" + } + ] + }, + "/projects/{projectId}/target-files/{targetFileId}/versions/imports": { + "post": { + "tags": [ + "Target File" + ], + "summary": "Import Target File Version", + "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports~1{importId}/get) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/quote-report-format" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "exportId", - "description": "The export identifier." } ], - "tags": [ - "Quote" - ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/projectId" - } - ] - }, - "/projects/{projectId}/quote-report/download": { - "get": { - "summary": "Download Exported Quote Report", - "operationId": "DownloadQuoteReport", + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The target file (binary string)." + } + } + } + } + }, + "required": true, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + }, "responses": { "200": { "description": "", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/file-version-import" } } }, @@ -7952,7 +8308,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error code “invalid” in case of:\n * Empty or missing file in request\n * Not valid multipart request\n * File parameter contains other extension than the one expected by specification.", "content": { "application/json": { "schema": { @@ -7982,7 +8338,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to execute operation.", "content": { "application/json": { "schema": { @@ -7997,77 +8353,41 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project could not be found.", + "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "description": "Downloads a quote report generated by the [asynchronous export operation](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/quote-report-format" - }, - { - "schema": { - "type": "string" - }, - "in": "query", - "name": "exportId", - "description": "The export identifier." - } - ], - "tags": [ - "Quote" - ] + "x-codegen-request-body-name": "body", + "operationId": "ImportTargetFileVersion" }, "parameters": [ { "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" } ] }, - "/projects/{projectId}/tasks": { + "/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}": { "get": { "tags": [ - "Project" + "Target File" ], - "summary": "List Project's Tasks", - "description": "Lists the tasks of a specific project.", + "summary": "Poll Target File Version Import", + "description": "Polls a target file version via an import operation. The new version can be seen on the file versions once the status is \"completed\".", "parameters": [ - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "$ref": "#/components/parameters/fields" - }, { "$ref": "#/components/parameters/Authorization" }, @@ -8081,7 +8401,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-tasks-response" + "$ref": "#/components/schemas/file-version-import" } } }, @@ -8106,8 +8426,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "404": { + "description": "Error codes:\n* \"notFound\": - the specified project or target file was not found.", "content": { "application/json": { "schema": { @@ -8122,51 +8442,54 @@ } } }, - "operationId": "ListProjectTasks" + "operationId": "PollTargetFileVersionImport" }, "parameters": [ { "$ref": "#/components/parameters/projectId" + }, + { + "$ref": "#/components/parameters/targetFileId" + }, + { + "$ref": "#/components/parameters/importId" } ] }, - "/project-groups": { - "get": { - "tags": [ - "Project Group" - ], - "summary": "List Project Groups", - "description": "Retrieves a list of all the project groups in an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" + "/tasks/{taskId}/target-files/{targetFileId}/versions": { + "parameters": [ + { + "schema": { + "type": "string" }, - { - "$ref": "#/components/parameters/location-strategy" + "name": "taskId", + "in": "path", + "required": true, + "description": "The task identifier." + }, + { + "schema": { + "type": "string" }, - { - "$ref": "#/components/parameters/fields" - } + "name": "targetFileId", + "in": "path", + "required": true, + "description": "The target file identifier." + } + ], + "post": { + "summary": "Add Target File Version", + "tags": [ + "Target File" ], + "operationId": "AddTargetFileVersion", "responses": { - "200": { - "description": "", + "201": { + "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-project-groups-response" + "$ref": "#/components/schemas/target-file-version-response" } } }, @@ -8177,7 +8500,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n\n* \"invalid\": invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalid\": the provided document is not a valid BCM file.\n* \"invalid\": invalid file format\n* \"multiPartOrder\": the multipart order in the body is not correct. The `properties` must be first and then, file.", "content": { "application/json": { "schema": { @@ -8206,8 +8529,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to add a version for the target file.", "content": { "application/json": { "schema": { @@ -8220,56 +8543,9 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "ListProjectGroups" - }, - "post": { - "tags": [ - "Project Group" - ], - "summary": "Create Project Group", - "description": "Creates a new project group.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-group-create-request" - } - } - }, - "required": true - }, - "responses": { - "201": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-group-create-response" - }, - "examples": {} - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "404": { + "description": "Error codes:\n* \"notFound\": \\\n \\- the specified task or the target file was not found.\\\n \\- the request is performed in a task that doesn't have the input file type as target file and is used a source file identifier.", "content": { "application/json": { "schema": { @@ -8283,8 +8559,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "409": { + "description": "Error codes:\n* \"noOwner\": the task has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"differentServiceUserOwner\": the authenticated service user is not the owner of the task.\n* \"taskCompleted\": adding target file version is not allowed when the task is completed.\n* \"duplicate\": a file with the same name already exists.", "content": { "application/json": { "schema": { @@ -8297,49 +8573,34 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to create the project group in the specified location.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" + } + }, + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/target-file-version-properties-create-request", + "description": "Target file properties sent as a JSON inside a text part." + }, + "file": { + "type": "string", + "format": "binary", + "description": "The target file (binary string)." + } } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } - } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." }, - "operationId": "CreateProjectGroup" - }, - "parameters": [] - }, - "/project-groups/{projectGroupId}": { - "get": { - "tags": [ - "Project Group" - ], - "summary": "Get Project Group", - "description": "Retrieves a project group by identifier.", + "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post). More information about file formats can be found on the [File formats](../docs/File-formats.md) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8350,25 +8611,24 @@ { "$ref": "#/components/parameters/fields" } - ], + ] + } + }, + "/projects/{projectId}/files/{fileId}/cancel": { + "put": { + "summary": "Cancel Project File", + "operationId": "CancelProjectFile", "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-group" - } - } - }, + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -8382,8 +8642,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource", "content": { "application/json": { "schema": { @@ -8397,8 +8657,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the project group.", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -8412,30 +8672,27 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "409": { + "description": "Error codes:\r\n* \"alreadyCanceled\": the file was already cancelled.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { + "type": "object", "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "GetProjectGroup" - }, - "put": { + "description": "Cancels a project file.", "tags": [ - "Project Group" + "Project" ], - "summary": "Update Project Group", - "description": "Updates the project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8443,29 +8700,40 @@ { "$ref": "#/components/parameters/X-LC-Tenant" } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-group-update-request" - } - } - }, - "required": true, - "description": "" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" }, + { + "$ref": "#/components/parameters/fileId" + } + ] + }, + "/projects/{projectId}/quote-report/export": { + "post": { + "summary": "Export Quote Report", + "operationId": "ExportQuoteReport", "responses": { - "204": { - "description": "No Content", + "202": { + "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/export-quote-report-response", + "description": "Export quote report response.\n\nThe field is optional and will be returned only if a custom quote template is associated with the project.t.\n\nWe currently have this known issue: when the export is not using a Quote Template, the response for this call will be empty. It will be addressed in the future.e." + } + } } }, "400": { - "description": "Error responses:\n\n* “invalid”: Invalid input on update project group model.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -8495,7 +8763,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project group.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read resource.", "content": { "application/json": { "schema": { @@ -8510,7 +8778,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { @@ -8525,48 +8793,70 @@ } }, "409": { - "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"conflict\": the project is in a phase which doesn’t allow the quote to be exported.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } } }, - "operationId": "UpdateProjectGroup" - }, - "delete": { - "tags": [ - "Project Group" - ], - "summary": "Delete Project Group", - "description": "Deletes a project group.", + "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get) to check when the export is completed.

\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/quote-report-format" + }, + { + "$ref": "#/components/parameters/language-id" } ], + "tags": [ + "Quote" + ] + }, + "get": { + "summary": "Poll Quote Report Export", + "operationId": "PollQuoteReportExport", "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "inProgress", + "completed" + ] + } + } + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -8580,8 +8870,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project group.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -8595,8 +8885,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -8610,8 +8900,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"conflict\": there might be projects that are still `attaching`.", + "404": { + "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { @@ -8626,27 +8916,7 @@ } } }, - "operationId": "DeleteProjectGroup" - }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "projectGroupId", - "in": "path", - "required": true, - "description": "The project group identifier." - } - ] - }, - "/project-groups/{projectGroupId}/projects": { - "post": { - "tags": [ - "Project Group" - ], - "summary": "Add Projects To Group", - "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", + "description": "Polls a quote report via an export operation. The quote report can be [downloaded](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) once the status is \"completed\". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8655,37 +8925,50 @@ "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/fields" + "$ref": "#/components/parameters/quote-report-format" + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "exportId", + "description": "The export identifier." } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/add-projects-to-group-request" - } - } - }, - "required": true - }, + "tags": [ + "Quote" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/quote-report/download": { + "get": { + "summary": "Download Exported Quote Report", + "operationId": "DownloadQuoteReport", "responses": { - "202": { - "description": "Accepted", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "200": { + "description": "", "content": { - "application/json": { + "application/octet-stream": { "schema": { - "$ref": "#/components/schemas/add-projects-to-group-response" + "type": "string", + "format": "binary" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -8715,7 +8998,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to add the projects to group.\n* \"forbidden\": The projects are not found or the authenticated user does not have acces to them.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": The maximum number of projects allowed for your project group has already been reached.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -8730,7 +9013,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project could not be found.", "content": { "application/json": { "schema": { @@ -8743,32 +9026,64 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "description": "Downloads a quote report generated by the [asynchronous export operation](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "409": { - "description": "Error codes:\n* “conflict”: A project with status \"detaching\" cannot be added.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/quote-report-format" + }, + { + "schema": { + "type": "string" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "in": "query", + "name": "exportId", + "description": "The export identifier." } - }, - "operationId": "AddProjectsToGroup" + ], + "tags": [ + "Quote" + ] }, - "delete": { + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/projects/{projectId}/tasks": { + "get": { "tags": [ - "Project Group" + "Project" ], - "summary": "Remove Projects From Group", - "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", + "summary": "List Project's Tasks", + "description": "Lists the tasks of a specific project.", "parameters": [ + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + }, { "$ref": "#/components/parameters/Authorization" }, @@ -8777,16 +9092,23 @@ } ], "responses": { - "202": { - "description": "Accepted", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-tasks-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "400": { - "description": "Error codes:\n\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -8800,8 +9122,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -8814,13 +9136,53 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "ListProjectTasks" + }, + "parameters": [ + { + "$ref": "#/components/parameters/projectId" + } + ] + }, + "/project-groups": { + "get": { + "tags": [ + "Project Group" + ], + "summary": "List Project Groups", + "description": "Retrieves a list of all the project groups in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to remove the projects from the project group.", + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/list-project-groups-response" } } }, @@ -8830,8 +9192,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -8845,8 +9207,8 @@ } } }, - "409": { - "description": "Error codes:\n* “conflict”: A project with status \"attaching\" cannot be removed.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -8859,38 +9221,31 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "RemoveProjectsFromGroup", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/remove-projects-from-group-request" + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" } } } - } + }, + "operationId": "ListProjectGroups" }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "projectGroupId", - "in": "path", - "required": true, - "description": "The Project Group identifier." - } - ] - }, - "/project-templates/{projectTemplateId}": { - "get": { + "post": { "tags": [ - "Project Template" + "Project Group" ], - "summary": "Get Project Template", - "description": "Retrieves a project template by identifier.", + "summary": "Create Project Group", + "description": "Creates a new project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8902,14 +9257,25 @@ "$ref": "#/components/parameters/fields" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group-create-request" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project-template-response" - } + "$ref": "#/components/schemas/project-group-create-response" + }, + "examples": {} } }, "headers": { @@ -8919,7 +9285,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -8949,7 +9315,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to create the project group in the specified location.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { @@ -8963,8 +9329,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + "409": { + "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", "content": { "application/json": { "schema": { @@ -8979,29 +9345,38 @@ } } }, - "operationId": "GetProjectTemplate" + "operationId": "CreateProjectGroup" }, - "parameters": [ - { - "$ref": "#/components/parameters/projectTemplateId" - } - ], - "put": { - "summary": "Update Project Template", - "operationId": "UpdateProjectTemplate", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/project-template-update-request" - } - } + "parameters": [] + }, + "/project-groups/{projectGroupId}": { + "get": { + "tags": [ + "Project Group" + ], + "summary": "Get Project Group", + "description": "Retrieves a project group by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "required": true - }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9009,7 +9384,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -9039,37 +9414,44 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project template.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the project group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } } }, - "description": "Updates a project template by id.", + "operationId": "GetProjectGroup" + }, + "put": { + "tags": [ + "Project Group" + ], + "summary": "Update Project Group", + "description": "Updates the project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9078,13 +9460,17 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "tags": [ - "Project Template" - ] - }, - "delete": { - "summary": "Delete Project Template", - "operationId": "DeleteProjectTemplate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-group-update-request" + } + } + }, + "required": true, + "description": "" + }, "responses": { "204": { "description": "No Content", @@ -9094,6 +9480,21 @@ } } }, + "400": { + "description": "Error responses:\n\n* “invalid”: Invalid input on update project group model.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, "401": { "description": "The user could not be identified.", "content": { @@ -9110,7 +9511,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project group.", "content": { "application/json": { "schema": { @@ -9125,7 +9526,22 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": Project group with the same name already exists.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9140,63 +9556,37 @@ } } }, - "description": "Deletes a project template by id.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "tags": [ - "Project Template" - ] - } - }, - "/project-templates": { - "get": { + "operationId": "UpdateProjectGroup" + }, + "delete": { "tags": [ - "Project Template" + "Project Group" ], - "summary": "List Project Templates", - "description": "Retrieves a list of all the project templates in an account.", + "summary": "Delete Project Group", + "description": "Deletes a project group.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/name" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "$ref": "#/components/parameters/fields" } ], "responses": { - "200": { - "description": "", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-project-templates-response" + "$ref": "#/components/schemas/error-response" } } }, @@ -9206,8 +9596,8 @@ } } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the project group.", "content": { "application/json": { "schema": { @@ -9221,8 +9611,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "404": { + "description": "Error codes:\n* \"notFound\": the project group could not be found by identifier.", "content": { "application/json": { "schema": { @@ -9236,8 +9626,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "409": { + "description": "Error codes:\n* \"conflict\": there might be projects that are still `attaching`.", "content": { "application/json": { "schema": { @@ -9252,14 +9642,27 @@ } } }, - "operationId": "ListProjectTemplates" + "operationId": "DeleteProjectGroup" }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "projectGroupId", + "in": "path", + "required": true, + "description": "The project group identifier." + } + ] + }, + "/project-groups/{projectGroupId}/projects": { "post": { "tags": [ - "Project Template" + "Project Group" ], - "summary": "Create Project Template", - "description": "Creates a new project template.", + "summary": "Add Projects To Group", + "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9275,30 +9678,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project-template-create-request" + "$ref": "#/components/schemas/add-projects-to-group-request" } } }, "required": true }, "responses": { - "201": { - "description": "", + "202": { + "description": "Accepted", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/project-template-response" + "$ref": "#/components/schemas/add-projects-to-group-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -9328,67 +9731,26 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a project template.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to add the projects to group.\n* \"forbidden\": The projects are not found or the authenticated user does not have acces to them.\n* \"benefitNotAvailable\": Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": The maximum number of projects allowed for your project group has already been reached.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "409": { - "description": "Error codes:\n* \"duplicate\": A project template with the same name already exists in the same location.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } - } - }, - "operationId": "CreateProjectTemplate" - } - }, - "/rate-limits": { - "get": { - "tags": [ - "Rate Limits" - ], - "summary": "List Rate Limits", - "description": "Retrieves a list of all rate limits applicable for an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" }, - { - "$ref": "#/components/parameters/skip" - } - ], - "responses": { - "200": { - "description": "", + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-rate-limits-response" + "$ref": "#/components/schemas/error-response" } } }, @@ -9398,23 +9760,8 @@ } } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - } - }, - "401": { - "description": "The user could not be identified.", + "409": { + "description": "Error codes:\n* “conflict”: A project with status \"detaching\" cannot be added.", "content": { "application/json": { "schema": { @@ -9429,49 +9776,25 @@ } } }, - "operationId": "ListRateLimits" - } - }, - "/schedule-templates": { - "get": { - "summary": "List Schedule Templates", - "description": "Retrieves a list of all the schedule templates in an account.", + "operationId": "AddProjectsToGroup" + }, + "delete": { + "tags": [ + "Project Group" + ], + "summary": "Remove Projects From Group", + "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/fields" - }, - { - "$ref": "#/components/parameters/name" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/list-schedule-templates-response" - } - } - }, + "202": { + "description": "Accepted", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9479,7 +9802,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -9508,8 +9831,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to remove the projects from the project group.", "content": { "application/json": { "schema": { @@ -9522,90 +9845,29 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "ListScheduleTemplates", - "tags": [ - "Schedule Template" - ] - }, - "parameters": [], - "post": { - "summary": "Create Schedule Template", - "operationId": "CreateScheduleTemplate", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/schedule-template" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } }, - "400": { - "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"invalidLanguage\": The language used in configurations is invalid. Check the error message for more details.\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" or in the \"description\" fields.\n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "404": { + "description": "Error codes:\n* \"notFound\": The project group could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "401": { - "description": "The user could not be identified.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } }, "409": { - "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", + "description": "Error codes:\n* “conflict”: A project with status \"attaching\" cannot be removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/error-response" - } } }, "headers": { @@ -9615,36 +9877,36 @@ } } }, - "description": "Creates a new schedule template.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ], + "operationId": "RemoveProjectsFromGroup", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/schedule-template-create-request" + "$ref": "#/components/schemas/remove-projects-from-group-request" } } } - }, - "tags": [ - "Schedule Template" - ] - } + } + }, + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "projectGroupId", + "in": "path", + "required": true, + "description": "The Project Group identifier." + } + ] }, - "/schedule-templates/{scheduleTemplateId}": { + "/project-templates/{projectTemplateId}": { "get": { - "summary": "Get Schedule Template", - "description": "Retrieves a schedule template by identifier.", + "tags": [ + "Project Template" + ], + "summary": "Get Project Template", + "description": "Retrieves a project template by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9662,7 +9924,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/schedule-template" + "$ref": "#/components/schemas/project-template-response" } } }, @@ -9673,7 +9935,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “empty”: Empty input for the “scheduleTemplateId” path parameter variable.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -9703,7 +9965,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the schedule template.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", "content": { "application/json": { "schema": { @@ -9718,7 +9980,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "content": { "application/json": { "schema": { @@ -9733,51 +9995,67 @@ } } }, - "operationId": "GetScheduleTemplate", - "tags": [ - "Schedule Template" - ] + "operationId": "GetProjectTemplate" }, "parameters": [ { - "schema": { - "type": "string" - }, - "name": "scheduleTemplateId", - "in": "path", - "required": true, - "description": "The id of the schedule template." + "$ref": "#/components/parameters/projectTemplateId" } ], - "delete": { - "summary": "Delete Schedule Template", - "operationId": "DeleteScheduleTemplate", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", + "put": { + "summary": "Update Project Template", + "operationId": "UpdateProjectTemplate", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-update-request" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the schedule template.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the project template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9792,7 +10070,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9807,7 +10085,7 @@ } } }, - "description": "Deletes a schedule template.", + "description": "Updates a project template by id.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9817,85 +10095,53 @@ } ], "tags": [ - "Schedule Template" + "Project Template" ] }, - "put": { - "summary": "Update Schedule Template", - "operationId": "UpdateScheduleTemplate", + "delete": { + "summary": "Delete Project Template", + "operationId": "DeleteProjectTemplate", "responses": { "204": { - "description": "No content", + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "400": { - "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response or in “scheduleTemplateId” path variable.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" or in the \"description\" fields. \n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", - "headers": { - "X-LC-TraceId": { - "schema": { - "type": "string" - } - } - }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "401": { - "description": "The user could not be identified.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the schedule template.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the project template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } }, - "409": { - "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", + "404": { + "description": "Error codes:\n* \"notFound\": the project template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -9910,7 +10156,7 @@ } } }, - "description": "Updates the schedule template identified by `scheduleTemplateId`.", + "description": "Deletes a project template by id.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9919,27 +10165,18 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/schedule-template-update-request" - } - } - } - }, "tags": [ - "Schedule Template" + "Project Template" ] } }, - "/tasks/{taskId}": { + "/project-templates": { "get": { "tags": [ - "Task" + "Project Template" ], - "summary": "Get Task", - "description": "Retrieves a task.", + "summary": "List Project Templates", + "description": "Retrieves a list of all the project templates in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9947,6 +10184,24 @@ { "$ref": "#/components/parameters/X-LC-Tenant" }, + { + "$ref": "#/components/parameters/name" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, { "$ref": "#/components/parameters/fields" } @@ -9957,21 +10212,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/task" - }, - "examples": { - "simple": { - "value": { - "id": "df680285-adcd-4bda-8f79-0bba4a857287", - "status": "created" - } - }, - "unexpected-enum": { - "value": { - "id": "df680285-adcd-4bda-8f79-0bba4a857287", - "status": "unexpectedEnumValue" - } - } + "$ref": "#/components/schemas/list-project-templates-response" } } }, @@ -10011,23 +10252,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -10042,21 +10268,14 @@ } } }, - "operationId": "GetTask" + "operationId": "ListProjectTemplates" }, - "parameters": [ - { - "$ref": "#/components/parameters/taskId" - } - ] - }, - "/tasks/assigned": { - "get": { + "post": { "tags": [ - "Task" + "Project Template" ], - "summary": "List Tasks assigned to me", - "description": "Retrieves the tasks assigned to the authenticated user.", + "summary": "Create Project Template", + "description": "Creates a new project template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10064,40 +10283,27 @@ { "$ref": "#/components/parameters/X-LC-Tenant" }, - { - "name": "status", - "in": "query", - "description": "If specified, this filters tasks by status.", - "schema": { - "type": "string" - } - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" - }, { "$ref": "#/components/parameters/fields" } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/project-template-create-request" + } + } + }, + "required": true + }, "responses": { - "200": { + "201": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-tasks-response" + "$ref": "#/components/schemas/project-template-response" } } }, @@ -10108,7 +10314,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response. \n* \"deleted\": Some of the selected values were deleted and cannot be selected for some values of the \"customFields\" field.\n", "content": { "application/json": { "schema": { @@ -10137,43 +10343,71 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a project template.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": A project template with the same name already exists in the same location.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } } } }, - "operationId": "ListTasksAssignedToMe" + "operationId": "CreateProjectTemplate" } }, - "/tasks/{taskId}/accept": { - "put": { + "/rate-limits": { + "get": { "tags": [ - "Task" + "Rate Limits" ], - "summary": "Accept Task", - "description": "Accepts a task. The authenticated user becomes the owner of the accepted task and can start work on it.", + "summary": "List Rate Limits", + "description": "Retrieves a list of all rate limits applicable for an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" } ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-rate-limits-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10181,7 +10415,7 @@ } }, "400": { - "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10209,9 +10443,59 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "ListRateLimits" + } + }, + "/schedule-templates": { + "get": { + "summary": "List Schedule Templates", + "description": "Retrieves a list of all the schedule templates in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/name" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-schedule-templates-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -10225,8 +10509,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -10240,8 +10524,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"alreadyOwned\": the task is already owned\n* \"invalidStatus\": the task status doesn't permit the accept operation", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -10256,32 +10540,25 @@ } } }, - "operationId": "AcceptTask" - }, - "parameters": [ - { - "$ref": "#/components/parameters/taskId" - } - ] - }, - "/tasks/{taskId}/reject": { - "put": { + "operationId": "ListScheduleTemplates", "tags": [ - "Task" - ], - "summary": "Reject Task", - "description": "Rejects a task. The authenticated user will be removed from the task's list of available assignee users.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "Schedule Template" + ] + }, + "parameters": [], + "post": { + "summary": "Create Schedule Template", + "operationId": "CreateScheduleTemplate", "responses": { - "204": { - "description": "No Content", + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/schedule-template" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10289,7 +10566,7 @@ } }, "400": { - "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"invalidLanguage\": The language used in configurations is invalid. Check the error message for more details.\n* \"maxSize\": The maximum size was exceeded for the value mentioned in the \"name\" or in the \"description\" fields.\n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10305,56 +10582,46 @@ }, "401": { "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to create a schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "409": { - "description": "Error codes:\n* \"alreadyOwned\": The task is already owned. It can't be rejected.\n* \"invalidStatus\": The task status doesn't permit the reject operation.\n* \"singleAssignee\": The authenticated user is the single assignee of the task, therefore the task can't be rejected.", + "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } } }, "headers": { @@ -10364,54 +10631,54 @@ } } }, - "operationId": "RejectTask" - }, - "parameters": [ - { - "$ref": "#/components/parameters/taskId" - } - ] - }, - "/tasks/{taskId}/complete": { - "put": { - "tags": [ - "Task" - ], - "summary": "Complete Task", - "description": "Completes a task. The task is required to be in \"inProgress\" state and will be marked as \"completed\".", + "description": "Creates a new schedule template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/task-complete-request" + "$ref": "#/components/schemas/schedule-template-create-request" } } - }, - "required": true + } }, - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "tags": [ + "Schedule Template" + ] + } + }, + "/schedule-templates/{scheduleTemplateId}": { + "get": { + "summary": "Get Schedule Template", + "description": "Retrieves a schedule template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "400": { - "description": "Error codes:\n* “maxSize“: Maximum size exceeded for the value mentioned in the “name“ field on the error response.", + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/schedule-template" } } }, @@ -10421,8 +10688,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* “empty”: Empty input for the “scheduleTemplateId” path parameter variable.", "content": { "application/json": { "schema": { @@ -10436,8 +10703,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the task.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -10451,8 +10718,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the schedule template.", "content": { "application/json": { "schema": { @@ -10466,8 +10733,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": The current task status doesn't permit this operation.\n* \"noOwner\": The current task was not accepted in advance.\n* \"differentOwner\": The current task is accepted by another user.", + "404": { + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "content": { "application/json": { "schema": { @@ -10482,29 +10749,25 @@ } } }, - "operationId": "CompleteTask" + "operationId": "GetScheduleTemplate", + "tags": [ + "Schedule Template" + ] }, "parameters": [ { - "$ref": "#/components/parameters/taskId" + "schema": { + "type": "string" + }, + "name": "scheduleTemplateId", + "in": "path", + "required": true, + "description": "The id of the schedule template." } - ] - }, - "/tasks/{taskId}/release": { - "put": { - "tags": [ - "Task" - ], - "summary": "Release Task", - "description": "Releases the task from its owner so that other task assignees will be able to accept it.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + ], + "delete": { + "summary": "Delete Schedule Template", + "operationId": "DeleteScheduleTemplate", "responses": { "204": { "description": "No Content", @@ -10514,8 +10777,8 @@ } } }, - "400": { - "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10529,82 +10792,38 @@ } } }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to release the resource.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "409": { - "description": "Error codes:\n* \"noOwner\": the task currently has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"invalidStatus\": the task's status does not permit this operation.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "ReleaseTask" - }, - "parameters": [ - { - "$ref": "#/components/parameters/taskId" - } - ] - }, - "/tasks/{taskId}/reclaim": { - "put": { - "tags": [ - "Task" - ], - "summary": "Reclaim Task", - "description": "The current owner of task is removed so that other assignees can accept it. \nThe task is not reassigned automatically.", + "description": "Deletes a schedule template.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10613,9 +10832,16 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], + "tags": [ + "Schedule Template" + ] + }, + "put": { + "summary": "Update Schedule Template", + "operationId": "UpdateScheduleTemplate", "responses": { "204": { - "description": "No Content", + "description": "No content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -10623,96 +10849,84 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "description": "Error responses:\n\n* “invalid”: invalid input on update schedule template model.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response or in “scheduleTemplateId” path variable.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" or in the \"description\" fields. \n* \"invalidType\": The value provided for the \"taskTypeId\" field is invalid.", + "headers": { + "X-LC-TraceId": { + "schema": { + "type": "string" + } + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the schedule template.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to reclaim the task.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the schedule template could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": A schedule template with the same name already exists in the same location.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit this operation.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "ReclaimTask" - }, - "parameters": [ - { - "$ref": "#/components/parameters/taskId" - } - ] - }, - "/tasks/{taskId}/assign": { - "put": { - "tags": [ - "Task" - ], - "summary": "Assign Task", - "description": "Assigns a task. The task assignees will be updated.", + "description": "Updates the schedule template identified by `scheduleTemplateId`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10725,27 +10939,55 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/task-assign-request" + "$ref": "#/components/schemas/schedule-template-update-request" } } - }, - "required": true + } }, - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "tags": [ + "Schedule Template" + ] + } + }, + "/tasks/{taskId}": { + "get": { + "tags": [ + "Task" + ], + "summary": "Get Task", + "description": "Retrieves a task.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/task" + }, + "examples": { + "simple": { + "value": { + "id": "df680285-adcd-4bda-8f79-0bba4a857287", + "status": "created" + } + }, + "unexpected-enum": { + "value": { + "id": "df680285-adcd-4bda-8f79-0bba4a857287", + "status": "unexpectedEnumValue" + } + } } } }, @@ -10755,8 +10997,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -10770,8 +11012,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to assign the task.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -10785,8 +11027,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task.", "content": { "application/json": { "schema": { @@ -10800,8 +11042,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit the operation.", + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -10816,7 +11058,7 @@ } } }, - "operationId": "AssignTask" + "operationId": "GetTask" }, "parameters": [ { @@ -10824,13 +11066,13 @@ } ] }, - "/task-types/{taskTypeId}": { + "/tasks/assigned": { "get": { "tags": [ - "Task Type" + "Task" ], - "summary": "Get Task Type", - "description": "Retrieves a task type by identifier.", + "summary": "List Tasks assigned to me", + "description": "Retrieves the tasks assigned to the authenticated user.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -10839,127 +11081,11 @@ "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/task-type" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task type.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "operationId": "GetTaskType" - }, - "parameters": [ - { - "$ref": "#/components/parameters/taskTypeId" - } - ] - }, - "/task-types": { - "get": { - "tags": [ - "Task Type" - ], - "summary": "List Task Types", - "description": "Retrieves all the task types in an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "name": "key", - "in": "query", - "description": "Filter by keys.", - "style": "form", - "explode": false, - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "name": "automatic", + "name": "status", "in": "query", - "description": "Filter by automatic or human tasks.", + "description": "If specified, this filters tasks by status.", "schema": { - "type": "boolean" + "type": "string" } }, { @@ -10987,7 +11113,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-task-types-response" + "$ref": "#/components/schemas/list-tasks-response" } } }, @@ -11043,37 +11169,27 @@ } } }, - "operationId": "ListTaskTypes" + "operationId": "ListTasksAssignedToMe" } }, - "/translation-engines/{translationEngineId}": { - "get": { + "/tasks/{taskId}/accept": { + "put": { "tags": [ - "Translation Engine" + "Task" ], - "summary": "Get Translation Engine", - "description": "Retrieves a translation engine.", + "summary": "Accept Task", + "description": "Accepts a task. The authenticated user becomes the owner of the accepted task and can start work on it.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/translation-engine" - } - } - }, + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -11081,18 +11197,18 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "401": { @@ -11111,49 +11227,77 @@ } }, "403": { - "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The translation engine could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "409": { + "description": "Error codes:\n* \"alreadyOwned\": the task is already owned\n* \"invalidStatus\": the task status doesn't permit the accept operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } } }, - "operationId": "GetTranslationEngine" + "operationId": "AcceptTask" }, "parameters": [ { - "$ref": "#/components/parameters/translationEngineId" + "$ref": "#/components/parameters/taskId" } - ], + ] + }, + "/tasks/{taskId}/reject": { "put": { - "summary": "Update Translation Engine", - "operationId": "UpdateTranslationEngine", + "tags": [ + "Task" + ], + "summary": "Reject Task", + "description": "Rejects a task. The authenticated user will be removed from the task's list of available assignee users.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], "responses": { "204": { - "description": "", + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -11161,7 +11305,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the update translation engine model. Check error details.\n* \"invalidLanguage\": Invalid language code used in language-pair\n* \"duplicate\": Duplicate resources found for the language pair specified in the error details.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -11177,23 +11321,21 @@ }, "401": { "description": "The user could not be identified.", - "headers": { - "X-LC-TraceId": { - "schema": { - "type": "string" - } - } - }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to update the resource.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -11208,7 +11350,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11223,7 +11365,7 @@ } }, "409": { - "description": "Error codes:\n\n * \"updateNotAllowed\": Property specified in error response can not be updated because the translation engine provided is a copy assigned to a project.", + "description": "Error codes:\n* \"alreadyOwned\": The task is already owned. It can't be rejected.\n* \"invalidStatus\": The task status doesn't permit the reject operation.\n* \"singleAssignee\": The authenticated user is the single assignee of the task, therefore the task can't be rejected.", "content": { "application/json": { "schema": { @@ -11238,7 +11380,21 @@ } } }, - "description": "Updates a translation engine. \n\nIt can be used to update a stand-alone translation engine or a project's translation engine. \nThe identifier of a project's translation engine can be retrieved only by calling [Get Project endpoint](https://sdl-language-tech.stoplight.io/docs/lcpublicapi/fd9ee0beb37ca-get-project).\n\nPay special attention that some properties can not be changed for a project's translation engine. These include: name, description, definition.languageProcessingId, and language pairs can not be added/removed from definition.languagePairDefinitions. \n\nPay special attention to how [updating works](https://languagecloud.sdl.com/lc/api-docs/updating-data-with-put).", + "operationId": "RejectTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/complete": { + "put": { + "tags": [ + "Task" + ], + "summary": "Complete Task", + "description": "Completes a task. The task is required to be in \"inProgress\" state and will be marked as \"completed\".", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -11251,57 +11407,27 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-engine-update-request" + "$ref": "#/components/schemas/task-complete-request" } } }, - "description": "" + "required": true }, - "tags": [ - "Translation Engine" - ] - } - }, - "/translation-engines": { - "get": { - "tags": [ - "Translation Engine" - ], - "summary": "List Translation Engines", - "description": "Retrieves all the translation engines in an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" - }, - { - "$ref": "#/components/parameters/fields" - } - ], "responses": { - "200": { - "description": "", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “maxSize“: Maximum size exceeded for the value mentioned in the “name“ field on the error response.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-translation-engines-response" + "$ref": "#/components/schemas/error-response" } } }, @@ -11311,8 +11437,8 @@ } } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -11326,8 +11452,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to complete the task.", "content": { "application/json": { "schema": { @@ -11341,8 +11467,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11355,76 +11481,13 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "ListTranslationEngines" - } - }, - "/termbase-templates": { - "get": { - "summary": "List Termbase Templates", - "responses": { - "200": { - "description": "OK", + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The current task status doesn't permit this operation.\n* \"noOwner\": The current task was not accepted in advance.\n* \"differentOwner\": The current task is accepted by another user.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-termbase-templates-response" - }, - "examples": { - "termbase-templates-list": { - "value": { - "items": [ - { - "id": "test-id-1", - "name": "test-name-1", - "location": { - "id": "test-location-id-1", - "name": "test-location-name-1" - }, - "type": "system", - "languages": [ - { - "languageCode": "test-language-code-1" - } - ], - "fields": [ - { - "id": "test-field-id-1", - "name": "test-field-name-1", - "type": "system", - "level": "entry", - "dataType": "text" - } - ] - }, - { - "id": "test-id-2", - "name": "test-name-2", - "location": { - "id": "test-location-id-2", - "name": "test-location-name-2" - }, - "type": "userDefined", - "languages": [ - { - "languageCode": "test-language-code-2" - } - ], - "fields": [ - { - "id": "test-field-id-2", - "name": "test-field-name-2", - "type": "userDefined", - "level": "language", - "dataType": "boolean" - } - ] - } - ], - "itemCount": 2 - } - } + "$ref": "#/components/schemas/error-response" } } }, @@ -11433,9 +11496,57 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "CompleteTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/release": { + "put": { + "tags": [ + "Task" + ], + "summary": "Release Task", + "description": "Releases the task from its owner so that other task assignees will be able to accept it.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -11449,8 +11560,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to release the resource.", "content": { "application/json": { "schema": { @@ -11464,8 +11575,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resources.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "404": { + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11479,8 +11590,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "409": { + "description": "Error codes:\n* \"noOwner\": the task currently has no owner.\n* \"differentOwner\": the authenticated user is not the owner of the task.\n* \"invalidStatus\": the task's status does not permit this operation.", "content": { "application/json": { "schema": { @@ -11495,126 +11606,40 @@ } } }, - "operationId": "ListTermbaseTemplates", - "description": "List termbase templates.", + "operationId": "ReleaseTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/reclaim": { + "put": { + "tags": [ + "Task" + ], + "summary": "Reclaim Task", + "description": "The current owner of task is removed so that other assignees can accept it. \nThe task is not reassigned automatically.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "in": "query", - "name": "location", - "description": "The identifiers of the resource folders. ", - "schema": { - "type": "array", - "items": { - "type": "string" - } - } - }, - { - "$ref": "#/components/parameters/fields" - }, - { - "schema": { - "type": "string", - "enum": [ - "system", - "userDefined" - ] - }, - "in": "query", - "name": "type", - "description": "The type of the termbase template to retrieve. If not specified, both types will be returned" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" } ], - "tags": [ - "Termbase Template" - ] - }, - "parameters": [], - "post": { - "summary": "Create Termbase Template", - "operationId": "CreateTermbaseTemplate", "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-template" - }, - "examples": { - "Example 1": { - "value": { - "id": "string", - "name": "string", - "description": "string", - "copyright": "string", - "location": { - "id": "string", - "name": "string", - "hasParent": true, - "path": [ - { - "id": "string", - "name": "string", - "location": "string", - "hasParent": true - } - ] - }, - "createdAt": "2022-01-12T12:00:00.000Z", - "lastModifiedAt": "2022-01-12T12:00:00.000Z", - "type": "system", - "languages": [ - { - "languageCode": "string", - "englishName": "string", - "direction": "string", - "parentLanguageCode": "string", - "defaultSpecificLanguageCode": "string", - "isNeutral": true - } - ], - "fields": [ - { - "id": "string", - "name": "string", - "description": "string", - "type": "system", - "level": "entry", - "dataType": "text", - "pickListValues": [ - "string" - ], - "allowCustomValues": true, - "allowMultiple": true, - "isMandatory": true - } - ] - } - } - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty value for variable mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -11644,7 +11669,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase template in the specified location.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to reclaim the task.", "content": { "application/json": { "schema": { @@ -11659,7 +11684,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11674,7 +11699,7 @@ } }, "409": { - "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.", + "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit this operation.", "content": { "application/json": { "schema": { @@ -11689,86 +11714,50 @@ } } }, + "operationId": "ReclaimTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/tasks/{taskId}/assign": { + "put": { + "tags": [ + "Task" + ], + "summary": "Assign Task", + "description": "Assigns a task. The task assignees will be updated.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], - "description": "Creates a new termbase template.", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-template-create-request" + "$ref": "#/components/schemas/task-assign-request" } } - } + }, + "required": true }, - "tags": [ - "Termbase Template" - ] - } - }, - "/termbase-templates/{termbaseTemplateId}": { - "get": { - "summary": "Get Termbase Template", - "tags": [ - "Termbase Template" - ], "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-template" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "403": { - "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input mentioned in the “name” field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", "content": { "application/json": { "schema": { @@ -11781,33 +11770,6 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "operationId": "GetTermbaseTemplate", - "description": "Get a termbase template by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - } - ] - }, - "delete": { - "summary": "Delete Termbase Template", - "operationId": "DeleteTermbaseTemplate", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } }, "401": { "description": "The user could not be identified.", @@ -11825,7 +11787,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase template\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to assign the task.", "content": { "application/json": { "schema": { @@ -11840,7 +11802,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the task could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11855,7 +11817,7 @@ } }, "409": { - "description": "Error codes:\n* \"conflict\": cannot delete system termbase templates", + "description": "Error codes:\n* \"invalidStatus\": the current task's status doesn't permit the operation.", "content": { "application/json": { "schema": { @@ -11870,25 +11832,42 @@ } } }, - "description": "Deletes a termbase template by identifier.", + "operationId": "AssignTask" + }, + "parameters": [ + { + "$ref": "#/components/parameters/taskId" + } + ] + }, + "/task-types/{taskTypeId}": { + "get": { + "tags": [ + "Task Type" + ], + "summary": "Get Task Type", + "description": "Retrieves a task type by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], - "tags": [ - "Termbase Template" - ] - }, - "put": { - "summary": "Update Termbase Template", - "operationId": "UpdateTermbaseTemplate", "responses": { - "204": { - "description": "No Content", + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/task-type" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -11896,7 +11875,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -11926,7 +11905,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase template.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the task type.", "content": { "application/json": { "schema": { @@ -11940,8 +11919,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.\n* \"conflict\": cannot update system termbase template", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -11956,45 +11935,90 @@ } } }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-template-update-request" - } - } - } - }, - "description": "Updates the termbase template.", - "tags": [ - "Termbase Template" - ] + "operationId": "GetTaskType" }, "parameters": [ { - "$ref": "#/components/parameters/termbaseTemplateId" + "$ref": "#/components/parameters/taskTypeId" } ] }, - "/termbase-templates/convert-xdt": { - "post": { - "summary": "Convert XDT to Termbase Structure", - "operationId": "ConvertTermbaseTemplate", - "responses": { - "200": { - "description": "OK", - "content": { + "/task-types": { + "get": { + "tags": [ + "Task Type" + ], + "summary": "List Task Types", + "description": "Retrieves all the task types in an account.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "name": "key", + "in": "query", + "description": "Filter by keys.", + "style": "form", + "explode": false, + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "automatic", + "in": "query", + "description": "Filter by automatic or human tasks.", + "schema": { + "type": "boolean" + } + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "responses": { + "200": { + "description": "", + "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-structure" + "$ref": "#/components/schemas/list-task-types-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" } } }, @@ -12005,7 +12029,7 @@ } }, "401": { - "description": "Unauthorized", + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -12019,8 +12043,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -12035,115 +12059,34 @@ } } }, - "description": "Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
\nThe structure will not be stored in the Trados Cloud Platform.", + "operationId": "ListTaskTypes" + } + }, + "/translation-engines/{translationEngineId}": { + "get": { + "tags": [ + "Translation Engine" + ], + "summary": "Get Translation Engine", + "description": "Retrieves a translation engine.", "parameters": [ - { - "$ref": "#/components/parameters/fields" - }, { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" } ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "required": [ - "file" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The .xdt file (binary string) used for conversion." - } - } - } - } - }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." - }, - "tags": [ - "Termbase Template" - ] - }, - "parameters": [] - }, - "/termbases": { - "get": { - "summary": "List Termbases", "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-termbases-response" - }, - "examples": { - "termbases-list": { - "value": { - "items": [ - { - "id": "test-id-1", - "name": "test-name-1", - "location": { - "id": "test-location-id-1", - "name": "test-location-name-1" - }, - "termbaseStructure": { - "languages": [ - { - "languageCode": "test-language-code-1" - } - ], - "fields": [ - { - "id": "test-field-id-1", - "name": "test-field-name-1", - "type": "system", - "level": "entry", - "dataType": "text" - } - ] - }, - "numberOfEntries": 1, - "status": "ready" - }, - { - "id": "test-id-2", - "name": "test-name-2", - "location": { - "id": "test-location-id-2", - "name": "test-location-name-2" - }, - "termbaseStructure": { - "languages": [ - { - "languageCode": "test-language-code-2" - } - ], - "fields": [ - { - "id": "test-field-id-2", - "name": "test-field-name-2", - "type": "userDefined", - "level": "language", - "dataType": "boolean" - } - ] - }, - "numberOfEntries": 2, - "status": "ready" - } - ], - "itemCount": 2 - } - } + "$ref": "#/components/schemas/translation-engine" } } }, @@ -12184,171 +12127,87 @@ } }, "403": { - "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation engine could not be found by identifier.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + } + }, + "operationId": "GetTranslationEngine" + }, + "parameters": [ + { + "$ref": "#/components/parameters/translationEngineId" + } + ], + "put": { + "summary": "Update Translation Engine", + "operationId": "UpdateTranslationEngine", + "responses": { + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the update translation engine model. Check error details.\n* \"invalidLanguage\": Invalid language code used in language-pair\n* \"duplicate\": Duplicate resources found for the language pair specified in the error details.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "operationId": "ListTermbase", - "description": "List termbases.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/fields" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - } - ], - "tags": [ - "Termbase" - ] - }, - "post": { - "summary": "Create Termbase", - "operationId": "CreateTermbase", - "responses": { - "201": { - "description": "Created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase" - }, - "examples": { - "Example 1": { - "value": { - "id": "string", - "name": "string", - "description": "string", - "copyright": "string", - "location": { - "id": "string", - "name": "string", - "hasParent": true, - "path": [ - { - "id": "string", - "name": "string", - "location": "string", - "hasParent": true - } - ] - }, - "termbaseStructure": { - "languages": [ - { - "languageCode": "string", - "englishName": "string", - "direction": "string", - "parentLanguageCode": "string", - "defaultSpecificLanguageCode": "string", - "isNeutral": true - } - ], - "fields": [ - { - "id": "string", - "name": "string", - "description": "string", - "type": "system", - "level": "entry", - "dataType": "text", - "pickListValues": [ - "string" - ], - "allowCustomValues": true, - "allowMultiple": true, - "isMandatory": true - } - ] - }, - "numberOfEntries": 0, - "status": "ready", - "createdAt": "2022-01-12T12:00:00.000Z", - "lastModifiedAt": "2022-01-12T12:00:00.000Z" - } - } - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, + } + }, + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": - You have reached the maximum allowable number of termbases for your account.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to update the resource.", "content": { "application/json": { "schema": { @@ -12363,7 +12222,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { @@ -12378,7 +12237,7 @@ } }, "409": { - "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.", + "description": "Error codes:\n\n * \"updateNotAllowed\": Property specified in error response can not be updated because the translation engine provided is a copy assigned to a project.", "content": { "application/json": { "schema": { @@ -12393,88 +12252,37 @@ } } }, + "description": "Updates a translation engine. \n\nIt can be used to update a stand-alone translation engine or a project's translation engine. \nThe identifier of a project's translation engine can be retrieved only by calling [Get Project](https://sdl-language-tech.stoplight.io/docs/lcpublicapi/fd9ee0beb37ca-get-project) endpoint.\n\nPay special attention that some properties can not be changed for a project's translation engine. These include: name, description, definition.languageProcessingId, and language pairs can not be added/removed from definition.languagePairDefinitions. \n\nPay special attention to how [updating](https://languagecloud.sdl.com/lc/api-docs/updating-data-with-put) works.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } ], - "description": "Creates a new termbase.\nThe termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. \nIf only a `termbaseTemplateId` was provided, the termbase will be created using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be created using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", "requestBody": { "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-create-request" + "$ref": "#/components/schemas/translation-engine-update-request" } } }, "description": "" }, "tags": [ - "Termbase" + "Translation Engine" ] } }, - "/termbases/{termbaseId}": { + "/translation-engines": { "get": { - "summary": "Get Termbase", "tags": [ - "Termbase" + "Translation Engine" ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resource.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "operationId": "GetTermbase", - "description": "Retrieves a termbase by identifier.", + "summary": "List Translation Engines", + "description": "Retrieves all the translation engines in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -12482,29 +12290,32 @@ { "$ref": "#/components/parameters/X-LC-Tenant" }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, { "$ref": "#/components/parameters/fields" } - ] - }, - "delete": { - "summary": "Delete Termbase", - "operationId": "DeleteTermbase", + ], "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/list-translation-engines-response" } } }, @@ -12514,8 +12325,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -12529,8 +12340,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": the termbase could not be found by identifier.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -12544,8 +12355,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be deleted as is currently being processed.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -12560,37 +12371,74 @@ } } }, - "description": "Deletes a termbase by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "tags": [ - "Termbase" - ] - }, - "put": { - "summary": "Update Termbase", - "operationId": "UpdateTermbase", + "operationId": "ListTranslationEngines" + } + }, + "/termbase-templates": { + "get": { + "summary": "List Termbase Templates", "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/list-termbase-templates-response" + }, + "examples": { + "termbase-templates-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "name": "test-name-1", + "location": { + "id": "test-location-id-1", + "name": "test-location-name-1" + }, + "type": "system", + "languages": [ + { + "languageCode": "test-language-code-1" + } + ], + "fields": [ + { + "id": "test-field-id-1", + "name": "test-field-name-1", + "type": "system", + "level": "entry", + "dataType": "text" + } + ] + }, + { + "id": "test-id-2", + "name": "test-name-2", + "location": { + "id": "test-location-id-2", + "name": "test-location-name-2" + }, + "type": "userDefined", + "languages": [ + { + "languageCode": "test-language-code-2" + } + ], + "fields": [ + { + "id": "test-field-id-2", + "name": "test-field-name-2", + "type": "userDefined", + "level": "language", + "dataType": "boolean" + } + ] + } + ], + "itemCount": 2 + } + } } } }, @@ -12600,8 +12448,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -12615,8 +12463,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -12630,8 +12478,8 @@ } } }, - "404": { - "description": "Error codes:\n* \"notFound\": - The specified termbase identifier was not found.", + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resources.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { @@ -12645,8 +12493,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -12661,460 +12509,2837 @@ } } }, + "operationId": "ListTermbaseTemplates", + "description": "List termbase templates.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-update-request" + }, + { + "in": "query", + "name": "location", + "description": "The identifiers of the resource folders. ", + "schema": { + "type": "array", + "items": { + "type": "string" } } + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "schema": { + "type": "string", + "enum": [ + "system", + "userDefined" + ] + }, + "in": "query", + "name": "type", + "description": "The type of the termbase template to retrieve. If not specified, both types will be returned" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" } - }, - "description": "Updates the termbase.\nThe termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. \n\nIf only a `termbaseTemplateId ` was provided, the termbase will be updated using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be updated using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", + ], "tags": [ - "Termbase" + "Termbase Template" ] }, - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - } - ] - }, - "/termbases/{termbaseId}/entries": { + "parameters": [], "post": { - "summary": "Create Termbase Entry", - "operationId": "CreateTermbaseEntry", + "summary": "Create Termbase Template", + "operationId": "CreateTermbaseTemplate", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-entry" + "$ref": "#/components/schemas/termbase-template" }, "examples": { - "termbase-entry-create": { + "Example 1": { "value": { "id": "string", - "humanReadableId": "string", + "name": "string", + "description": "string", + "copyright": "string", + "location": { + "id": "string", + "name": "string", + "hasParent": true, + "path": [ + { + "id": "string", + "name": "string", + "location": "string", + "hasParent": true + } + ] + }, + "createdAt": "2022-01-12T12:00:00.000Z", + "lastModifiedAt": "2022-01-12T12:00:00.000Z", + "type": "system", "languages": [ { - "id": "string", - "language": { - "languageCode": "string", - "englishName": "string", - "direction": "string", - "parentLanguageCode": "string", - "defaultSpecificLanguageCode": "string", - "isNeutral": true - }, - "terms": [ - { - "id": "string", - "text": "string", - "termbaseFieldValues": [ - { - "id": "string", - "name": "string", - "termbaseFieldId": "string", - "value": "string", - "fieldValueLinks": [ - { - "type": "term", - "value": "string" - } - ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifiedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } - } - ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifiedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } - } - ], - "termbaseFieldValues": [ - { - "id": "string", - "name": "string", - "termbaseFieldId": "string", - "value": "string", - "fieldValueLinks": [ - { - "type": "term", - "value": "string" - } - ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifiedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } - } - ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } - } - ], - "termbaseFieldValues": [ - { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + } + ], + "fields": [ + { "id": "string", "name": "string", - "termbaseFieldId": "string", - "value": "string", - "fieldValueLinks": [ - { - "type": "term", - "value": "string" - } + "description": "string", + "type": "system", + "level": "entry", + "dataType": "text", + "pickListValues": [ + "string" ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifiedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } + "allowCustomValues": true, + "allowMultiple": true, + "isMandatory": true } - ], - "createdAt": "2019-08-24T14:15:22.000Z", - "createdBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - }, - "lastModifiedAt": "2019-08-24T14:15:22.000Z", - "lastModifiedBy": { - "id": "string", - "email": "string", - "firstName": "string", - "lastName": "string", - "anonymized": true, - "anonymizedUserName": "string", - "location": { - "id": "string", - "name": "string" - }, - "groups": [ - { - "id": "string", - "name": "string", - "description": "string", - "location": { - "id": "string", - "name": "string" - }, - "users": [ - { - "id": "string" - } - ] - } - ] - } + ] + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase template in the specified location.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase template.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template-create-request" + } + } + } + }, + "tags": [ + "Termbase Template" + ] + } + }, + "/termbase-templates/{termbaseTemplateId}": { + "get": { + "summary": "Get Termbase Template", + "tags": [ + "Termbase Template" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n\n* \"forbidden\": - The authenticated user is not allowed to read resource\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbaseTemplate", + "description": "Get a termbase template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "delete": { + "summary": "Delete Termbase Template", + "operationId": "DeleteTermbaseTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase template\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase template could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"conflict\": cannot delete system termbase templates", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase template by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Template" + ] + }, + "put": { + "summary": "Update Termbase Template", + "operationId": "UpdateTermbaseTemplate", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase template.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase template with the same name.\n* \"conflict\": cannot update system termbase template", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-template-update-request" + } + } + } + }, + "description": "Updates the termbase template.", + "tags": [ + "Termbase Template" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseTemplateId" + } + ] + }, + "/termbase-templates/convert-xdt": { + "post": { + "summary": "Convert XDT to Termbase Structure", + "operationId": "ConvertTermbaseTemplate", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-structure" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error code “invalid” in case of:\r\n * Empty or missing file in request\r\n * Not valid multipart request\r\n * File parameter contains other extension than the one expected by specification.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "Unauthorized", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Converts a termbase definition (XDT file) to a termbase structure that will be returned in the response.
\nThe structure will not be stored in the Trados Cloud Platform.", + "parameters": [ + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "file" + ], + "properties": { + "file": { + "type": "string", + "format": "binary", + "description": "The .xdt file (binary string) used for conversion." + } + } + } + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + }, + "tags": [ + "Termbase Template" + ] + }, + "parameters": [] + }, + "/termbases": { + "get": { + "summary": "List Termbases", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbases-response" + }, + "examples": { + "termbases-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "name": "test-name-1", + "location": { + "id": "test-location-id-1", + "name": "test-location-name-1" + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "test-language-code-1" + } + ], + "fields": [ + { + "id": "test-field-id-1", + "name": "test-field-name-1", + "type": "system", + "level": "entry", + "dataType": "text" + } + ] + }, + "numberOfEntries": 1, + "status": "ready" + }, + { + "id": "test-id-2", + "name": "test-name-2", + "location": { + "id": "test-location-id-2", + "name": "test-location-name-2" + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "test-language-code-2" + } + ], + "fields": [ + { + "id": "test-field-id-2", + "name": "test-field-name-2", + "type": "userDefined", + "level": "language", + "dataType": "boolean" + } + ] + }, + "numberOfEntries": 2, + "status": "ready" + } + ], + "itemCount": 2 + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "ListTermbase", + "description": "List termbases.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Termbase" + ] + }, + "post": { + "summary": "Create Termbase", + "operationId": "CreateTermbase", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase" + }, + "examples": { + "Example 1": { + "value": { + "id": "string", + "name": "string", + "description": "string", + "copyright": "string", + "location": { + "id": "string", + "name": "string", + "hasParent": true, + "path": [ + { + "id": "string", + "name": "string", + "location": "string", + "hasParent": true + } + ] + }, + "termbaseStructure": { + "languages": [ + { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + } + ], + "fields": [ + { + "id": "string", + "name": "string", + "description": "string", + "type": "system", + "level": "entry", + "dataType": "text", + "pickListValues": [ + "string" + ], + "allowCustomValues": true, + "allowMultiple": true, + "isMandatory": true + } + ] + }, + "numberOfEntries": 0, + "status": "ready", + "createdAt": "2022-01-12T12:00:00.000Z", + "lastModifiedAt": "2022-01-12T12:00:00.000Z" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create a termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.\n* \"quotaReached\": - You have reached the maximum allowable number of termbases for your account.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified location was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase.\nThe termbase can be created with a termbase template by providing the templateId or by providing a custom termbaseStructure. \nIf only a `termbaseTemplateId` was provided, the termbase will be created using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be created using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-create-request" + } + } + }, + "description": "" + }, + "tags": [ + "Termbase" + ] + } + }, + "/termbases/{termbaseId}": { + "get": { + "summary": "Get Termbase", + "tags": [ + "Termbase" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the resource.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbase", + "description": "Retrieves a termbase by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ] + }, + "delete": { + "summary": "Delete Termbase", + "operationId": "DeleteTermbase", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to delete the termbase\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the termbase could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be deleted as is currently being processed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "put": { + "summary": "Update Termbase", + "operationId": "UpdateTermbase", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"duplicate\": The field name must be unique within the list.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the termbase.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase identifier was not found.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"duplicate\": There is already a termbase with the same name.\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-update-request" + } + } + } + }, + "description": "Updates the termbase.\nThe termbase can be updated with a termbase template by providing the termbaseTemplateId or by providing a custom termbaseStructure. \n\nIf only a `termbaseTemplateId ` was provided, the termbase will be updated using data from the template. \nIf only a `termbaseStructure` was provided, the termbase will be updated using data from the structure. \nIf both, `termbaseTemplateId` and `termbaseStructure` are added in the request, the `termbaseStructure` takes precedence.", + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ] + }, + "/termbases/{termbaseId}/entries": { + "post": { + "summary": "Create Termbase Entry", + "operationId": "CreateTermbaseEntry", + "responses": { + "201": { + "description": "Created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry" + }, + "examples": { + "termbase-entry-create": { + "value": { + "id": "string", + "humanReadableId": "string", + "languages": [ + { + "id": "string", + "language": { + "languageCode": "string", + "englishName": "string", + "direction": "string", + "parentLanguageCode": "string", + "defaultSpecificLanguageCode": "string", + "isNeutral": true + }, + "terms": [ + { + "id": "string", + "text": "string", + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "termbaseFieldValues": [ + { + "id": "string", + "name": "string", + "termbaseFieldId": "string", + "value": "string", + "fieldValueLinks": [ + { + "type": "term", + "value": "string" + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + ], + "createdAt": "2019-08-24T14:15:22.000Z", + "createdBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + }, + "lastModifiedAt": "2019-08-24T14:15:22.000Z", + "lastModifiedBy": { + "id": "string", + "email": "string", + "firstName": "string", + "lastName": "string", + "anonymized": true, + "anonymizedUserName": "string", + "location": { + "id": "string", + "name": "string" + }, + "groups": [ + { + "id": "string", + "name": "string", + "description": "string", + "location": { + "id": "string", + "name": "string" + }, + "users": [ + { + "id": "string" + } + ] + } + ] + } + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalidLevel\" : The termbaseFieldId is invalid for the current termbaseField type\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create an entry.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.md#creating-a-termbase-entry).", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry-create-request" + } + } + } + }, + "tags": [ + "Termbase" + ] + }, + "get": { + "summary": "List Termbase Entries", + "operationId": "ListTermbaseEntries", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-entries-response" + }, + "examples": { + "termbase-entries-list": { + "value": { + "items": [ + { + "id": "test-id-1", + "humanReadableId": "test-humanReadableId-1", + "languages": [ + { + "id": "test-languages-id-1", + "language": { + "languageCode": "test-language-code-1" + }, + "terms": [ + { + "id": "test-terms-id-1", + "text": "test-terms-test-1" + } + ] + } + ], + "termbaseFieldValues": [ + { + "id": "test-termbaseFieldValues-id-1", + "name": "test-termbaseFieldValues-name-1", + "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-1", + "value": "test-termbaseFieldValues-value-1", + "fieldValueLinks": [ + { + "type": "term", + "value": "test-value-1" + } + ] + } + ] + }, + { + "id": "test-id-2", + "humanReadableId": "test-humanReadableId-2", + "languages": [ + { + "id": "test-languages-id-2", + "language": { + "languageCode": "test-language-code-2" + }, + "terms": [ + { + "id": "test-terms-id-2", + "text": "test-terms-test-2" + } + ] + } + ], + "termbaseFieldValues": [ + { + "id": "test-termbaseFieldValues-id-2", + "name": "test-termbaseFieldValues-name-2", + "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-2", + "value": "test-termbaseFieldValues-value-2", + "fieldValueLinks": [ + { + "type": "term", + "value": "test-value-2" + } + ] + } + ] + } + ], + "itemCount": 2 + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Retrieves a list of all the entries in a termbase.", + "tags": [ + "Termbase" + ], + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/humanReadableIds" + } + ] + }, + "delete": { + "summary": "Delete Termbase Entries", + "operationId": "DeleteTermbaseEntries", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete an entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes all the entries in the termbase.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ] + }, + "/termbases/{termbaseId}/entries/{entryId}": { + "get": { + "summary": "Get Termbase Entry", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the entry could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetTermbaseEntry", + "description": "Retrieves a termbase entry by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "tags": [ + "Termbase" + ] + }, + "put": { + "summary": "Update Termbase Entry", + "operationId": "UpdateTermbaseEntry", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "409": { + "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Updates a termbase entry by identifier.\nThe request body will overwrite the existing data.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-entry-update-request" + } + } + } + } + }, + "delete": { + "summary": "Delete Termbase Entry", + "operationId": "DeleteTermbaseEntry", + "responses": { + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete the termbase entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "description": "Deletes a termbase entry.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/entryId" + } + ] + }, + "/termbases/{termbaseId}/exports": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ], + "post": { + "summary": "Export Termbase", + "operationId": "ExportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-export-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "format": { + "type": "string", + "enum": [ + "xml", + "tbx" + ], + "default": "tbx", + "description": "The file format used to export the termbase." + }, + "properties": { + "$ref": "#/components/schemas/termbase-export-properties-request" + } + } + } + } + } + }, + "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/exports/{exportId}": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Poll Termbase Export", + "operationId": "PollExportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-export-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified export was not found." + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Polls a termbase via an export operation. The exported termbase can be downloaded once the status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/exports/{exportId}/download": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Download Exported Termbase", + "operationId": "DownloadExportedTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - The specified termbase or export was not found.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "description": "Downloads the exported termbase when the poll operation status is `done`.", + "tags": [ + "Termbase Export" + ] + } + }, + "/termbases/{termbaseId}/export-template": { + "parameters": [ + { + "name": "termbaseId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The termbase identifier." + } + ], + "get": { + "summary": "Export Termbase Template", + "tags": [ + "Termbase Export" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "DownloadTermbaseDefinition", + "description": "Downloads the termbase definition.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ] + } + }, + "/termbases/{termbaseId}/terms/{sourceLanguageCode}": { + "get": { + "summary": "List Termbase Terms", + "operationId": "ListTermbaseTerms", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-terms-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "schema": { + "type": "string", + "maxLength": 100 + }, + "in": "query", + "name": "search", + "description": "The text to search for." + }, + { + "schema": { + "type": "string", + "enum": [ + "normal", + "linguistic", + "fuzzy" + ], + "default": "normal" + }, + "in": "query", + "name": "searchType", + "description": "The type of the search performed." + }, + { + "schema": { + "type": "string" + }, + "in": "query", + "name": "targetLanguageCode", + "description": "The target language code used to list the terms." + } + ], + "description": "Retrieves a list of all the terms of the termbase.\nSearch types:\n- normal: Use normal search to look for terms that match the text exactly as entered.\n- linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects.\n- fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search.", + "tags": [ + "Termbase" + ] + }, + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "schema": { + "type": "string" + }, + "name": "sourceLanguageCode", + "in": "path", + "required": true, + "description": "The source language code used to list the terms." + } + ] + }, + "/termbases/{termbaseId}/imports": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + } + ], + "get": { + "summary": "Get Termbase Import History", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-termbase-import-history" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + } + }, + "operationId": "GetImportHistory", + "description": "Gets the import history for a termbase.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + } + ], + "tags": [ + "Termbase Import" + ] + }, + "post": { + "summary": "Import Termbase", + "operationId": "ImportTermbase", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/termbase-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" } } } @@ -13127,13 +15352,18 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"invalidLevel\" : The termbaseFieldId is invalid for the current termbaseField type\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "401": { @@ -13152,12 +15382,17 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to create an entry.\n* \"benefitNotAvailable\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } } }, "headers": { @@ -13167,7 +15402,7 @@ } }, "409": { - "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", + "description": "Error codes:\n* \"invalidStatus\": Cannot import as the termbase is currently being processed.", "content": { "application/json": { "schema": { @@ -13190,106 +15425,77 @@ "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/fields" + "schema": { + "type": "boolean", + "default": true + }, + "in": "query", + "name": "strictImport", + "description": "Specifies if the entries are only imported into the exact language that matches your imported file.
`true` - The import will only occur if the language in your import file matches exactly with a language in your termbase.
`false` - The import will occur even there are non-matching languages, by trying to match them to a relevant main language or language variant, if available." + }, + { + "schema": { + "type": "string", + "enum": [ + "ignore", + "merge", + "overwrite" + ], + "default": "overwrite" + }, + "in": "query", + "name": "duplicateEntriesStrategy", + "description": "The strategy for duplicate entries. Determines how the duplicate entries will be handled.
`ignore` - The content of the current entry with the same identifier will be kept, and the new entry will be ignored
`merge` - The content of the current entry with the same identifier will be merged with the imported entry. If the identifier is not provided the content will be merged by text.
`overwrite` - The content of the current entry with the same identifier will be replaced by the imported entry." } ], - "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.md#creating-a-termbase-entry).", "requestBody": { "content": { - "application/json": { + "multipart/form-data": { "schema": { - "$ref": "#/components/schemas/termbase-entry-create-request" - } + "type": "object", + "required": [ + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/termbase-import-request" + }, + "file": { + "type": "string", + "format": "binary", + "description": "The file (binary string) to import into the termbase.
\nAccepted file types: .xml, .tbx\n
" + } + } + }, + "examples": {} } - } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." }, + "description": "Generates an asynchronous import operation.
\nUse the Poll Import Termbase endpoint to poll until the import status is `done`.
", "tags": [ - "Termbase" + "Termbase Import" ] - }, + } + }, + "/termbases/{termbaseId}/imports/{importId}": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/importId" + } + ], "get": { - "summary": "List Termbase Entries", - "operationId": "ListTermbaseEntries", + "summary": "Poll Termbase Import", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-termbase-entries-response" - }, - "examples": { - "termbase-entries-list": { - "value": { - "items": [ - { - "id": "test-id-1", - "humanReadableId": "test-humanReadableId-1", - "languages": [ - { - "id": "test-languages-id-1", - "language": { - "languageCode": "test-language-code-1" - }, - "terms": [ - { - "id": "test-terms-id-1", - "text": "test-terms-test-1" - } - ] - } - ], - "termbaseFieldValues": [ - { - "id": "test-termbaseFieldValues-id-1", - "name": "test-termbaseFieldValues-name-1", - "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-1", - "value": "test-termbaseFieldValues-value-1", - "fieldValueLinks": [ - { - "type": "term", - "value": "test-value-1" - } - ] - } - ] - }, - { - "id": "test-id-2", - "humanReadableId": "test-humanReadableId-2", - "languages": [ - { - "id": "test-languages-id-2", - "language": { - "languageCode": "test-language-code-2" - }, - "terms": [ - { - "id": "test-terms-id-2", - "text": "test-terms-test-2" - } - ] - } - ], - "termbaseFieldValues": [ - { - "id": "test-termbaseFieldValues-id-2", - "name": "test-termbaseFieldValues-name-2", - "termbaseFieldId": "test-termbaseFieldValues-termbaseFieldId-2", - "value": "test-termbaseFieldValues-value-2", - "fieldValueLinks": [ - { - "type": "term", - "value": "test-value-2" - } - ] - } - ] - } - ], - "itemCount": 2 - } - } + "$ref": "#/components/schemas/termbase-poll-import-response" } } }, @@ -13299,8 +15505,31 @@ } } }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "401": { + "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -13313,6 +15542,66 @@ "$ref": "#/components/headers/X-LC-TraceId" } } + } + }, + "operationId": "PollTermbaseImport", + "description": "Polls a termbase import operation.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Import" + ] + } + }, + "/termbases/{termbaseId}/imports/{importId}/logs": { + "parameters": [ + { + "$ref": "#/components/parameters/termbaseId" + }, + { + "$ref": "#/components/parameters/importId" + } + ], + "get": { + "summary": "Download Termbase Import Logs", + "operationId": "DownloadTermbaseImportLog", + "description": "Downloads the termbase import logs.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "tags": [ + "Termbase Import" + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error code: \n * \"invalid\": the value specified in the field \"name\" of the errorDetails is not an accepted value." }, "401": { "description": "The user could not be identified.", @@ -13330,7 +15619,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", "content": { "application/json": { "schema": { @@ -13344,8 +15633,8 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "404": { + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -13359,38 +15648,40 @@ } } } - }, - "description": "Retrieves a list of all the entries in a termbase.", + } + } + }, + "/tqa-profiles": { + "get": { + "summary": "List TQA Profiles", "tags": [ - "Termbase" + "TQA Profile" ], - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/fields" - }, - { - "$ref": "#/components/parameters/humanReadableIds" - } - ] - }, - "delete": { - "summary": "Delete Termbase Entries", - "operationId": "DeleteTermbaseEntries", "responses": { - "204": { - "description": "No Content", + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-tqa-profiles-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -13412,8 +15703,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete an entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -13428,35 +15719,49 @@ } } }, - "description": "Deletes all the entries in the termbase.", + "operationId": "ListTqaProfiles", + "description": "List TQA Profiles.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" } - ], - "tags": [ - "Termbase" ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - } - ] + } }, - "/termbases/{termbaseId}/entries/{entryId}": { + "/tqa-profiles/{profileId}": { "get": { - "summary": "Get Termbase Entry", + "summary": "Get TQA Profile", + "tags": [ + "TQA Profile" + ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-entry" + "$ref": "#/components/schemas/tqa-profile" } } }, @@ -13467,7 +15772,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -13497,7 +15802,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -13512,7 +15817,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the entry could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the User could not be found by identifier.", "content": { "application/json": { "schema": { @@ -13527,8 +15832,8 @@ } } }, - "operationId": "GetTermbaseEntry", - "description": "Retrieves a termbase entry by identifier.", + "operationId": "GetTqaProfile", + "description": "Get a TQA Profile By identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -13539,29 +15844,27 @@ { "$ref": "#/components/parameters/fields" } - ], - "tags": [ - "Termbase" ] }, - "put": { - "summary": "Update Termbase Entry", - "operationId": "UpdateTermbaseEntry", + "parameters": [ + { + "$ref": "#/components/parameters/profileId" + } + ] + }, + "/translation-memory/{translationMemoryId}": { + "get": { + "summary": "Get Translation Memory", + "tags": [ + "Translation Memory" + ], "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "200": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/translation-memory" } } }, @@ -13571,8 +15874,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -13586,8 +15889,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to update the entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { @@ -13601,51 +15904,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": The termbase cannot be updated as is currently being processed.\n* \"duplicate\" : An entry with the same value already exists.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "description": "Updates a termbase entry by identifier.\nThe request body will overwrite the existing data.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "tags": [ - "Termbase" - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-entry-update-request" - } - } - } - } - }, - "delete": { - "summary": "Delete Termbase Entry", - "operationId": "DeleteTermbaseEntry", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -13659,8 +15919,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to delete the termbase entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", "content": { "application/json": { "schema": { @@ -13675,47 +15935,26 @@ } } }, - "description": "Deletes a termbase entry.", + "operationId": "GetTranslationMemory", + "description": "Get a single Translation Memory by identifier.", "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, { "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/fields" } - ], - "tags": [ - "Termbase" ] }, - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - }, - { - "$ref": "#/components/parameters/entryId" - } - ] - }, - "/termbases/{termbaseId}/exports": { - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - } - ], - "post": { - "summary": "Export Termbase", - "operationId": "ExportTermbase", + "put": { + "summary": "Update Translation Memory", + "operationId": "UpdateTranslationMemory", "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/termbase-export-response" - } - } - }, + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -13723,7 +15962,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -13753,17 +15992,12 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/error-response" - } } }, "headers": { @@ -13773,7 +16007,14 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - The specified termbase was not found.", + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -13781,62 +16022,46 @@ } } }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], + "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.md).", "requestBody": { "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "format": { - "type": "string", - "enum": [ - "xml", - "tbx" - ], - "default": "tbx", - "description": "The file format used to export the termbase." - }, - "properties": { - "$ref": "#/components/schemas/termbase-export-properties-request" - } - } + "$ref": "#/components/schemas/translation-memory-update-request" } } } }, - "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", + "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/Authorization" + } + ], "tags": [ - "Termbase Export" + "Translation Memory" ] - } - }, - "/termbases/{termbaseId}/exports/{exportId}": { - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - }, - { - "$ref": "#/components/parameters/exportId" - } - ], - "get": { - "summary": "Poll Termbase Export", - "operationId": "PollExportTermbase", + }, + "delete": { + "summary": "Delete Translation Memory", + "operationId": "DeleteTranslationMemory", "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-export-response" + "$ref": "#/components/schemas/error-response" } } }, @@ -13862,14 +16087,24 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } - }, - "application/xml": { + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } @@ -13880,45 +16115,46 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "404": { - "description": "Error codes:\n* \"notFound\": - The specified export was not found." } }, + "description": "Deletes a Translation Memory.", "parameters": [ { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/Authorization" } ], - "description": "Polls a termbase via an export operation. The exported termbase can be downloaded once the status is `done`.", "tags": [ - "Termbase Export" + "Translation Memory" ] - } - }, - "/termbases/{termbaseId}/exports/{exportId}/download": { + }, "parameters": [ { - "$ref": "#/components/parameters/termbaseId" - }, - { - "$ref": "#/components/parameters/exportId" + "schema": { + "type": "string" + }, + "name": "translationMemoryId", + "in": "path", + "required": true, + "description": "The identifier of the translation memory" } - ], - "get": { - "summary": "Download Exported Termbase", - "operationId": "DownloadExportedTermbase", + ] + }, + "/translation-memory/{translationMemoryId}/copy": { + "post": { + "summary": "Copy Translation Memory", + "tags": [ + "Translation Memory" + ], "responses": { "200": { - "description": "OK", + "description": "", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/translation-memory" } } }, @@ -13928,8 +16164,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -13943,15 +16179,25 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } - }, - "application/xml": { + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "content": { + "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } @@ -13964,7 +16210,14 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": - The specified termbase or export was not found.", + "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -13972,45 +16225,60 @@ } } }, + "operationId": "CopyTranslationMemory", + "description": "Creates a copy of a Translation Memory. The name will be suffixed with ' (Copy) '", "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, { "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/fields" } - ], - "description": "Downloads the exported termbase when the poll operation status is `done`.", - "tags": [ - "Termbase Export" ] - } - }, - "/termbases/{termbaseId}/export-template": { + }, "parameters": [ { - "name": "termbaseId", - "in": "path", - "required": true, "schema": { "type": "string" }, - "description": "The termbase identifier." + "name": "translationMemoryId", + "in": "path", + "required": true, + "description": "The identifier of the translation memory" } - ], + ] + }, + "/translation-memory": { "get": { - "summary": "Export Termbase Template", + "summary": "List Translation Memories", "tags": [ - "Termbase Export" + "Translation Memory" ], "responses": { "200": { - "description": "OK", + "description": "", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/list-translation-memories-reposne" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" } } }, @@ -14035,8 +16303,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", "content": { "application/json": { "schema": { @@ -14051,29 +16319,45 @@ } } }, - "operationId": "DownloadTermbaseDefinition", - "description": "Downloads the termbase definition.", + "operationId": "ListTranslationMemories", + "description": "Retrieves all the Translation Memories.", "parameters": [ + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, { "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" } ] - } - }, - "/termbases/{termbaseId}/terms/{sourceLanguageCode}": { - "get": { - "summary": "List Termbase Terms", - "operationId": "ListTermbaseTerms", + }, + "post": { + "summary": "Create Translation Memory", + "operationId": "CreateTranslationMemory", "responses": { - "200": { - "description": "OK", + "201": { + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-termbase-terms-response" + "$ref": "#/components/schemas/translation-memory-base" } } }, @@ -14084,7 +16368,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -14114,22 +16398,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read the entries.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -14144,86 +16413,45 @@ } } }, + "description": "Create a new Translation Memory.", "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "schema": { - "type": "string", - "maxLength": 100 - }, - "in": "query", - "name": "search", - "description": "The text to search for." - }, - { - "schema": { - "type": "string", - "enum": [ - "normal", - "linguistic", - "fuzzy" - ], - "default": "normal" - }, - "in": "query", - "name": "searchType", - "description": "The type of the search performed." + "$ref": "#/components/parameters/Authorization" }, { - "schema": { - "type": "string" - }, - "in": "query", - "name": "targetLanguageCode", - "description": "The target language code used to list the terms." + "$ref": "#/components/parameters/fields" } ], - "description": "Retrieves a list of all the terms of the termbase.\nSearch types:\n- normal: Use normal search to look for terms that match the text exactly as entered.\n- linguistic: Use linguistic search to look for terms that are similar to the search term. Linguistic search is based on stemming and other language-dependent aspects.\n- fuzzy: Use fuzzy search to look for terms that are similar to the search term. Fuzzy search is more fault-tolerant than linguistic search.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-create-request" + } + } + } + }, "tags": [ - "Termbase" + "Translation Memory" ] - }, - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - }, - { - "schema": { - "type": "string" - }, - "name": "sourceLanguageCode", - "in": "path", - "required": true, - "description": "The source language code used to list the terms." - } - ] + } }, - "/termbases/{termbaseId}/imports": { - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - } - ], + "/translation-memory/field-templates": { "get": { - "summary": "Get Termbase Import History", + "summary": "List Field Templates", + "tags": [ + "Translation Memory" + ], "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-termbase-import-history" + "$ref": "#/components/schemas/list-translation-memory-field-templates" } } }, @@ -14234,7 +16462,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"minSize\": Minimum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -14250,14 +16478,21 @@ }, "401": { "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -14272,47 +16507,61 @@ } } }, - "operationId": "GetImportHistory", - "description": "Gets the import history for a termbase.", + "operationId": "ListFieldTemplates", "parameters": [ { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/top" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" }, { "$ref": "#/components/parameters/fields" }, { - "$ref": "#/components/parameters/top" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/skip" + "$ref": "#/components/parameters/X-LC-Tenant" } ], - "tags": [ - "Termbase Import" - ] + "description": "Retrieves all the Field Templates." }, - "post": { - "summary": "Import Termbase", - "operationId": "ImportTermbase", + "parameters": [] + }, + "/translation-memory/field-templates/{fieldTemplateId}": { + "parameters": [ + { + "schema": { + "type": "string" + }, + "name": "fieldTemplateId", + "in": "path", + "required": true, + "description": "The field template identifier" + } + ], + "get": { + "summary": "Get Field Template", + "tags": [ + "Translation Memory" + ], "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-import-response" - }, - "examples": { - "import-termbase-ok": { - "value": { - "id": "test-import-id", - "status": "queued" - } - } + "$ref": "#/components/schemas/translation-memory-field-template" } } }, @@ -14323,7 +16572,7 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -14353,17 +16602,12 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/error-response" - } } }, "headers": { @@ -14372,8 +16616,8 @@ } } }, - "409": { - "description": "Error codes:\n* \"invalidStatus\": Cannot import as the termbase is currently being processed.", + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -14383,87 +16627,47 @@ }, "headers": { "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "schema": { - "type": "boolean", - "default": true - }, - "in": "query", - "name": "strictImport", - "description": "Specifies if the entries are only imported into the exact language that matches your imported file.
`true` - The import will only occur if the language in your import file matches exactly with a language in your termbase.
`false` - The import will occur even there are non-matching languages, by trying to match them to a relevant main language or language variant, if available." - }, - { - "schema": { - "type": "string", - "enum": [ - "ignore", - "merge", - "overwrite" - ], - "default": "overwrite" - }, - "in": "query", - "name": "duplicateEntriesStrategy", - "description": "The strategy for duplicate entries. Determines how the duplicate entries will be handled.
`ignore` - The content of the current entry with the same identifier will be kept, and the new entry will be ignored
`merge` - The content of the current entry with the same identifier will be merged with the imported entry. If the identifier is not provided the content will be merged by text.
`overwrite` - The content of the current entry with the same identifier will be replaced by the imported entry." - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "required": [ - "file" - ], - "properties": { - "file": { - "type": "string", - "format": "binary", - "description": "The file (binary string) to import into the termbase.
\nAccepted file types: .xml, .tbx\n
" - } - } - }, - "examples": {} + "$ref": "#/components/headers/X-LC-TraceId" + } } - }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + } }, - "description": "Generates an asynchronous import operation.
\nUse the Poll Import Termbase endpoint to poll until the import status is `done`.
", - "tags": [ - "Termbase Import" - ] + "operationId": "GetFieldTemplate", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], + "description": "Get a single Field Template by identifier." } }, - "/termbases/{termbaseId}/imports/{importId}": { + "/translation-memory/{translationMemoryId}/imports": { "parameters": [ { - "$ref": "#/components/parameters/termbaseId" - }, - { - "$ref": "#/components/parameters/importId" + "schema": { + "type": "string" + }, + "name": "translationMemoryId", + "description": "The identifier of the Translation Memory.", + "in": "path", + "required": true } ], "get": { - "summary": "Poll Termbase Import", + "summary": "Get Translation Memory Import History", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/termbase-poll-import-response" + "$ref": "#/components/schemas/list-translation-memory-import-history" } } }, @@ -14473,8 +16677,8 @@ } } }, - "401": { - "description": "The user could not be identified.", + "400": { + "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -14488,8 +16692,23 @@ } } }, + "401": { + "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -14512,53 +16731,70 @@ } } }, - "operationId": "PollTermbaseImport", - "description": "Polls a termbase import operation.", + "operationId": "GetTMImportHistory", + "description": "Gets the import history for a translation memory. It returns the history of last 7 days.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "tags": [ - "Termbase Import" - ] - } - }, - "/termbases/{termbaseId}/imports/{importId}/logs": { - "parameters": [ - { - "$ref": "#/components/parameters/termbaseId" - }, - { - "$ref": "#/components/parameters/importId" - } - ], - "get": { - "summary": "Download Termbase Import Logs", - "operationId": "DownloadTermbaseImportLog", - "description": "Downloads the termbase import logs.", - "parameters": [ + }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/fields" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" } ], "tags": [ - "Termbase Import" - ], + "Translation Memory Import" + ] + }, + "post": { + "summary": "Import Translation Memory", + "operationId": "ImportTranslationMemory", "responses": { "200": { - "description": "OK", + "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", "content": { - "application/octet-stream": { + "application/json": { "schema": { - "type": "string", - "format": "binary" + "$ref": "#/components/schemas/translation-memory-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" + } + } + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "202": { + "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-import-response" + }, + "examples": { + "import-termbase-ok": { + "value": { + "id": "test-import-id", + "status": "queued" + } + } } } }, @@ -14569,7 +16805,19 @@ } }, "400": { - "description": "Error code: \n * \"invalid\": the value specified in the field \"name\" of the errorDetails is not an accepted value." + "description": "Error codes:\n* \"invalid\": Invalid input in the query/form parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"multiPartOrder\": The multipart order in the body is not correct. The `properties` must be first and then, file.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } }, "401": { "description": "The user could not be identified.", @@ -14587,12 +16835,17 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": - The authenticated user is not allowed to read entry.\n* \"entitlementMissing\": - Your subscription does not include access to the requested type of benefit.", + "description": "Error codes:\n* \"forbidden\": Not authorized to import translation memories.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } + }, + "application/xml": { + "schema": { + "$ref": "#/components/schemas/error-response" + } } }, "headers": { @@ -14602,7 +16855,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -14616,22 +16869,67 @@ } } } - } + }, + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "type": "object", + "required": [ + "properties", + "file" + ], + "properties": { + "properties": { + "$ref": "#/components/schemas/translation-memory-import-request" + }, + "file": { + "type": "string", + "format": "binary", + "description": "The file (binary string) to import into the translation memory.
Accepted file types: .tmx, .sdltm, .zip, .tmx.gz, .sdlxliff" + } + } + }, + "examples": {} + } + }, + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + }, + "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](../reference/Public-API.v1.json/paths/~1translation-memory~1imports~1{importId}/get).", + "tags": [ + "Translation Memory Import" + ] } }, - "/tqa-profiles": { + "/translation-memory/imports/{importId}": { + "parameters": [ + { + "name": "importId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The import identifier." + } + ], "get": { - "summary": "List TQA Profiles", - "tags": [ - "TQA Profile" - ], + "summary": "Poll Translation Memory Import", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-tqa-profiles-response" + "$ref": "#/components/schemas/translation-memory-import-poll-response" } } }, @@ -14642,7 +16940,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the path parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -14671,8 +16969,16 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -14686,61 +16992,64 @@ } } } - }, - "operationId": "ListTqaProfiles", - "description": "List TQA Profiles.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, + }, + "operationId": "PollTMImport", + "description": "Polls a Translation Memory import operation. The import is finished when the status is `done`.", + "parameters": [ { - "$ref": "#/components/parameters/sort" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/fields" + "$ref": "#/components/parameters/X-LC-Tenant" } + ], + "tags": [ + "Translation Memory Import" ] } }, - "/tqa-profiles/{profileId}": { - "get": { - "summary": "Get TQA Profile", - "tags": [ - "TQA Profile" - ], + "/translation-memory/{translationMemoryId}/exports": { + "parameters": [ + { + "$ref": "#/components/parameters/translationMemoryId" + } + ], + "post": { + "summary": "Export Translation Memory", + "operationId": "ExportTranslationMemory", "responses": { "200": { - "description": "OK", + "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/tqa-profile" + "$ref": "#/components/schemas/translation-memory-export-response" } } - }, + } + }, + "202": { + "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-export-response" + } + } } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* \"invalid\": Invalid input in the request parameters. Either the `translationMemoryId` or the `sourceLanguageCode`/`targetLanguageCode` are invalid.", "content": { "application/json": { "schema": { @@ -14756,94 +17065,102 @@ }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to export the translation memory.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": the User could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "GetTqaProfile", - "description": "Get a TQA Profile By identifier.", + "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](../reference/Public-API.v1.json/paths/~1translation-memory~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-memory-export-request" + } + } + } + }, + "tags": [ + "Translation Memory Export" ] - }, + } + }, + "/translation-memory/exports/{exportId}": { "parameters": [ { - "$ref": "#/components/parameters/profileId" + "$ref": "#/components/parameters/exportId" } - ] - }, - "/translation-memory/{translationMemoryId}": { + ], "get": { - "summary": "Get Translation Memory", + "summary": "Poll Translation Memory Export", "tags": [ - "Translation Memory" + "Translation Memory Export" ], "responses": { "200": { - "description": "", + "description": "OK", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory" + "$ref": "#/components/schemas/translation-memory-poll-export-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", "content": { "application/json": { "schema": { @@ -14859,78 +17176,92 @@ }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } } }, - "operationId": "GetTranslationMemory", - "description": "Get a single Translation Memory by identifier.", + "operationId": "PollTranslationMemoryExport", + "description": "Polls a translation memory via an export operation. The exported translation memory can be downloaded once the status is `done`.", "parameters": [ - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, { "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/fields" + "$ref": "#/components/parameters/X-LC-Tenant" } ] - }, - "put": { - "summary": "Update Translation Memory", - "operationId": "UpdateTranslationMemory", + } + }, + "/translation-memory/exports/{exportId}/download": { + "parameters": [ + { + "$ref": "#/components/parameters/exportId" + } + ], + "get": { + "summary": "Download Exported Translation Memory", + "tags": [ + "Translation Memory Export" + ], "responses": { - "204": { - "description": "No Content", + "200": { + "description": "OK", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + }, + "content": { + "application/octet-stream": { + "schema": { + "type": "string", + "format": "binary" + } + } } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", "content": { "application/json": { "schema": { @@ -14946,78 +17277,75 @@ }, "401": { "description": "The user could not be identified.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "403": { "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.md).", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/translation-memory-update-request" - } } } }, + "operationId": "DownloadExportedTranslationMemory", + "description": "Downloads the exported translation memory in the `tmx.gz` format when the poll operation status is `done`.", "parameters": [ { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/X-LC-Tenant" } - ], - "tags": [ - "Translation Memory" ] - }, - "delete": { - "summary": "Delete Translation Memory", - "operationId": "DeleteTranslationMemory", - "responses": { - "204": { - "description": "No Content", + } + }, + "/translations/lookup": { + "post": { + "summary": "Lookup", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-search-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -15025,7 +17353,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -15055,7 +17383,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { @@ -15070,7 +17398,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { @@ -15085,44 +17413,51 @@ } } }, - "description": "Deletes a Translation Memory.", + "operationId": "TranslationsLookup", + "x-stoplight": { + "id": "e1b35d4bkp1dq" + }, + "tags": [ + "Translation" + ], + "description": "Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-search-request" + } + } + }, + "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." + }, "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, { "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/fields" } - ], - "tags": [ - "Translation Memory" ] }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "translationMemoryId", - "in": "path", - "required": true, - "description": "The identifier of the translation memory" - } - ] + "parameters": [] }, - "/translation-memory/{translationMemoryId}/copy": { + "/translations/concordance": { "post": { - "summary": "Copy Translation Memory", + "summary": "Concordance", "tags": [ - "Translation Memory" + "Translation" ], "responses": { "200": { - "description": "", + "description": "OK.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory" + "$ref": "#/components/schemas/translation-concordance-search-response" } } }, @@ -15133,7 +17468,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -15163,7 +17498,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "description": "Unauthorized to use translation engine.", "content": { "application/json": { "schema": { @@ -15178,7 +17513,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": The translation memory could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { @@ -15193,45 +17528,48 @@ } } }, - "operationId": "CopyTranslationMemory", - "description": "Creates a copy of a Translation Memory. The name will be suffixed with ' (Copy) '", + "operationId": "TranslationsConcordanceSearch", + "x-stoplight": { + "id": "w7q4r8d7hum33" + }, + "description": "Performs a concordance search for a given text within the TM linked to the specified translation engine. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-concordance-search-request" + } + } + }, + "description": "Learn more about Translation Memory standard penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224).\r\n
\r\nLearn more about Translation Unit status penalties [here](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732)." + }, "parameters": [ { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } ] }, - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "translationMemoryId", - "in": "path", - "required": true, - "description": "The identifier of the translation memory" - } - ] + "parameters": [] }, - "/translation-memory": { - "get": { - "summary": "List Translation Memories", + "/translations/translation-unit": { + "put": { + "summary": "Update Translation Unit", "tags": [ - "Translation Memory" + "Translation" ], "responses": { "200": { - "description": "", + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-translation-memories-reposne" + "$ref": "#/components/schemas/translation-unit-add-update-response" } } }, @@ -15242,7 +17580,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -15271,8 +17609,23 @@ } } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", + "403": { + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { @@ -15287,45 +17640,44 @@ } } }, - "operationId": "ListTranslationMemories", - "description": "Retrieves all the Translation Memories.", + "operationId": "TranslationsUpdate", + "x-stoplight": { + "id": "pyjdd2h02zm8z" + }, + "description": "Updates a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", "parameters": [ - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, { "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" - }, - { - "$ref": "#/components/parameters/location-strategy" - }, - { - "$ref": "#/components/parameters/sort" + "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" } - ] + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/translation-update-request" + } + } + } + } }, "post": { - "summary": "Create Translation Memory", - "operationId": "CreateTranslationMemory", + "summary": "Add Translation Unit", + "tags": [ + "Translation" + ], "responses": { - "201": { - "description": "", + "200": { + "description": "Ok", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-base" + "$ref": "#/components/schemas/translation-unit-add-update-response" } } }, @@ -15336,7 +17688,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"maxSize\": Maximum size exceeded for the value mentioned in the \"name\" field on the error response.\n* \"minSize\": Minimum size not met for the value mentioned in the \"name\" field on the error response.", + "description": "Error codes: \n\n * \"empty\": Empty value for variable mentioned in the \"name\" field on the error response. \n\n * \"invalid\": Invalid input mentioned in the \"name\" field on the error response.", "content": { "application/json": { "schema": { @@ -15366,7 +17718,22 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + "description": "Unauthorized to use translation engine.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": - translation engine not found.", "content": { "application/json": { "schema": { @@ -15381,13 +17748,14 @@ } } }, - "description": "Create a new Translation Memory.", + "operationId": "TranslationsAdd", + "description": "Adds a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", "parameters": [ { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/X-LC-Tenant" }, { "$ref": "#/components/parameters/fields" @@ -15397,21 +17765,30 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-create-request" + "$ref": "#/components/schemas/translation-add-request" } } } - }, - "tags": [ - "Translation Memory" - ] + } } }, - "/translation-memory/field-templates": { + "/users/me": { "get": { - "summary": "List Field Templates", "tags": [ - "Translation Memory" + "User" + ], + "summary": "Get my User", + "description": "Retrieves the authenticated user.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } ], "responses": { "200": { @@ -15419,7 +17796,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-translation-memory-field-templates" + "$ref": "#/components/schemas/user" } } }, @@ -15458,78 +17835,51 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } } }, - "operationId": "ListFieldTemplates", + "operationId": "GetMyUser" + } + }, + "/users": { + "get": { + "tags": [ + "User" + ], + "summary": "List Users", + "description": "Retrieves a list of all the users in an account.", "parameters": [ { - "$ref": "#/components/parameters/top" + "$ref": "#/components/parameters/Authorization" }, { - "$ref": "#/components/parameters/skip" + "$ref": "#/components/parameters/X-LC-Tenant" }, { - "$ref": "#/components/parameters/sort" + "$ref": "#/components/parameters/top" }, { - "$ref": "#/components/parameters/location" + "$ref": "#/components/parameters/skip" }, { - "$ref": "#/components/parameters/location-strategy" + "$ref": "#/components/parameters/location" }, { - "$ref": "#/components/parameters/fields" + "$ref": "#/components/parameters/location-strategy" }, { - "$ref": "#/components/parameters/Authorization" + "$ref": "#/components/parameters/sort" }, { - "$ref": "#/components/parameters/X-LC-Tenant" + "$ref": "#/components/parameters/fields" } ], - "description": "Retrieves all the Field Templates." - }, - "parameters": [] - }, - "/translation-memory/field-templates/{fieldTemplateId}": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "fieldTemplateId", - "in": "path", - "required": true, - "description": "The field template identifier" - } - ], - "get": { - "summary": "Get Field Template", - "tags": [ - "Translation Memory" - ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-field-template" + "$ref": "#/components/schemas/list-users-response" } } }, @@ -15569,23 +17919,8 @@ } } }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { @@ -15600,7 +17935,16 @@ } } }, - "operationId": "GetFieldTemplate", + "operationId": "ListUsers" + } + }, + "/users/{userId}": { + "get": { + "tags": [ + "User" + ], + "summary": "Get User", + "description": "Retrieves a user by identifier.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -15612,30 +17956,13 @@ "$ref": "#/components/parameters/fields" } ], - "description": "Get a single Field Template by identifier." - } - }, - "/translation-memory/{translationMemoryId}/imports": { - "parameters": [ - { - "schema": { - "type": "string" - }, - "name": "translationMemoryId", - "description": "The identifier of the Translation Memory.", - "in": "path", - "required": true - } - ], - "get": { - "summary": "Get Translation Memory Import History", "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/list-translation-memory-import-history" + "$ref": "#/components/schemas/user" } } }, @@ -15646,22 +17973,24 @@ } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } } }, "401": { "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -15669,7 +17998,7 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", "content": { "application/json": { "schema": { @@ -15684,7 +18013,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", + "description": "error codes:\n* \"notFound\": the User could not be found by identifier.", "content": { "application/json": { "schema": { @@ -15699,68 +18028,49 @@ } } }, - "operationId": "GetTMImportHistory", - "description": "Gets the import history for a translation memory. It returns the history of last 7 days.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/fields" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - } - ], - "tags": [ - "Translation Memory Import" - ] + "operationId": "GetUser" }, - "post": { - "summary": "Import Translation Memory", - "operationId": "ImportTranslationMemory", + "parameters": [ + { + "$ref": "#/components/parameters/userId" + } + ] + }, + "/.well-known/jwks.json": { + "get": { + "summary": "List Public Keys", + "tags": [ + "Public Keys" + ], "responses": { "200": { - "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/translation-memory-import-response" - }, - "examples": { - "import-termbase-ok": { - "value": { - "id": "test-import-id", - "status": "queued" - } - } - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "202": { - "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-import-response" + "$ref": "#/components/schemas/well-known-jwks-response" }, "examples": { - "import-termbase-ok": { + "list-keys-ok": { "value": { - "id": "test-import-id", - "status": "queued" + "keys": [ + { + "kty": "test-kty-1", + "n": "test-n-1", + "e": "test-e-1", + "alg": "test-alg-1", + "kid": "test-kid-1", + "use": "test-use-1" + }, + { + "kty": "test-kty-2", + "n": "test-n-2", + "e": "test-e-2", + "alg": "test-alg-2", + "kid": "test-kid-2", + "use": "test-use-2" + } + ] } } } @@ -15772,23 +18082,8 @@ } } }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the query/form parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty mandatory value mentioned in the \"name\" field on the error response.\n* \"multiPartOrder\": The multipart order in the body is not correct. The `properties` must be first and then, file.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "401": { - "description": "The user could not be identified.", + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", "content": { "application/json": { "schema": { @@ -15801,18 +18096,37 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": Not authorized to import translation memories.", + } + }, + "operationId": "ListPublicKeys", + "description": "List all available Public Keys." + } + }, + "/.well-known/jwks.json/{kid}": { + "get": { + "summary": "Get Public Key", + "tags": [ + "Public Keys" + ], + "responses": { + "200": { + "description": "OK", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/error-response" - } - }, - "application/xml": { - "schema": { - "$ref": "#/components/schemas/error-response" + "$ref": "#/components/schemas/jwk" + }, + "examples": { + "get-key-ok": { + "value": { + "kty": "test-kty", + "n": "test-n", + "e": "test-e", + "alg": "test-alg", + "kid": "test-kid", + "use": "test-use" + } + } } } }, @@ -15823,7 +18137,7 @@ } }, "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the public key could not be found by identifier.", "content": { "application/json": { "schema": { @@ -15836,68 +18150,48 @@ "$ref": "#/components/headers/X-LC-TraceId" } } - } - }, - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ], - "requestBody": { - "content": { - "multipart/form-data": { - "schema": { - "type": "object", - "required": [ - "properties", - "file" - ], - "properties": { - "properties": { - "$ref": "#/components/schemas/translation-memory-import-request" - }, - "file": { - "type": "string", - "format": "binary", - "description": "The file (binary string) to import into the translation memory.
Accepted file types: .tmx, .sdltm, .zip, .tmx.gz, .sdlxliff" - } - } - }, - "examples": {} - } - }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." - }, - "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](../reference/Public-API.v1.json/paths/~1translation-memory~1imports~1{importId}/get).\n", - "tags": [ - "Translation Memory Import" - ] - } - }, - "/translation-memory/imports/{importId}": { + } + }, + "operationId": "GetPublicKey", + "description": "Retrieves a public key by it's identifier." + }, "parameters": [ { - "name": "importId", - "in": "path", - "required": true, "schema": { "type": "string" }, - "description": "The import identifier." + "name": "kid", + "in": "path", + "required": true, + "description": "The key identifier." } - ], + ] + }, + "/workflows/{workflowId}": { "get": { - "summary": "Poll Translation Memory Import", + "tags": [ + "Workflow" + ], + "summary": "Get Workflow", + "description": "Retrieves a workflow by identifier.", + "parameters": [ + { + "$ref": "#/components/parameters/Authorization" + }, + { + "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/fields" + } + ], "responses": { "200": { - "description": "OK", + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-import-poll-response" + "$ref": "#/components/schemas/workflow" } } }, @@ -15908,7 +18202,7 @@ } }, "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the path parameter mentioned in the “name” field on the error response.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -15938,15 +18232,17 @@ } }, "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the entry.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the workflow.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } } } }, "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", "content": { "application/json": { "schema": { @@ -15961,8 +18257,14 @@ } } }, - "operationId": "PollTMImport", - "description": "Polls a Translation Memory import operation. The import is finished when the status is `done`.", + "operationId": "GetWorkflow" + }, + "put": { + "tags": [ + "Workflow" + ], + "summary": "Update Workflow", + "description": "Updates the workflow in terms of: name, description, and task configuration (and its details). Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386).", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -15971,23 +18273,27 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "tags": [ - "Translation Memory Import" - ] - } - }, - "/translation-memory/{translationMemoryId}/exports": { - "parameters": [ - { - "$ref": "#/components/parameters/translationMemoryId" - } - ], - "post": { - "summary": "Export Translation Memory", - "operationId": "ExportTranslationMemory", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/workflow-update-request" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "OK - returned when the `status` field has one of the following values: `failed`, `done`, `cancelled`", + "204": { + "description": "No Content", + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "400": { + "description": "Error codes:\n* “invalid”: Invalid input in the body parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -15996,13 +18302,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-export-response" + "type": "object", + "$ref": "#/components/schemas/error-response" } } } }, - "202": { - "description": "Accepted - returned when the `status` field has one of the following values: `queued`, `inProgress`", + "401": { + "description": "The user could not be identified.", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -16011,13 +18318,14 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-export-response" + "type": "object", + "$ref": "#/components/schemas/error-response" } } } }, - "400": { - "description": "Error codes:\n* \"invalid\": Invalid input in the request parameters. Either the `translationMemoryId` or the `sourceLanguageCode`/`targetLanguageCode` are invalid.", + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Workflow.", "content": { "application/json": { "schema": { @@ -16031,38 +18339,23 @@ } } }, - "401": { - "description": "The user could not be identified.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "404": { + "description": "Error codes:\n* \"notFound\": the Workflow could not be found by identifier.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to export the translation memory.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } }, - "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + "409": { + "description": "Error codes:\r\n* \"projectPlanChanged\": The associated project has already been changed at the level of `projectPlan.taskConfigurations`. Updating the workflow is no longer possible; the project should be updated to set the relevant `projectPlan.taskConfigurations` fields. \r\n", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" @@ -16071,64 +18364,72 @@ "content": { "application/json": { "schema": { + "type": "object", "$ref": "#/components/schemas/error-response" } } } } }, - "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](../reference/Public-API.v1.json/paths/~1translation-memory~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", + "operationId": "UpdateWorkflow" + }, + "parameters": [ + { + "$ref": "#/components/parameters/workflowId" + } + ] + }, + "/workflows": { + "get": { + "tags": [ + "Workflow" + ], + "summary": "List Workflows", + "description": "Retrieves all the workflows in an account.", "parameters": [ { "$ref": "#/components/parameters/Authorization" }, { "$ref": "#/components/parameters/X-LC-Tenant" + }, + { + "$ref": "#/components/parameters/top" + }, + { + "$ref": "#/components/parameters/skip" + }, + { + "$ref": "#/components/parameters/location" + }, + { + "$ref": "#/components/parameters/location-strategy" + }, + { + "$ref": "#/components/parameters/sort" + }, + { + "$ref": "#/components/parameters/fields" } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/translation-memory-export-request" - } - } - } - }, - "tags": [ - "Translation Memory Export" - ] - } - }, - "/translation-memory/exports/{exportId}": { - "parameters": [ - { - "$ref": "#/components/parameters/exportId" - } - ], - "get": { - "summary": "Poll Translation Memory Export", - "tags": [ - "Translation Memory Export" - ], "responses": { "200": { - "description": "OK", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, + "description": "", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/translation-memory-poll-export-response" + "$ref": "#/components/schemas/list-workflows-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", + "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", "content": { "application/json": { "schema": { @@ -16144,92 +18445,73 @@ }, "401": { "description": "The user could not be identified.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "416": { + "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } } } }, - "operationId": "PollTranslationMemoryExport", - "description": "Polls a translation memory via an export operation. The exported translation memory can be downloaded once the status is `done`.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - } - ] + "operationId": "ListWorkflows" } }, - "/translation-memory/exports/{exportId}/download": { + "/projects/{projectId}/custom-fields/{customFieldKey}": { "parameters": [ { - "$ref": "#/components/parameters/exportId" + "name": "projectId", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "description": "The project identifier." + }, + { + "schema": { + "type": "string" + }, + "name": "customFieldKey", + "in": "path", + "required": true, + "description": "The custom field key." } ], - "get": { - "summary": "Download Exported Translation Memory", - "tags": [ - "Translation Memory Export" - ], + "put": { + "summary": "Update Custom Field", + "operationId": "UpdateCustomField", "responses": { - "200": { - "description": "OK", + "204": { + "description": "No Content", "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, - "content": { - "application/octet-stream": { - "schema": { - "type": "string", - "format": "binary" - } - } } }, "400": { - "description": "Error codes:\n* \"invalid\": Invalid `exportId` in the path parameters.", + "description": "Error codes:\n* “invalid”: Invalid input for a readOnly field, with a different value than the deafult one. Also this code is used for invalid input values", "content": { "application/json": { "schema": { @@ -16245,52 +18527,106 @@ }, "401": { "description": "The user could not be identified.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/error-response" + } + } + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "403": { + "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Custom field for the Project.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": The authenticated user is not allowed to read the resource.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } - }, + } + }, + "404": { + "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier or Custom field key could not be found or does not belong to the desired resource type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } - } - }, - "404": { - "description": "Error codes:\n* \"notFound\": The resource could not be found by identifier.", + }, "headers": { "X-LC-TraceId": { "$ref": "#/components/headers/X-LC-TraceId" } + } + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-field-update-request", + "description": "Thew new value along wit" + } + } + } + }, + "tags": [ + "Project" + ], + "description": "Allows updating individual custom fields on a project.", + "parameters": [] + } + }, + "/translation-domain/service-types": { + "get": { + "summary": "List Service Types", + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/list-translation-service-types-response" + } + } }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } + } + }, + "401": { + "description": "The user could not be identified.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error-response" } } + }, + "headers": { + "X-LC-TraceId": { + "$ref": "#/components/headers/X-LC-TraceId" + } } } }, - "operationId": "DownloadExportedTranslationMemory", - "description": "Downloads the exported translation memory in the `tmx.gz` format when the poll operation status is `done`.", + "operationId": "ListTranslationServiceTypes", + "x-stoplight": { + "id": "014dsosfughtk" + }, "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -16298,1535 +18634,1681 @@ { "$ref": "#/components/parameters/X-LC-Tenant" } - ] - } - }, - "/users/me": { - "get": { + ], "tags": [ - "User" + "Translation Domain" ], - "summary": "Get my User", - "description": "Retrieves the authenticated user.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + "description": "List all available service types." + } + } + }, + "components": { + "schemas": { + "account": { + "title": "Account", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The account identifier." }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "name": { + "type": "string", + "description": "
default
The account name.
", + "x-default-field": true + } + }, + "required": [ + "id" + ] + }, + "add-projects-to-group-request": { + "title": "Add Projects To Group Request", + "type": "object", + "description": "Input for adding projects to group.", + "properties": { + "projects": { + "type": "array", + "description": "The projects to be added to group.", + "items": { + "$ref": "#/components/schemas/project-group-project-request" + } + } + }, + "required": [ + "projects" + ] + }, + "add-projects-to-group-response": { + "title": "Add Projects To Group Response", + "type": "object", + "description": "Add Projects To Group response.", + "properties": { + "id": { + "type": "string", + "description": "The project group identifier." }, - { - "$ref": "#/components/parameters/fields" + "name": { + "type": "string", + "description": "The project group name." + }, + "description": { + "type": "string", + "description": "The project group description." + }, + "status": { + "type": "string", + "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", + "enum": [ + "new", + "inProgress", + "completed", + "deleting" + ] + }, + "projects": { + "type": "array", + "description": "The projects in the project group.", + "items": { + "$ref": "#/components/schemas/project-group-project" + } + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "shortId": { + "type": "string" + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" } + }, + "required": [ + "id" + ] + }, + "project-cost": { + "title": "Project Cost", + "x-stoplight": { + "id": "34d171ee75017" + }, + "type": "object", + "required": [ + "name", + "type", + "index", + "costPerUnit", + "unitCount" ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/user" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "properties": { + "name": { + "type": "string", + "description": "The name of the additional cost. " + }, + "type": { + "$ref": "#/components/schemas/project-cost-type", + "description": "The type of the additional cost." + }, + "index": { + "type": "number", + "description": "The number of the additional cost." + }, + "costPerUnit": { + "type": "number", + "description": "The cost of a unit." + }, + "unitCount": { + "type": "number", + "description": "The number of units for which a cost is applied." + }, + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as reference for the unit cost." + }, + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Only for the Conditional type." + }, + "costOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "dw5wpcfk70z9c" } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "costVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "np7a8b8w5ra70" } }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "operand": { + "type": "number", + "description": "Operand of the Conditional type cost." + }, + "serviceTypes": { + "type": "array", + "x-stoplight": { + "id": "gkyey7knc4j3v" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "description": "
default
Array of Service Type identifiers where this additional cost is applied. ", + "items": { + "x-stoplight": { + "id": "3e6kwmu58ut0p" + }, + "type": "string" } + }, + "customUnitName": { + "type": "string", + "x-stoplight": { + "id": "rovgmbrayoltf" + }, + "description": "The name of the custom unit." } + } + }, + "language-cost": { + "title": "Language Cost", + "x-stoplight": { + "id": "28d3xstakbk6t" }, - "operationId": "GetMyUser" - } - }, - "/users": { - "get": { - "tags": [ - "User" + "type": "object", + "required": [ + "name", + "type", + "index", + "costPerUnit", + "unitCount" ], - "summary": "List Users", - "description": "Retrieves a list of all the users in an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + "properties": { + "name": { + "type": "string", + "description": "The name of the additional cost. " }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "type": { + "$ref": "#/components/schemas/language-cost-type", + "description": "The type of the additional cost." }, - { - "$ref": "#/components/parameters/top" + "index": { + "type": "number", + "description": "The number of the additional cost." }, - { - "$ref": "#/components/parameters/skip" + "costPerUnit": { + "type": "number", + "description": "The cost of a unit." }, - { - "$ref": "#/components/parameters/location" + "unitCount": { + "type": "number", + "description": "The number of units for which a cost is applied." }, - { - "$ref": "#/components/parameters/location-strategy" + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, - { - "$ref": "#/components/parameters/sort" + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Only for the Conditional type." }, - { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/list-users-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "costOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "ak744d5hs26tb" } }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "costVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "
default
Only for the Conditional type.", + "x-stoplight": { + "id": "la3r0xwre29qy" } }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "operand": { + "type": "number", + "description": "
default
Operand of the Conditional type cost." + }, + "serviceTypes": { + "type": "array", + "x-stoplight": { + "id": "gkyey7knc4j3v" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "description": "
default
Array of Service Type identifiers where this additional cost is applied. ", + "items": { + "x-stoplight": { + "id": "3e6kwmu58ut0p" + }, + "type": "string" } }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "customUnitName": { + "type": "string", + "x-stoplight": { + "id": "6o3o1f3p0863z" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "description": "The name of the custom unit." } - }, - "operationId": "ListUsers" - } - }, - "/users/{userId}": { - "get": { - "tags": [ - "User" - ], - "summary": "Get User", - "description": "Retrieves a user by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + } + }, + "analysis-statistics": { + "title": "Analysis Statistics", + "type": "object", + "properties": { + "exactMatch": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "inContextExactMatch": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true }, - { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/user" - } - } + "perfectMatch": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + }, + "new": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + }, + "repetitions": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + }, + "crossDocumentRepetitions": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + }, + "machineTranslation": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + }, + "fuzzyMatch": { + "type": "array", + "items": { + "$ref": "#/components/schemas/fuzzy-count" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "description": "
default
Statistics count.
", + "x-default-field": true }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - } + "total": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", + "x-default-field": true + } + } + }, + "analytics": { + "title": "Analytics", + "type": "object", + "properties": { + "progress": { + "$ref": "#/components/schemas/analytics-progress" }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "overdueStatistics": { + "$ref": "#/components/schemas/analytics-overdue-statistics" + }, + "sourceFileStatistics": { + "type": "array", + "items": { + "$ref": "#/components/schemas/analytics-source-file-statistics" } }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the resource.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "workloadStatistics": { + "$ref": "#/components/schemas/analytics-workload-statistics" + }, + "taskTypeStatistics": { + "type": "array", + "items": { + "$ref": "#/components/schemas/analytics-task-type-statistics" } }, - "404": { - "description": "error codes:\n* \"notFound\": the User could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "phaseStatistics": { + "type": "array", + "items": { + "$ref": "#/components/schemas/analytics-phase-statistics" } } }, - "operationId": "GetUser" + "description": "Project analytics." }, - "parameters": [ - { - "$ref": "#/components/parameters/userId" + "analytics-progress": { + "title": "Analytics Progress", + "type": "object", + "description": "Overall progress.", + "properties": { + "overall": { + "type": "integer", + "nullable": true, + "description": "
default
The overall progress.
", + "x-default-field": true + } } - ] - }, - "/.well-known/jwks.json": { - "get": { - "summary": "List Public Keys", - "tags": [ - "Public Keys" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/well-known-jwks-response" - }, - "examples": { - "list-keys-ok": { - "value": { - "keys": [ - { - "kty": "test-kty-1", - "n": "test-n-1", - "e": "test-e-1", - "alg": "test-alg-1", - "kid": "test-kid-1", - "use": "test-use-1" - }, - { - "kty": "test-kty-2", - "n": "test-n-2", - "e": "test-e-2", - "alg": "test-alg-2", - "kid": "test-kid-2", - "use": "test-use-2" - } - ] - } - } - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + }, + "analytics-overdue-statistics": { + "title": "Analytics Overdue Statistics", + "type": "object", + "description": "Statistics on overdue work.", + "properties": { + "overdueTasks": { + "type": "integer", + "nullable": true, + "description": "
default
The number of overdue tasks.
", + "x-default-field": true + }, + "dueDateCloseTasks": { + "type": "integer", + "nullable": true, + "description": "
default
The number of tasks closed after the due date.
", + "x-default-field": true + } + } + }, + "analytics-source-file-statistics": { + "title": "Analytics Source File Statistics", + "type": "object", + "description": "Source file statistics grouped by role.", + "properties": { + "role": { + "$ref": "#/components/schemas/file-role", + "description": "
default
The file role.
", + "x-default-field": true + }, + "count": { + "type": "integer", + "nullable": true, + "description": "
default
The file count.
", + "x-default-field": true + } + } + }, + "analytics-workload-statistics": { + "title": "Analytics Workload Statistics", + "type": "object", + "description": "Statistics on workload progress.", + "properties": { + "completed": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + }, + "total": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + } + } + }, + "analytics-task-type-statistics": { + "title": "Analytics Task Type Statistics", + "type": "object", + "description": "Task Type statistics grouped.", + "properties": { + "id": { + "type": "string", + "description": "
default
", + "x-default-field": true + }, + "key": { + "type": "string", + "description": "
default
", + "x-default-field": true + }, + "total": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + }, + "current": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + }, + "completed": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + }, + "error": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + } + } + }, + "analytics-phase-statistics": { + "title": "Analytics Phase Statistics", + "type": "object", + "description": "Statistics for phases grouped.", + "properties": { + "name": { + "type": "string", + "description": "
default
", + "x-default-field": true }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of it's dependencies attempted to retrieve data outside the allowed range.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "total": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true + }, + "completed": { + "type": "integer", + "nullable": true, + "description": "
default
", + "x-default-field": true } - }, - "operationId": "ListPublicKeys", - "description": "List all available Public Keys." - } - }, - "/.well-known/jwks.json/{kid}": { - "get": { - "summary": "Get Public Key", - "tags": [ - "Public Keys" - ], - "responses": { - "200": { - "description": "OK", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/jwk" - }, - "examples": { - "get-key-ok": { - "value": { - "kty": "test-kty", - "n": "test-n", - "e": "test-e", - "alg": "test-alg", - "kid": "test-kid", - "use": "test-use" - } - } - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + } + }, + "asynchronous-result": { + "title": "Asynchronous Result", + "type": "object", + "description": "Represents the result of an asynchronous operation, including status and potential error information.", + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the asynchronous operation." }, - "404": { - "description": "Error codes:\n* \"notFound\": the public key could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "status": { + "type": "string", + "description": "The status of the asynchronous operation.", + "enum": [ + "created", + "inProgress", + "completed", + "failed" + ] + }, + "errorMessage": { + "type": "string", + "description": "When the status is 'failed', it contains the error message explaining what went wrong." } }, - "operationId": "GetPublicKey", - "description": "Retrieves a public key by it's identifier." + "required": [ + "id", + "status" + ] }, - "parameters": [ - { - "schema": { - "type": "string" + "count": { + "title": "Count", + "type": "object", + "description": "Statistics count.", + "properties": { + "words": { + "type": "integer", + "description": "
default
Number of words.
", + "nullable": true, + "x-default-field": true }, - "name": "kid", - "in": "path", - "required": true, - "description": "The key identifier." - } - ] - }, - "/workflows/{workflowId}": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "Get Workflow", - "description": "Retrieves a workflow by identifier.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + "segments": { + "type": "integer", + "description": "
default
Number of segments.
", + "nullable": true, + "x-default-field": true }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "characters": { + "type": "integer", + "description": "
default
Number of characters.
", + "nullable": true, + "x-default-field": true }, - { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "placeables": { + "type": "integer", + "description": "
default
Number of placeables.
", + "nullable": true, + "x-default-field": true }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "tags": { + "type": "integer", + "description": "
default
Number of tags.
", + "nullable": true, + "x-default-field": true + } + } + }, + "configuration-resource-request": { + "title": "Configuration Resource Request", + "type": "object", + "description": "Resource configuration properties.", + "properties": { + "id": { + "type": "string", + "description": "Configuration resource identifier." }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "strategy": { + "type": "string", + "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", + "default": "copy", + "enum": [ + "copy", + "use" + ] + } + }, + "required": [ + "id" + ] + }, + "completion-config-request": { + "title": "Completion Configuration", + "x-stoplight": { + "id": "9mwe1gdglduma" + }, + "type": "object", + "description": "Completion configuration properties.", + "properties": { + "completeDays": { + "type": "number", + "description": "Number of days until automatic completion of the project. Starting from project creation date.", + "x-stoplight": { + "id": "ceanv1mabx8qq" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to read the workflow.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - } + "minimum": 1, + "maximum": 365, + "default": 90 }, - "404": { - "description": "Error codes:\n* \"notFound\": the resource could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "archiveDays": { + "type": "number", + "x-stoplight": { + "id": "l8bju7xnl0r40" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - } - }, - "operationId": "GetWorkflow" - }, - "put": { - "tags": [ - "Workflow" - ], - "summary": "Update Workflow", - "description": "Updates the workflow in terms of: name, description, and task configuration (and its details). Observe the rules of [JSON Merge Patch Semantics](https://tools.ietf.org/html/rfc7386).", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" + "minimum": 1, + "maximum": 365, + "default": 90, + "description": "Number of days after project completion when the project will be \r\narchived.." }, - { - "$ref": "#/components/parameters/X-LC-Tenant" + "archiveReminderDays": { + "type": "number", + "x-stoplight": { + "id": "bclu4cm76o4w4" + }, + "minimum": 1, + "maximum": 365, + "default": 7, + "description": "Number of days before archiving when a reminder will be sent." } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/workflow-update-request" - } - } - }, - "required": true + } + }, + "completion-config-response": { + "title": "Completion Configuration", + "x-stoplight": { + "id": "0z2k59nqy13cl" }, - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } - }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the body parameter mentioned in the “name” field on the error response.\n* \"empty\": Empty input in the body parameter mentioned in the \"name\" field on the error response.\n* \"limit.exceeded\": a maximum number of users per task was assigned\n", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "type": "object", + "description": "Completion configuration properties.", + "properties": { + "completeDate": { + "$ref": "#/components/schemas/date-time", + "x-stoplight": { + "id": "f7adiaz6qf6b4" }, - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/error-response" - } - } - } + "description": "
default
" }, - "401": { - "description": "The user could not be identified.", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/error-response" - } - } - } + "completeDays": { + "type": "number", + "description": "
default
Number of days until automatic completion of the project. Starting from project creation date.
", + "minimum": 1, + "maximum": 365, + "default": 90 }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Workflow.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "archiveDate": { + "$ref": "#/components/schemas/date-time", + "x-stoplight": { + "id": "z7g5nb84eytoc" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "description": "
default
" }, - "404": { - "description": "Error codes:\n* \"notFound\": the Workflow could not be found by identifier.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "archiveDays": { + "type": "number", + "minimum": 1, + "maximum": 365, + "default": 90, + "description": "
default
Number of days after project completion when the workflow will be stopped and the project will enter *archived* state.
", + "x-stoplight": { + "id": "s30y2qk8d359o" } }, - "409": { - "description": "Error codes:\r\n* \"projectPlanChanged\": The associated project has already been changed at the level of `projectPlan.taskConfigurations`. Updating the workflow is no longer possible; the project should be updated to set the relevant `projectPlan.taskConfigurations` fields. \r\n", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - }, - "content": { - "application/json": { - "schema": { - "type": "object", - "$ref": "#/components/schemas/error-response" - } - } + "archiveReminderDays": { + "type": "number", + "minimum": 1, + "maximum": 365, + "default": 7, + "description": "
default
Number of days before workflow stoppage when a reminder will be sent.
", + "x-stoplight": { + "id": "z0iqmdumocd9v" } } + } + }, + "conditional-cost-operator": { + "title": "Conditional Cost Operator", + "x-stoplight": { + "id": "u0in7jsh95abi" }, - "operationId": "UpdateWorkflow" + "enum": [ + "less", + "lessOrEqual", + "greater", + "greaterOrEqual" + ] }, - "parameters": [ - { - "$ref": "#/components/parameters/workflowId" - } - ] - }, - "/workflows": { - "get": { - "tags": [ - "Workflow" - ], - "summary": "List Workflows", - "description": "Retrieves all the workflows in an account.", - "parameters": [ - { - "$ref": "#/components/parameters/Authorization" - }, - { - "$ref": "#/components/parameters/X-LC-Tenant" - }, - { - "$ref": "#/components/parameters/top" - }, - { - "$ref": "#/components/parameters/skip" - }, - { - "$ref": "#/components/parameters/location" + "conditional-cost-type": { + "title": "Conditional Cost Type", + "x-stoplight": { + "id": "br34ph3abddli" + }, + "enum": [ + "absolute", + "relative", + "percentage" + ] + }, + "conditional-cost-variable": { + "title": "Conditional Cost Variable", + "x-stoplight": { + "id": "e97vbe2580u68" + }, + "enum": [ + "wordCount", + "runningTotal" + ] + }, + "customer": { + "title": "Customer", + "type": "object", + "description": "Customer resource.", + "properties": { + "id": { + "type": "string", + "description": "Customer identifier." }, - { - "$ref": "#/components/parameters/location-strategy" + "name": { + "type": "string", + "description": "
default
Customer name.
", + "x-default-field": true }, - { - "$ref": "#/components/parameters/sort" + "keyContact": { + "$ref": "#/components/schemas/user" }, - { - "$ref": "#/components/parameters/fields" - } - ], - "responses": { - "200": { - "description": "", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/list-workflows-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "location": { + "$ref": "#/components/schemas/folder-v2" }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input in the query parameter mentioned in the “name” field on the error response.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "ragStatus": { + "x-stoplight": { + "id": "z7v6f1w7qrqdj" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "enum": [ + "green", + "amber", + "red" + ] }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } + "customFieldDefinitions": { + "type": "array", + "description": "The custom field definitions.", + "items": { + "$ref": "#/components/schemas/custom-field-resource" } + } + }, + "required": [ + "id" + ] + }, + "custom-field": { + "title": "Custom Field", + "type": "object", + "description": "A Custom Field model.", + "properties": { + "id": { + "type": "string", + "description": "Custom Field identifier." }, - "416": { - "description": "Error codes:\n* \"requestedRangeNotSatisfiable\": The requested entity or one of its dependencies attempted to retrieve data outside the allowed range. Skip+Top might be outside the supported range.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } + "name": { + "type": "string", + "x-stoplight": { + "id": "ln5wrk75uaby5" }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "description": "Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)" + }, + "key": { + "type": "string", + "description": "Custom Field friendly key." + }, + "value": { + "type": "object", + "description": "The value of the custom property. A date will be serialised as an ISO_8601 string." } }, - "operationId": "ListWorkflows" - } - }, - "/projects/{projectId}/custom-fields/{customFieldKey}": { - "parameters": [ - { - "name": "projectId", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "description": "The project identifier." + "required": [ + "id" + ] + }, + "customer-create-request": { + "title": "Customer Create Request", + "x-stoplight": { + "id": "f8bca95391ffb" }, - { - "schema": { - "type": "string" - }, - "name": "customFieldKey", - "in": "path", - "required": true, - "description": "The custom field key." - } - ], - "put": { - "summary": "Update Custom Field", - "operationId": "UpdateCustomField", - "responses": { - "204": { - "description": "No Content", - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "type": "object", + "description": "Input for Customer creation.\n\n It will create an invitation for an account user account.", + "properties": { + "name": { + "type": "string", + "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "maxLength": 50 }, - "400": { - "description": "Error codes:\n* “invalid”: Invalid input for a readOnly field, with a different value than the deafult one. Also this code is used for invalid input values", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "location": { + "type": "string", + "description": "The identifier of the parent folder for the customer." }, - "401": { - "description": "The user could not be identified.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "firstName": { + "type": "string", + "description": "Key contact first name. If you provide this field, pleaase also provide email and last name" }, - "403": { - "description": "Error codes:\n* \"forbidden\": the authenticated user is not allowed to update the Custom field for the Project.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "lastName": { + "type": "string", + "description": "Key contact last name. If you provide this field, pleaase also provide email and first name" }, - "404": { - "description": "Error codes:\n* \"notFound\": the Project could not be found by identifier or Custom field key could not be found or does not belong to the desired resource type.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/error-response" - } - } - }, - "headers": { - "X-LC-TraceId": { - "$ref": "#/components/headers/X-LC-TraceId" - } - } + "email": { + "type": "string", + "description": "Key contact email.. If you provide this field, pleaase also provide first name and last name" } }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/custom-field-update-request", - "description": "Thew new value along wit" + "required": [ + "name" + ] + }, + "customer-update-request": { + "title": "Customer Update Request", + "x-stoplight": { + "id": "03m0q1ecjc9q0" + }, + "type": "object", + "description": "Input for Customer update.\n\n", + "properties": { + "name": { + "type": "string", + "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "maxLength": 50 + }, + "keyContactId": { + "type": "string", + "description": "The ID of the account user set as key contact." + }, + "ragStatus": { + "type": "string", + "description": "The color tag used to mark-up a customer in the UI.", + "enum": [ + "green", + "amber", + "red" + ] + }, + "customFieldDefinitions": { + "description": "The Custom Fields", + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-resource", + "x-stoplight": { + "id": "jwte0fv6wp2z7" } } + }, + "folderVisibility": { + "type": "string", + "description": "The folder visibility to its subfolders.", + "enum": [ + "default", + "private" + ] } - }, - "tags": [ - "Project" + } + }, + "custom-field-resource": { + "title": "Custom Field Resource", + "type": "object", + "description": "A Custom Field resource model.", + "required": [ + "key", + "value" ], - "description": "Allows updating individual custom fields on a project.", - "parameters": [] - } - } - }, - "components": { - "schemas": { - "account": { - "title": "Account", + "properties": { + "key": { + "type": "string", + "description": "Custom Field friendly key." + }, + "value": { + "type": "object", + "description": "The value of the custom property. A date will be serialized as an ISO_8601 string." + } + } + }, + "custom-field-definition": { + "title": "Custom Field Definition", "type": "object", + "description": "The Custom Field definition.", "properties": { "id": { "type": "string", - "description": "The account identifier." + "description": "The identifier of the Custom Field Definition, generated by the service." }, "name": { "type": "string", - "description": "
default
The account name.
", + "description": "
default
The display name of the Custom Field.
", "x-default-field": true + }, + "key": { + "type": "string", + "description": "The key of the Custom Field, used for querying purposes." + }, + "description": { + "type": "string", + "description": "The description of the Custom Field." + }, + "type": { + "type": "string", + "description": "The value type supported by this Custom Field.", + "enum": [ + "long", + "double", + "boolean", + "date", + "string", + "checkbox", + "longtext", + "picklist", + "multiSelectPicklist" + ], + "nullable": true + }, + "pickListOptions": { + "type": "array", + "description": "Possible values if the type selected is \"picklist\" or \"multiSelectPicklist\".", + "uniqueItems": true, + "items": { + "type": "string" + } + }, + "resourceType": { + "type": "string", + "description": "The resource type to which this Custom Field can be applied.", + "enum": [ + "project", + "customer" + ] + }, + "isReadOnly": { + "type": "boolean", + "nullable": true + }, + "defaultValue": { + "type": "string", + "description": "Specifies a default value for this Custom Field. This is required if the \"isReadOnly\" field is True." + }, + "isMandatory": { + "type": "boolean", + "description": "Specifies if this Custom Field is mandatory when creating a resource of the supported type.", + "nullable": true + }, + "location": { + "$ref": "#/components/schemas/folder-v2" } }, "required": [ "id" ] }, - "add-projects-to-group-request": { - "title": "Add Projects To Group Request", + "custom-field-request": { + "title": "Custom Field Request", "type": "object", - "description": "Input for adding projects to group.", + "description": "A Custom Field model used at project creation or project update.", "properties": { - "projects": { + "key": { + "type": "string", + "description": "Custom Field friendly key." + }, + "value": { + "type": "object", + "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " + } + }, + "required": [ + "key" + ] + }, + "custom-field-update-request": { + "title": "Custom Field Update Request", + "x-stoplight": { + "id": "69hm58ubq50j6" + }, + "type": "object", + "description": "", + "properties": { + "value": { + "type": "object", + "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " + } + }, + "required": [ + "value" + ] + }, + "date-time": { + "type": "string", + "title": "DateTime", + "example": "2022-01-12T12:00:00.000Z", + "description": "UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "error-response": { + "title": "Error Response", + "type": "object", + "description": "Error response properties.", + "properties": { + "message": { + "type": "string", + "description": "Retrieves a descriptive message that shows what went wrong." + }, + "errorCode": { + "type": "string", + "description": "Concise code that describes the nature of the error." + }, + "details": { "type": "array", - "description": "The projects to be added to group.", "items": { - "$ref": "#/components/schemas/project-group-project-request" + "$ref": "#/components/schemas/error-detail-response" } } }, "required": [ - "projects" + "message", + "errorCode" ] }, - "add-projects-to-group-response": { - "title": "Add Projects To Group Response", + "error-detail-response": { + "title": "Error Detail Response", "type": "object", - "description": "Add Projects To Group response.", + "description": "Error detail response properties.", "properties": { - "id": { + "name": { "type": "string", - "description": "The project group identifier." + "description": "" + }, + "code": { + "type": "string", + "description": "" }, + "value": { + "type": "string" + } + } + }, + "translation-error-detail-response": { + "title": "Translation Errors Response", + "type": "object", + "description": "Translation error details response properties.", + "properties": { "name": { "type": "string", - "description": "The project group name." + "description": "
default
", + "x-default-field": true }, - "description": { + "code": { "type": "string", - "description": "The project group description." + "description": "
default
", + "x-default-field": true }, - "status": { + "value": { "type": "string", - "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", - "enum": [ - "new", - "inProgress", - "completed", - "deleting" - ] + "description": "
default
", + "x-default-field": true + } + } + }, + "export-quote-report-response": { + "title": "Export Quote Report Response", + "type": "object", + "description": "Export quote report response.", + "properties": { + "id": { + "type": "string", + "description": "The export quote report identifier." + } + } + }, + "failed-task": { + "title": "Failed Task", + "type": "object", + "description": "Failed Task.", + "properties": { + "id": { + "type": "string", + "description": "The failed task identifier." }, - "projects": { + "name": { + "type": "string", + "description": "The failed task name." + }, + "errors": { "type": "array", - "description": "The projects in the project group.", + "description": "The failed task errors.", "items": { - "$ref": "#/components/schemas/project-group-project" + "$ref": "#/components/schemas/task-error" } + } + }, + "required": [ + "id", + "name" + ] + }, + "file-analysis-response": { + "title": "File Analysis Response", + "x-stoplight": { + "id": "jzn363iiki313" + }, + "type": "object", + "required": [ + "status" + ], + "properties": { + "status": { + "x-stoplight": { + "id": "dfww4v5fop36i" + }, + "description": "The status of the file analysis operation.\r\n\r\n`converting` - The files are being converted for analysis.
\r\n`analysis` - Extracting the word count from the files.
\r\n`costEstimation` - Estimating the cost.
\r\n`completed` - The file analysis is completed.
\r\n`error` - The file analysis was unsuccessful. See the `errorMessage` field for more details.", + "enum": [ + "converting", + "analysis", + "costCalculation", + "completed", + "error" + ] }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "wordCount": { + "type": "integer", + "x-stoplight": { + "id": "hprd8di53gl2v" + }, + "description": "
default
The total word count of the files.
", + "x-default-field": true }, - "shortId": { - "type": "string" + "estimatedCosts": { + "$ref": "#/components/schemas/file-analysis-cost-response", + "x-stoplight": { + "id": "z0yw6q0m1yaq3" + }, + "description": "The estimated costs." }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time" + "fileStatistics": { + "x-stoplight": { + "id": "0v204bl8ergop" + }, + "description": "
default
The word count breakdown by files.
", + "x-default-field": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/file-analysis-file-statistics", + "x-stoplight": { + "id": "umj4xnnmpqam9" + } + } }, - "lastModifiedAt": { + "errorMessage": { "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "format": "date-time" + "x-stoplight": { + "id": "trjzuxk6rorpo" + }, + "description": "The cause of the error when the status is `error`." } + } + }, + "file-analysis-operation-response": { + "x-stoplight": { + "id": "0ptcnthovbi2q" }, + "title": "File Analysis Operation Response", + "type": "object", "required": [ "id" - ] + ], + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "20knift0n9bey" + }, + "description": "The analysis operation id. Use this to poll it's status." + } + } }, - "additional-cost": { - "title": "Additional Cost", + "file-analysis-cost-response": { + "title": "File Analysis Cost Response", + "x-stoplight": { + "id": "w8nmywx87l747" + }, "type": "object", + "required": [ + "total" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the additional cost. " - }, - "type": { + "currencyCode": { "type": "string", - "enum": [ - "volume", - "perTargetLanguage", - "perFile", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost." + "x-stoplight": { + "id": "hprd8di53gl2v" + }, + "description": "The currency code (ISO 4217)." }, - "index": { + "total": { "type": "number", - "description": "The number of the additional cost." + "x-stoplight": { + "id": "dfww4v5fop36i" + }, + "description": "The total cost calculated for the provided files and language pairs.
\r\nIt represents the sum of the `translationCosts`, `languageCosts` and `additionalCosts`." }, - "costPerUnit": { + "translationCosts": { "type": "number", - "description": "The cost of a unit." + "x-stoplight": { + "id": "8tiwwuff0g2eh" + }, + "description": "The base translation costs." }, - "unitCount": { + "languageCosts": { "type": "number", - "description": "The number of units for which a cost is applied." - }, - "volumeUnitType": { - "type": "string", - "description": "The unit type of the 'volume' cost, used as reference for the unit cost.", - "enum": [ - "words", - "characters" - ] - }, - "conditionalCostType": { - "type": "string", - "description": "Only for the Conditional type.", - "enum": [ - "absolute", - "relative", - "percentage" - ] - }, - "costOperator": { - "type": "string", - "description": "Only for the Conditional type.", - "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" - ] - }, - "costVariable": { - "type": "string", - "description": "Only for the Conditional type.", - "enum": [ - "wordCount", - "runningTotal" - ] + "x-stoplight": { + "id": "z0yw6q0m1yaq3" + }, + "description": "The additional language costs." }, - "operand": { + "additionalCosts": { "type": "number", - "description": "Operand of the Conditional type cost." + "x-stoplight": { + "id": "ardngvieg6vrm" + }, + "description": "The additional translation costs." } - }, - "required": [ - "name", - "type", - "index", - "costPerUnit", - "unitCount", - "volumeUnitType", - "conditionalCostType", - "costOperator", - "costVariable", - "operand" - ] + } }, - "additional-cost-language": { - "title": "Additional Cost", + "file-analysis-file-statistics": { + "title": "File Analysis File Statistics", "x-stoplight": { - "id": "28d3xstakbk6t" + "id": "67ic0f0jm8by8" }, "type": "object", + "required": [ + "fileId", + "wordCount" + ], "properties": { - "name": { - "type": "string", - "description": "The name of the additional cost. " - }, - "type": { - "type": "string", - "enum": [ - "volume", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost." - }, - "index": { - "type": "number", - "description": "
default
The number of the additional cost." - }, - "costPerUnit": { - "type": "number", - "description": "
default
The cost of a unit." - }, - "unitCount": { - "type": "number", - "description": "
default
The number of units for which a cost is applied." - }, - "volumeUnitType": { - "type": "string", - "description": "
default
The unit type of the 'volume' cost, used as reference for the unit cost.", - "enum": [ - "words", - "characters" - ] - }, - "conditionalCostType": { + "fileId": { "type": "string", - "description": "
default
Only for the Conditional type.", - "enum": [ - "absolute", - "relative", - "percentage" - ] + "x-stoplight": { + "id": "2azn3zm063bur" + }, + "description": "The file identifier." }, - "costOperator": { + "wordCount": { + "type": "integer", + "x-stoplight": { + "id": "ivreutiffxph6" + }, + "description": "The number of words in this file." + } + } + }, + "file-processing-configuration": { + "title": "File Processing Configuration", + "type": "object", + "description": "File Processing Configuration resource. (Not available for List Projects endpoint)", + "properties": { + "id": { "type": "string", - "description": "
default
Only for the Conditional type.", - "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" - ] + "description": "The file processing configuration identifier." }, - "costVariable": { + "name": { "type": "string", - "description": "
default
Only for the Conditional type.", - "enum": [ - "wordCount", - "runningTotal" - ] - }, - "operand": { - "type": "number", - "description": "
default
Operand of the Conditional type cost." + "description": "
default
The file processing configuration name.
", + "x-default-field": true }, - "serviceTypes": { - "type": "array", - "x-stoplight": { - "id": "gkyey7knc4j3v" - }, - "description": "
default
Array of task type identifiers where this additional cost is applied.", - "items": { - "x-stoplight": { - "id": "3e6kwmu58ut0p" - }, - "type": "string" - } + "location": { + "$ref": "#/components/schemas/folder-v2" } }, "required": [ - "name", - "type" + "id" ] }, - "analysis-statistics": { - "title": "Analysis Statistics", + "file-type-setting": { + "title": "File Type Setting", + "x-stoplight": { + "id": "twyoqd5uer5g0" + }, "type": "object", "properties": { - "exactMatch": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - }, - "inContextExactMatch": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - }, - "perfectMatch": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - }, - "new": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - }, - "repetitions": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - }, - "crossDocumentRepetitions": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true + "id": { + "type": "string", + "description": "The file type setting identifier." }, - "machineTranslation": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", + "name": { + "type": "string", + "description": "
default
The file type name.
", "x-default-field": true }, - "fuzzyMatch": { - "type": "array", - "items": { - "$ref": "#/components/schemas/fuzzy-count" - }, - "description": "
default
Statistics count.
", - "x-default-field": true + "description": { + "type": "string" }, - "total": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true - } - } - }, - "analytics": { - "title": "Analytics", - "type": "object", - "properties": { - "progress": { - "$ref": "#/components/schemas/analytics-progress" + "typeId": { + "type": "string", + "description": "A short string representation of the file type identifier. The ID displayed in the Trados Cloud Platform UI." }, - "overdueStatistics": { - "$ref": "#/components/schemas/analytics-overdue-statistics" + "enabled": { + "type": "boolean", + "description": "
default
Is this file type setting enabled. Disabled file types will not be included in operations (ex. Scan)
", + "nullable": true, + "x-default-field": true }, - "sourceFileStatistics": { - "type": "array", - "items": { - "$ref": "#/components/schemas/analytics-source-file-statistics" - } + "excluded": { + "type": "boolean", + "description": "Is this file type setting included in the file processing configuration. \n\nFile types will be added to a configuration as excluded = true by default and can be included by a consumer when needed (via the Trados Cloud Platform UI)\n\nExcluded file types will not be included in operations (ex. Scan)", + "nullable": true }, - "workloadStatistics": { - "$ref": "#/components/schemas/analytics-workload-statistics" + "deprecated": { + "type": "boolean", + "description": "This file type setting is planned for deprecation and will be removed in the future.", + "nullable": true }, - "taskTypeStatistics": { - "type": "array", - "items": { - "$ref": "#/components/schemas/analytics-task-type-statistics" - } + "orderNumber": { + "type": "integer", + "description": "The order of the setting in the file type configuration." }, - "phaseStatistics": { + "extensions": { "type": "array", + "description": "A collection of extensions supported by this file type. Ex: \"*.xlsx\"", "items": { - "$ref": "#/components/schemas/analytics-phase-statistics" + "type": "string" } } }, - "description": "Project analytics." + "required": [ + "id" + ], + "description": "" }, - "analytics-progress": { - "title": "Analytics Progress", + "file-upload-response": { + "title": "File Upload Response", "type": "object", - "description": "Overall progress.", "properties": { - "overall": { - "type": "integer", - "nullable": true, - "description": "
default
The overall progress.
", - "x-default-field": true + "id": { + "type": "string", + "description": "The identifier of the uploaded file" + }, + "fileName": { + "type": "string", + "description": "The name of the uploaded file" + }, + "unzipStatus": { + "type": "string", + "enum": [ + "queued", + "extracting", + "extracted", + "unzipError" + ], + "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." } - } + }, + "required": [ + "id", + "fileName" + ] }, - "analytics-overdue-statistics": { - "title": "Analytics Overdue Statistics", + "file-metadata-response": { + "title": "File Metadata Response", "type": "object", - "description": "Statistics on overdue work.", "properties": { - "overdueTasks": { - "type": "integer", - "nullable": true, - "description": "
default
The number of overdue tasks.
", - "x-default-field": true + "id": { + "type": "string", + "description": "The identifier of the uploaded file" }, - "dueDateCloseTasks": { - "type": "integer", - "nullable": true, - "description": "
default
The number of tasks closed after the due date.
", - "x-default-field": true + "fileName": { + "type": "string", + "description": "The name of the uploaded file" + }, + "unzipStatus": { + "type": "string", + "enum": [ + "queued", + "extracting", + "extracted", + "unzipError" + ], + "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." + }, + "associatedFiles": { + "type": "array", + "description": "The files that were extracted from the uploaded .zip archive.", + "items": { + "$ref": "#/components/schemas/file-extracted-response" + } } - } + }, + "required": [ + "id", + "fileName" + ] }, - "analytics-source-file-statistics": { - "title": "Analytics Source File Statistics", + "file-extracted-response": { + "title": "File Extracted Response", "type": "object", - "description": "Source file statistics grouped by role.", "properties": { - "role": { - "$ref": "#/components/schemas/file-role", - "description": "
default
The file role.
", - "x-default-field": true + "id": { + "type": "string", + "description": "The identifier of the extracted file." }, - "count": { - "type": "integer", - "nullable": true, - "description": "
default
The file count.
", - "x-default-field": true + "fileName": { + "type": "string", + "description": "The name of the extracted file." + }, + "filePath": { + "type": "string", + "description": "The file path of the extracted file. This is relative to the archive root." } - } + }, + "required": [ + "id", + "fileName", + "filePath" + ] }, - "analytics-workload-statistics": { - "title": "Analytics Workload Statistics", - "type": "object", - "description": "Statistics on workload progress.", - "properties": { - "completed": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + "file-role": { + "type": "string", + "title": "File-Role", + "enum": [ + "translatable", + "reference", + "localizable", + "unknown" + ], + "nullable": true + }, + "file-version-export": { + "title": "File Version Export", + "description": "File Version Export. The resulted version can be downloaded once the status is completed.", + "allOf": [ + { + "$ref": "#/components/schemas/asynchronous-result" }, - "total": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + { + "type": "object", + "properties": { + "downloadUrl": { + "type": "string", + "description": "The url where the file can be downloaded." + } + } } - } + ] }, - "analytics-task-type-statistics": { - "title": "Analytics Task Type Statistics", + "file-version-import": { + "title": "File Version Import", + "allOf": [ + { + "$ref": "#/components/schemas/asynchronous-result" + }, + { + "type": "object", + "properties": { + "fileVersionId": { + "type": "string" + } + } + } + ] + }, + "folder": { + "title": "Folder", "type": "object", - "description": "Task Type statistics grouped.", + "description": "Folder used for resource storage.", + "examples": [ + { + "id": "1de8f71c357c4bb5a32626faf5f53ef1", + "name": "consumer_A", + "path": [ + { + "id": "7fb808326daa4bb1988ckedcd0734aa6", + "location": "0e6d1f1aa8df46e6b9b111ca9f388c9e", + "name": "dexters_extensibility_consumer", + "hasParent": true + }, + { + "id": "0e6d1f1aa8df46e6b9b111ca9f388c9e", + "location": "61e801fa3d600fe2cfs12dd08", + "name": "Customers", + "hasParent": true + }, + { + "id": "61e801fa3d600fe2cfs12dd08", + "name": "61e801fa3d600fe2cfs12dd08", + "hasParent": false + } + ] + } + ], + "required": [ + "id" + ], "properties": { "id": { "type": "string", - "description": "
default
", - "x-default-field": true - }, - "key": { - "type": "string", - "description": "
default
", - "x-default-field": true - }, - "total": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true - }, - "current": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + "description": "The folder identifier." }, - "completed": { - "type": "integer", - "nullable": true, - "description": "
default
", + "name": { + "type": "string", + "description": "
default
The name of the folder.
", "x-default-field": true }, - "error": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + "hasParent": { + "type": "boolean", + "description": "Indicates if the folder has a parent folder.", + "nullable": true + }, + "path": { + "type": "array", + "x-stoplight": { + "id": "31bd3get7o6hk" + }, + "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", + "items": { + "$ref": "#/components/schemas/folder-path", + "x-stoplight": { + "id": "i4c2vlnydf80m" + } + } } } }, - "analytics-phase-statistics": { - "title": "Analytics Phase Statistics", + "folder-v2": { + "title": "Folder", "type": "object", - "description": "Statistics for phases grouped.", + "description": "Folder used for resource storage.", "properties": { + "id": { + "type": "string", + "description": "The folder identifier." + }, "name": { "type": "string", - "description": "
default
", + "description": "
default
The name of the folder.
", "x-default-field": true }, - "total": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + "hasParent": { + "type": "boolean", + "description": "Indicates if the folder has a parent folder.", + "nullable": true }, - "completed": { - "type": "integer", - "nullable": true, - "description": "
default
", - "x-default-field": true + "path": { + "type": "array", + "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", + "items": { + "$ref": "#/components/schemas/folder-path" + } } - } + }, + "required": [ + "id" + ] }, - "asynchronous-result": { - "title": "Asynchronous Result", + "folder-path": { + "title": "Folder Path", "type": "object", - "description": "Represents the result of an asynchronous operation, including status and potential error information.", + "description": "Path of a folder.", "properties": { "id": { "type": "string", - "description": "Unique identifier for the asynchronous operation." + "description": "The folder identifier." }, - "status": { + "name": { "type": "string", - "description": "The status of the asynchronous operation.", - "enum": [ - "created", - "inProgress", - "completed", - "failed" - ] + "description": "The name of the folder." }, - "errorMessage": { + "location": { "type": "string", - "description": "When the status is 'failed', it contains the error message explaining what went wrong." + "description": "
default
The location identifier." + }, + "hasParent": { + "type": "boolean", + "description": "
default
Indicates if the folder has a parent folder.", + "nullable": true } }, "required": [ "id", - "status" + "name" ] }, - "count": { - "title": "Count", + "fuzzy-category": { + "title": "Fuzzy Category", "type": "object", - "description": "Statistics count.", + "description": "Fuzzy category range. Example of Fuzzy bands: 100-100%, 95-99%, 85-94%, 75-84%, 50-74%.", "properties": { - "words": { - "type": "integer", - "description": "
default
Number of words.
", - "nullable": true, - "x-default-field": true - }, - "segments": { + "minimum": { "type": "integer", - "description": "
default
Number of segments.
", + "description": "
default
The minimum of the range.
", "nullable": true, "x-default-field": true }, - "characters": { + "maximum": { "type": "integer", - "description": "
default
Number of characters.
", + "description": "
default
The maximum of the range.
", "nullable": true, "x-default-field": true - }, - "placeables": { - "type": "integer", - "description": "
default
Number of placeables.
", - "nullable": true, + } + } + }, + "fuzzy-count": { + "title": "Fuzzy Count", + "type": "object", + "description": "Statistics count for fuzzy matches.", + "properties": { + "count": { + "$ref": "#/components/schemas/count", + "description": "
default
Statistics count.
", "x-default-field": true }, - "tags": { - "type": "integer", - "description": "
default
Number of tags.
", - "nullable": true, + "category": { + "$ref": "#/components/schemas/fuzzy-category", + "description": "
default
Fuzzy category range.
", "x-default-field": true } } }, - "configuration-resource-request": { - "title": "Configuration Resource Request", + "fuzzy-match-category": { + "title": "Fuzzy Match Category", "type": "object", - "description": "Resource configuration properties.", + "description": "Fuzzy match category range.", "properties": { - "id": { - "type": "string", - "description": "Configuration resource identifier." + "minimumMatchValue": { + "type": "integer", + "nullable": true, + "description": "Minimum matching value of this range." }, - "strategy": { - "type": "string", - "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", - "default": "copy", - "enum": [ - "copy", - "use" - ] + "maximumMatchValue": { + "type": "integer", + "nullable": true, + "description": "Maximum matching value of this range." } }, "required": [ - "id" + "minimumMatchValue", + "maximumMatchValue" ] }, - "completion-config-request": { - "title": "Completion Configuration", - "x-stoplight": { - "id": "9mwe1gdglduma" - }, - "type": "object", - "description": "Completion configuration properties.", - "properties": { - "completeDays": { - "type": "number", - "description": "Number of days until automatic completion of the project. Starting from project creation date.", - "x-stoplight": { - "id": "ceanv1mabx8qq" - }, - "minimum": 1, - "maximum": 365, - "default": 90 - }, - "archiveDays": { - "type": "number", - "x-stoplight": { - "id": "l8bju7xnl0r40" - }, - "minimum": 1, - "maximum": 365, - "default": 90, - "description": "Number of days after project completion when the project will be \r\narchived.." - }, - "archiveReminderDays": { - "type": "number", - "x-stoplight": { - "id": "bclu4cm76o4w4" - }, - "minimum": 1, - "maximum": 365, - "default": 7, - "description": "Number of days before archiving when a reminder will be sent." - } - } - }, - "completion-config-response": { - "title": "Completion Configuration", - "x-stoplight": { - "id": "0z2k59nqy13cl" - }, + "fuzzy-match": { + "title": "Fuzzy Match", "type": "object", - "description": "Completion configuration properties.", + "description": "Fuzzy match model.", "properties": { - "completeDate": { - "$ref": "#/components/schemas/date-time", - "x-stoplight": { - "id": "f7adiaz6qf6b4" - }, - "description": "
default
" - }, - "completeDays": { - "type": "number", - "description": "
default
Number of days until automatic completion of the project. Starting from project creation date.
", - "minimum": 1, - "maximum": 365, - "default": 90 - }, - "archiveDate": { - "$ref": "#/components/schemas/date-time", - "x-stoplight": { - "id": "z7g5nb84eytoc" - }, - "description": "
default
" - }, - "archiveDays": { + "price": { "type": "number", - "minimum": 1, - "maximum": 365, - "default": 90, - "description": "
default
Number of days after project completion when the workflow will be stopped and the project will enter *archived* state.
", - "x-stoplight": { - "id": "s30y2qk8d359o" - } + "description": "Fuzzy match price for the range expressed in the category field." }, - "archiveReminderDays": { - "type": "number", - "minimum": 1, - "maximum": 365, - "default": 7, - "description": "
default
Number of days before workflow stoppage when a reminder will be sent.
", - "x-stoplight": { - "id": "z0iqmdumocd9v" - } + "category": { + "$ref": "#/components/schemas/fuzzy-match-category" } - } + }, + "required": [ + "price", + "category" + ] }, - "customer": { - "title": "Customer", + "group": { + "title": "Group", "type": "object", - "description": "Customer resource.", + "description": "Group of Users.", "properties": { "id": { "type": "string", - "description": "Customer identifier." + "description": "The group identifier." }, "name": { "type": "string", - "description": "
default
Customer name.
", + "description": "
default
The group name.
", "x-default-field": true }, - "keyContact": { - "$ref": "#/components/schemas/user" + "description": { + "type": "string", + "description": "The group description." }, "location": { "$ref": "#/components/schemas/folder-v2" }, - "ragStatus": { - "x-stoplight": { - "id": "z7v6f1w7qrqdj" - }, - "enum": [ - "green", - "amber", - "red" - ] - }, - "customFieldDefinitions": { + "users": { "type": "array", - "description": "The custom field definitions.", "items": { - "$ref": "#/components/schemas/custom-field-resource" + "$ref": "#/components/schemas/user" } } }, @@ -17834,1154 +20316,1165 @@ "id" ] }, - "custom-field": { - "title": "Custom Field", + "group-request": { + "title": "Group Request", "type": "object", - "description": "A Custom Field model.", + "description": "Group of users.", "properties": { "id": { "type": "string", - "description": "Custom Field identifier." + "description": "The group identifier." }, "name": { "type": "string", - "x-stoplight": { - "id": "ln5wrk75uaby5" - }, - "description": "Custom Field name. (Not available for List Projects, Get Project Template and List Project Templates endpoints)" + "description": "The group name." }, - "key": { + "description": { "type": "string", - "description": "Custom Field friendly key." + "description": "The group description." }, - "value": { - "type": "object", - "description": "The value of the custom property. A date will be serialised as an ISO_8601 string." + "location": { + "$ref": "#/components/schemas/resource-folder-request" + }, + "users": { + "type": "array", + "description": "The group users.", + "items": { + "$ref": "#/components/schemas/user-request" + } } }, "required": [ "id" ] }, - "customer-create-request": { - "title": "Customer Create Request", - "x-stoplight": { - "id": "f8bca95391ffb" - }, + "jwk": { + "title": "JWK", "type": "object", - "description": "Input for Customer creation.\n\n It will create an invitation for an account user account.", + "description": "A Json Web Key. \n
\nSee https://datatracker.ietf.org/doc/html/rfc7517 for details.", "properties": { - "name": { + "kty": { "type": "string", - "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "maxLength": 50 + "description": "The cryptographic algorithm\n family used with the key." }, - "location": { + "n": { "type": "string", - "description": "The identifier of the parent folder for the customer." + "description": "The RSA public modulus n." }, - "firstName": { + "e": { "type": "string", - "description": "Key contact first name. If you provide this field, pleaase also provide email and last name" + "description": "The RSA public exponent e." }, - "lastName": { + "alg": { "type": "string", - "description": "Key contact last name. If you provide this field, pleaase also provide email and first name" + "description": "The algorithm intended for use with the key." }, - "email": { + "kid": { "type": "string", - "description": "Key contact email.. If you provide this field, pleaase also provide first name and last name" + "description": "The \"kid\" (key ID) parameter is used to match a specific key." + }, + "use": { + "type": "string", + "description": "The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data." } - }, - "required": [ - "name" - ] + } }, - "customer-update-request": { - "title": "Customer Update Request", - "x-stoplight": { - "id": "03m0q1ecjc9q0" - }, + "language": { + "title": "Language", "type": "object", - "description": "Input for Customer update.\n\n", + "description": "The language object.", "properties": { - "name": { + "languageCode": { "type": "string", - "description": "The name of the customer.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "maxLength": 50 + "description": "Language code. ex: \"en-US\", \"de-DE\"." }, - "keyContactId": { + "englishName": { "type": "string", - "description": "The ID of the account user set as key contact." + "description": "
default
Human readable name.
", + "x-default-field": true }, - "ragStatus": { - "type": "string", - "description": "The color tag used to mark-up a customer in the UI.", - "enum": [ - "green", - "amber", - "red" - ] + "direction": { + "type": "string" }, - "customFieldDefinitions": { - "description": "The Custom Fields", - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-field-resource", - "x-stoplight": { - "id": "jwte0fv6wp2z7" - } - } + "parentLanguageCode": { + "type": "string" }, - "folderVisibility": { - "type": "string", - "description": "The folder visibility to its subfolders.", - "enum": [ - "default", - "private" - ] + "defaultSpecificLanguageCode": { + "type": "string" + }, + "isNeutral": { + "type": "boolean", + "nullable": true } - } + }, + "required": [ + "languageCode" + ] }, - "custom-field-resource": { - "title": "Custom Field Resource", + "language-cost-request": { + "title": "Language Cost Request", + "x-stoplight": { + "id": "jnli6j6ma7ofy" + }, "type": "object", - "description": "A Custom Field resource model.", "required": [ - "key", - "value" + "name", + "type" ], "properties": { - "key": { + "name": { "type": "string", - "description": "Custom Field friendly key." + "description": "The name of the additional cost. " }, - "value": { - "type": "object", - "description": "The value of the custom property. A date will be serialized as an ISO_8601 string." - } - } - }, - "custom-field-definition": { - "title": "Custom Field Definition", - "type": "object", - "description": "The Custom Field definition.", - "properties": { - "id": { - "type": "string", - "description": "The identifier of the Custom Field Definition, generated by the service." + "type": { + "$ref": "#/components/schemas/language-cost-type", + "description": "The type of the cost." }, - "name": { - "type": "string", - "description": "
default
The display name of the Custom Field.
", - "x-default-field": true + "index": { + "type": "number", + "description": "The number of the cost." }, - "key": { - "type": "string", - "description": "The key of the Custom Field, used for querying purposes." + "costPerUnit": { + "type": "number", + "description": "The cost of a unit." }, - "description": { - "type": "string", - "description": "The description of the Custom Field." + "unitCount": { + "type": "number", + "description": "The number of units for which a cost is applied." }, - "type": { - "type": "string", - "description": "The value type supported by this Custom Field.", - "enum": [ - "long", - "double", - "boolean", - "date", - "string", - "checkbox", - "longtext", - "picklist", - "multiSelectPicklist" - ], - "nullable": true + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as reference for the unit cost." }, - "pickListOptions": { - "type": "array", - "description": "Possible values if the type selected is \"picklist\" or \"multiSelectPicklist\".", - "uniqueItems": true, - "items": { - "type": "string" - } + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Only for the Conditional type." }, - "resourceType": { - "type": "string", - "description": "The resource type to which this Custom Field can be applied.", - "enum": [ - "project", - "customer" - ] + "conditionalCostOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "Only for the Conditional type." }, - "isReadOnly": { - "type": "boolean", - "nullable": true + "conditionalCostVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "Only for the Conditional type." + }, + "operand": { + "type": "number", + "description": "Operand of the Conditional type cost." + }, + "serviceTypes": { + "type": "array", + "x-stoplight": { + "id": "pm59yzs7tif7v" + }, + "description": "Array of Service Type identifiers where this cost is applied.", + "items": { + "x-stoplight": { + "id": "24m354vpsw2oa" + }, + "type": "string" + } }, - "defaultValue": { + "customUnitName": { "type": "string", - "description": "Specifies a default value for this Custom Field. This is required if the \"isReadOnly\" field is True." - }, - "isMandatory": { - "type": "boolean", - "description": "Specifies if this Custom Field is mandatory when creating a resource of the supported type.", - "nullable": true - }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "x-stoplight": { + "id": "5khq8y9o6v7pg" + }, + "maxLength": 100, + "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`." } + } + }, + "language-cost-type": { + "title": "Language Cost Type", + "x-stoplight": { + "id": "95486073d14e0" }, - "required": [ - "id" + "enum": [ + "volume", + "hourly", + "percentage", + "perPage", + "conditional", + "adhoc", + "adhocVolume" ] }, - "custom-field-request": { - "title": "Custom Field Request", + "language-direction": { + "title": "Language Direction", "type": "object", - "description": "A Custom Field model used at project creation or project update.", + "description": "A Language Direction.", "properties": { - "key": { + "id": { "type": "string", - "description": "Custom Field friendly key." + "description": "The language direction identifier." }, - "value": { - "type": "object", - "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " + "sourceLanguage": { + "$ref": "#/components/schemas/language" + }, + "targetLanguage": { + "$ref": "#/components/schemas/language" + }, + "analysisStatistics": { + "$ref": "#/components/schemas/analysis-statistics" } }, "required": [ - "key" + "id", + "sourceLanguage", + "targetLanguage" ] }, - "custom-field-update-request": { - "title": "Custom Field Update Request", + "language-direction-cost-request": { + "title": "Language Direction Cost Request", "x-stoplight": { - "id": "69hm58ubq50j6" + "id": "e9lv9sdx92twt" }, "type": "object", - "description": "", - "properties": { - "value": { - "type": "object", - "description": "The value of the custom field. A date will be serialized as a ISO_8601 string. For read only custom fields (`isReadOnly`), it must be set exactly as the `defaultValue` from custom field definition. " - } - }, "required": [ - "value" - ] - }, - "date-time": { - "type": "string", - "title": "DateTime", - "example": "2022-01-12T12:00:00.000Z", - "description": "UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time", - "nullable": true - }, - "error-response": { - "title": "Error Response", - "type": "object", - "description": "Error response properties.", + "sourceLanguage", + "targetLanguage" + ], "properties": { - "message": { + "sourceLanguage": { "type": "string", - "description": "Retrieves a descriptive message that shows what went wrong." + "description": "The source language code. For example: \"en-US\", \"de-DE\"." }, - "errorCode": { + "targetLanguage": { "type": "string", - "description": "Concise code that describes the nature of the error." + "description": "The target language code. For example: \"en-US\", \"de-DE\"." }, - "details": { + "contextMatch": { + "type": "number", + "description": "The price of context matches.", + "x-default-field": true + }, + "exactMatch": { + "type": "number", + "description": "The price of exact matches.", + "x-default-field": true + }, + "new": { + "description": "The price of new matches.", + "type": "number", + "x-default-field": true + }, + "perfectMatch": { + "type": "number", + "description": "The price of PerfectMatches.", + "x-default-field": true + }, + "repetition": { + "type": "number", + "description": "The price of repetition matches.", + "x-default-field": true + }, + "machineTranslation": { + "type": "number", + "description": "The price of machine translation matches.", + "x-default-field": true + }, + "pricingUnit": { + "$ref": "#/components/schemas/pricing-unit-type", + "x-default-field": true, + "description": "The type of the pricing unit. If not specified, `words` will be used as the default value." + }, + "fuzzyMatches": { "type": "array", + "x-default-field": true, + "description": "All fuzzyMatches categories should be the same for all the language directions.", "items": { - "$ref": "#/components/schemas/error-detail-response" + "$ref": "#/components/schemas/fuzzy-match", + "x-stoplight": { + "id": "0m8m8t4mg06hy" + } + } + }, + "additionalCosts": { + "x-default-field": true, + "description": "Additional costs applied at language level.", + "type": "array", + "items": { + "$ref": "#/components/schemas/language-cost-request", + "x-stoplight": { + "id": "p0j2ohoyogy3q" + } } } - }, - "required": [ - "message", - "errorCode" - ] + } }, - "error-detail-response": { - "title": "Error Detail Response", + "language-direction-no-statistics": { + "title": "Language Direction", + "x-stoplight": { + "id": "o2ahlu8d180l0" + }, "type": "object", - "description": "Error detail response properties.", + "description": "A Language Direction.", "properties": { - "name": { + "id": { "type": "string", - "description": "" + "description": "The language direction identifier." }, - "code": { - "type": "string", - "description": "" + "sourceLanguage": { + "$ref": "#/components/schemas/language" }, - "value": { - "type": "string" + "targetLanguage": { + "$ref": "#/components/schemas/language" } - } + }, + "required": [ + "id", + "sourceLanguage", + "targetLanguage" + ] }, - "export-quote-report-response": { - "title": "Export Quote Report Response", + "language-direction-item": { + "title": "Language Direction Item", "type": "object", - "description": "Export quote report response.", + "description": "", "properties": { "id": { "type": "string", - "description": "The export quote report identifier." + "description": "The language direction identifier." } - } + }, + "required": [ + "id" + ] }, - "failed-task": { - "title": "Failed Task", + "language-direction-cost": { + "title": "Language Direction Cost", + "x-stoplight": { + "id": "a0c8ffb7ad3c9" + }, "type": "object", - "description": "Failed Task.", + "required": [ + "sourceLanguage", + "targetLanguage" + ], "properties": { - "id": { + "sourceLanguage": { "type": "string", - "description": "The failed task identifier." + "description": "The source language code. For example: \"en-US\", \"de-DE\"." }, - "name": { + "targetLanguage": { "type": "string", - "description": "The failed task name." + "description": "The target language code. For example: \"en-US\", \"de-DE\"." }, - "errors": { + "contextMatch": { + "type": "number", + "description": "
default
The price of context matches.", + "x-default-field": true + }, + "exactMatch": { + "type": "number", + "description": "
default
The price of exact matches.", + "x-default-field": true + }, + "new": { + "description": "
default
The price of new matches.", + "type": "number", + "x-default-field": true + }, + "perfectMatch": { + "type": "number", + "description": "
default
The price of PerfectMatches.", + "x-default-field": true + }, + "repetition": { + "type": "number", + "description": "
default
The price of repetition matches.", + "x-default-field": true + }, + "machineTranslation": { + "type": "number", + "description": "
default
The price of machine translation matches.", + "x-default-field": true + }, + "pricingUnit": { + "$ref": "#/components/schemas/pricing-unit-type", + "description": "
default
", + "x-default-field": true, + "nullable": true + }, + "fuzzyMatches": { "type": "array", - "description": "The failed task errors.", + "description": "
default
", + "x-default-field": true, "items": { - "$ref": "#/components/schemas/task-error" + "$ref": "#/components/schemas/fuzzy-match", + "x-stoplight": { + "id": "i06cxve7hjibt" + } + } + }, + "additionalCosts": { + "type": "array", + "description": "
default
", + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/language-cost", + "x-stoplight": { + "id": "eskiho7o9q38f" + } } } + } + }, + "language-direction-request": { + "title": "Language Direction Request", + "type": "object", + "description": "The language directions model used for creating or updating a project.", + "properties": { + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request" + }, + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" + } }, "required": [ - "id", - "name" + "sourceLanguage", + "targetLanguage" ] }, - "file-processing-configuration": { - "title": "File Processing Configuration", + "language-processing-rule": { + "title": "Language Processing Rule", "type": "object", - "description": "File Processing Configuration resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", - "description": "The file processing configuration identifier." + "description": "The language processing rule identifier." }, "name": { "type": "string", - "description": "
default
The file processing configuration name.
", + "description": "
default
The language processing rule name.
", "x-default-field": true }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "description": { + "type": "string", + "description": "The language processing rule description." } }, "required": [ "id" ] }, - "file-type-setting": { - "title": "File Type Setting", - "x-stoplight": { - "id": "twyoqd5uer5g0" - }, + "language-request": { + "title": "Language Request", "type": "object", "properties": { - "id": { - "type": "string", - "description": "The file type setting identifier." - }, - "name": { - "type": "string", - "description": "
default
The file type name.
", - "x-default-field": true - }, - "description": { + "languageCode": { "type": "string" - }, - "typeId": { - "type": "string", - "description": "A short string representation of the file type identifier. The ID displayed in the Trados Cloud Platform UI." - }, - "enabled": { - "type": "boolean", - "description": "
default
Is this file type setting enabled. Disabled file types will not be included in operations (ex. Scan)
", - "nullable": true, - "x-default-field": true - }, - "excluded": { - "type": "boolean", - "description": "Is this file type setting included in the file processing configuration. \n\nFile types will be added to a configuration as excluded = true by default and can be included by a consumer when needed (via the Trados Cloud Platform UI)\n\nExcluded file types will not be included in operations (ex. Scan)", - "nullable": true - }, - "deprecated": { - "type": "boolean", - "description": "This file type setting is planned for deprecation and will be removed in the future.", - "nullable": true - }, - "orderNumber": { - "type": "integer", - "description": "The order of the setting in the file type configuration." - }, - "extensions": { - "type": "array", - "description": "A collection of extensions supported by this file type. Ex: \"*.xlsx\"", - "items": { - "type": "string" - } } }, "required": [ - "id" - ], - "description": "" + "languageCode" + ] }, - "file-upload-response": { - "title": "File Upload Response", + "language-pair": { + "title": "Language Pair", + "x-stoplight": { + "id": "61t8792ya7zez" + }, "type": "object", "properties": { - "id": { - "type": "string", - "description": "The identifier of the uploaded file" - }, - "fileName": { + "source": { "type": "string", - "description": "The name of the uploaded file" + "x-stoplight": { + "id": "0xwwyeclt9qb9" + }, + "description": "Language code. ex: \"en-US\", de-DE\"." }, - "unzipStatus": { + "target": { "type": "string", - "enum": [ - "queued", - "extracting", - "extracted", - "unzipError" - ], - "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." + "x-stoplight": { + "id": "0ndrvic0areb1" + }, + "description": "Language code. ex: \"en-US\", de-DE\"." } }, "required": [ - "id", - "fileName" - ] + "source", + "target" + ], + "description": "" }, - "file-metadata-response": { - "title": "File Metadata Response", + "language-pair-resource": { + "title": "Language Pair Resource", + "x-stoplight": { + "id": "62g4076dmqp0x" + }, "type": "object", + "description": "Resource describing a Translation Memory, Termbase or Machine Translation used in a Translation Engine.", + "required": [ + "id", + "type" + ], "properties": { "id": { "type": "string", - "description": "The identifier of the uploaded file" + "x-stoplight": { + "id": "0xwwyeclt9qb9" + }, + "description": "The identifier of the Translation Memory, Termbase, Machine Translation or LLM." }, - "fileName": { + "systemId": { "type": "string", - "description": "The name of the uploaded file" + "x-stoplight": { + "id": "xvf797250xe34" + }, + "description": "Required only for neural Machine Translation resources." }, - "unzipStatus": { + "type": { "type": "string", + "x-stoplight": { + "id": "1smtmeliso6fm" + }, + "description": "The resource type. ", "enum": [ - "queued", - "extracting", - "extracted", - "unzipError" - ], - "description": "The status of the unzipping operation. You can use this to determine if your .zip file has been extracted successfully." + "TM", + "MT", + "TB", + "LLM" + ] }, - "associatedFiles": { - "type": "array", - "description": "The files that were extracted from the uploaded .zip archive.", - "items": { - "$ref": "#/components/schemas/file-extracted-response" - } + "penalty": { + "type": "integer", + "x-stoplight": { + "id": "465u0rm7i1n97" + }, + "description": "Only for TM" + }, + "lookup": { + "type": "boolean", + "x-stoplight": { + "id": "bnsbqsinf3azu" + }, + "description": "Only for TM, TB" + }, + "concordance": { + "type": "boolean", + "x-stoplight": { + "id": "6h3n7qz9llokc" + }, + "description": "Only for TM" + }, + "update": { + "type": "boolean", + "x-stoplight": { + "id": "euo2zyycwz99m" + }, + "description": "Only for TM, TB" + }, + "generativeTranslation": { + "type": "boolean", + "x-stoplight": { + "id": "inxa0qoemlw46" + }, + "description": "Only for LLM" + }, + "smartReview": { + "type": "boolean", + "x-stoplight": { + "id": "s7x3mcw5kgyr4" + }, + "description": "Only for LLM" } - }, - "required": [ - "id", - "fileName" - ] + } }, - "file-extracted-response": { - "title": "File Extracted Response", + "list-customers-response": { + "title": "List Customers Response", "type": "object", "properties": { - "id": { - "type": "string", - "description": "The identifier of the extracted file." - }, - "fileName": { - "type": "string", - "description": "The name of the extracted file." + "itemCount": { + "type": "integer" }, - "filePath": { - "type": "string", - "description": "The file path of the extracted file. This is relative to the archive root." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/customer" + } } }, "required": [ - "id", - "fileName", - "filePath" - ] - }, - "file-role": { - "type": "string", - "title": "File-Role", - "enum": [ - "translatable", - "reference", - "localizable", - "unknown" + "itemCount", + "items" ], - "nullable": true + "description": "A response for the List Customers endpoint." }, - "file-version-export": { - "title": "File Version Export", - "description": "File Version Export. The resulted version can be downloaded once the status is completed.", - "allOf": [ - { - "$ref": "#/components/schemas/asynchronous-result" + "list-custom-field-definitions-response": { + "title": "List Custom Field Definitions Response", + "type": "object", + "description": "A response for the List Custom Field Definitions endpoint.", + "properties": { + "itemCount": { + "type": "integer" }, - { - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "description": "The url where the file can be downloaded." - } + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-definition" } } + }, + "required": [ + "itemCount", + "items" ] }, - "file-version-import": { - "title": "File Version Import", - "allOf": [ - { - "$ref": "#/components/schemas/asynchronous-result" + "list-file-processing-configurations-response": { + "title": "List File Processing Configurations Response", + "type": "object", + "properties": { + "itemCount": { + "type": "integer" }, - { - "type": "object", - "properties": { - "fileVersionId": { - "type": "string" - } + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/file-processing-configuration" } } - ] + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List File Processing Configurations endpoint." }, - "folder": { - "title": "Folder", + "list-file-type-settings-response": { + "title": "List File Type Settings Response", "type": "object", - "description": "Folder used for resource storage.", - "examples": [ - { - "id": "1de8f71c357c4bb5a32626faf5f53ef1", - "name": "consumer_A", - "path": [ - { - "id": "7fb808326daa4bb1988ckedcd0734aa6", - "location": "0e6d1f1aa8df46e6b9b111ca9f388c9e", - "name": "dexters_extensibility_consumer", - "hasParent": true - }, - { - "id": "0e6d1f1aa8df46e6b9b111ca9f388c9e", - "location": "61e801fa3d600fe2cfs12dd08", - "name": "Customers", - "hasParent": true - }, - { - "id": "61e801fa3d600fe2cfs12dd08", - "name": "61e801fa3d600fe2cfs12dd08", - "hasParent": false - } - ] - } - ], + "description": "A response for the List File Type Settings endpoint.", "required": [ - "id" + "itemCount", + "items" ], "properties": { - "id": { - "type": "string", - "description": "The folder identifier." - }, - "name": { - "type": "string", - "description": "
default
The name of the folder.
", - "x-default-field": true - }, - "hasParent": { - "type": "boolean", - "description": "Indicates if the folder has a parent folder.", - "nullable": true + "itemCount": { + "type": "integer" }, - "path": { + "items": { "type": "array", - "x-stoplight": { - "id": "31bd3get7o6hk" - }, - "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", "items": { - "$ref": "#/components/schemas/folder-path", - "x-stoplight": { - "id": "i4c2vlnydf80m" - } + "$ref": "#/components/schemas/file-type-setting" } } } }, - "folder-v2": { - "title": "Folder", + "list-folders-response": { + "title": "List Folders Response", "type": "object", - "description": "Folder used for resource storage.", + "description": "A response for the List Folders endpoint.", "properties": { - "id": { - "type": "string", - "description": "The folder identifier." - }, - "name": { - "type": "string", - "description": "
default
The name of the folder.
", - "x-default-field": true - }, - "hasParent": { - "type": "boolean", - "description": "Indicates if the folder has a parent folder.", - "nullable": true + "itemCount": { + "type": "integer" }, - "path": { + "items": { "type": "array", - "description": "The hierarchical path. It consists of all the items of the path in reverse order, the parent of the current folder being the first in the list, and the root of the account being the last.", "items": { - "$ref": "#/components/schemas/folder-path" + "$ref": "#/components/schemas/folder" } } }, "required": [ - "id" + "itemCount", + "items" ] }, - "folder-path": { - "title": "Folder Path", + "list-groups-response": { + "title": "List Groups Response", "type": "object", - "description": "Path of a folder.", "properties": { - "id": { - "type": "string", - "description": "The folder identifier." + "itemCount": { + "type": "integer" }, - "name": { - "type": "string", - "description": "The name of the folder." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/group" + } + } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List Groups endpoint." + }, + "list-jwks": { + "title": "List JWKs Response", + "type": "array", + "items": { + "$ref": "#/components/schemas/jwk" + } + }, + "list-languages-response": { + "title": "List Languages Response", + "type": "object", + "properties": { + "itemCount": { + "type": "integer" }, - "location": { - "type": "string", - "description": "
default
The location identifier." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language" + } + } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List Languages endpoint." + }, + "list-language-processing-rules": { + "title": "List Language Processing Rules", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-processing-rule" + } }, - "hasParent": { - "type": "boolean", - "description": "
default
Indicates if the folder has a parent folder.", - "nullable": true + "itemCount": { + "type": "string" } }, "required": [ - "id", - "name" + "items", + "itemCount" ] }, - "fuzzy-category": { - "title": "Fuzzy Category", + "list-machine-translations-response": { + "title": "List Machine Translations Response", + "x-stoplight": { + "id": "fhk9xi0bpvf3x" + }, "type": "object", - "description": "Fuzzy category range. Example of Fuzzy bands: 100-100%, 95-99%, 85-94%, 75-84%, 50-74%.", + "description": "A response for the List Machine Translations endpoint.", "properties": { - "minimum": { - "type": "integer", - "description": "
default
The minimum of the range.
", - "nullable": true, - "x-default-field": true + "itemCount": { + "type": "integer" }, - "maximum": { - "type": "integer", - "description": "
default
The maximum of the range.
", - "nullable": true, - "x-default-field": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/machine-translation" + } } - } + }, + "required": [ + "itemCount", + "items" + ] }, - "fuzzy-count": { - "title": "Fuzzy Count", + "list-my-accounts-response": { + "title": "List My Accounts Response", "type": "object", - "description": "Statistics count for fuzzy matches.", "properties": { - "count": { - "$ref": "#/components/schemas/count", - "description": "
default
Statistics count.
", - "x-default-field": true + "itemCount": { + "type": "integer" }, - "category": { - "$ref": "#/components/schemas/fuzzy-category", - "description": "
default
Fuzzy category range.
", - "x-default-field": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/account" + } } - } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List My Accounts endpoint." }, - "fuzzy-match-category": { - "title": "Fuzzy Match Category", + "list-pricing-models-response": { + "title": "List Pricing Models Response", "type": "object", - "description": "Fuzzy match category range.", "properties": { - "minimumMatchValue": { - "type": "integer", - "nullable": true, - "description": "Minimum matching value of this range." + "itemCount": { + "type": "integer" }, - "maximumMatchValue": { - "type": "integer", - "nullable": true, - "description": "Maximum matching value of this range." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/pricing-model" + } } }, "required": [ - "minimumMatchValue", - "maximumMatchValue" - ] + "itemCount", + "items" + ], + "description": "A response for the List Pricing Models endpoint." }, - "fuzzy-match": { - "title": "Fuzzy Match", + "list-project-templates-response": { + "title": "List Project Templates Response", "type": "object", - "description": "Fuzzy match model.", "properties": { - "price": { - "type": "number", - "description": "Fuzzy match price for the range expressed in the category field." + "itemCount": { + "type": "integer" }, - "category": { - "$ref": "#/components/schemas/fuzzy-match-category" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-template-response" + } } }, "required": [ - "price", - "category" - ] + "itemCount", + "items" + ], + "description": "A response for the List Project Templates endpoint." }, - "group": { - "title": "Group", + "list-schedule-templates-response": { + "title": "List Schedule Templates Response", + "x-stoplight": { + "id": "1rzz3ctuczv9f" + }, "type": "object", - "description": "Group of Users.", + "description": "A response for the List Schedule Templates endpoint.", "properties": { - "id": { - "type": "string", - "description": "The group identifier." - }, - "name": { - "type": "string", - "description": "
default
The group name.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "The group description." - }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "itemCount": { + "type": "integer" }, - "users": { + "items": { "type": "array", "items": { - "$ref": "#/components/schemas/user" + "$ref": "#/components/schemas/schedule-template" } } }, "required": [ - "id" + "itemCount", + "items" ] }, - "group-request": { - "title": "Group Request", + "list-rate-limits-response": { + "title": "List Rate Limits Response", "type": "object", - "description": "Group of users.", "properties": { - "id": { - "type": "string", - "description": "The group identifier." - }, - "name": { - "type": "string", - "description": "The group name." - }, - "description": { - "type": "string", - "description": "The group description." - }, - "location": { - "$ref": "#/components/schemas/resource-folder-request" + "itemCount": { + "type": "integer" }, - "users": { + "items": { "type": "array", - "description": "The group users.", "items": { - "$ref": "#/components/schemas/user-request" + "$ref": "#/components/schemas/rate-limit" } } }, "required": [ - "id" - ] + "itemCount", + "items" + ], + "description": "A response for the List Rate Limits endpoint." }, - "jwk": { - "title": "JWK", + "list-perfect-match-candidates-response": { + "title": "List PerfectMatch Candidates Response", + "x-stoplight": { + "id": "i66skbktv8vko" + }, "type": "object", - "description": "A Json Web Key. \n
\nSee https://datatracker.ietf.org/doc/html/rfc7517 for details.", + "description": "A response for the Get PerfectMatch Candidates endpoint.", + "required": [ + "itemCount", + "items" + ], "properties": { - "kty": { - "type": "string", - "description": "The cryptographic algorithm\n family used with the key." - }, - "n": { - "type": "string", - "description": "The RSA public modulus n." - }, - "e": { - "type": "string", - "description": "The RSA public exponent e." - }, - "alg": { - "type": "string", - "description": "The algorithm intended for use with the key." - }, - "kid": { - "type": "string", - "description": "The \"kid\" (key ID) parameter is used to match a specific key." + "itemCount": { + "type": "integer" }, - "use": { - "type": "string", - "description": "The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/perfect-match-candidate" + } } } }, - "language": { - "title": "Language", + "list-project-groups-response": { + "title": "List Project Groups Response", "type": "object", - "description": "The language object.", + "description": "A response for the List Project Groups endpoint.", "properties": { - "languageCode": { - "type": "string", - "description": "Language code. ex: \"en-US\", \"de-DE\"." - }, - "englishName": { - "type": "string", - "description": "
default
Human readable name.
", - "x-default-field": true - }, - "direction": { - "type": "string" - }, - "parentLanguageCode": { - "type": "string" - }, - "defaultSpecificLanguageCode": { - "type": "string" + "itemCount": { + "type": "integer" }, - "isNeutral": { - "type": "boolean", - "nullable": true + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-group" + } } }, "required": [ - "languageCode" + "itemCount", + "items" ] }, - "language-direction": { - "title": "Language Direction", + "list-projects-response": { + "title": "List Projects Response", "type": "object", - "description": "A Language Direction.", "properties": { - "id": { - "type": "string", - "description": "The language direction identifier." - }, - "sourceLanguage": { - "$ref": "#/components/schemas/language" - }, - "targetLanguage": { - "$ref": "#/components/schemas/language" + "itemCount": { + "type": "integer" }, - "analysisStatistics": { - "$ref": "#/components/schemas/analysis-statistics" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project" + } } }, "required": [ - "id", - "sourceLanguage", - "targetLanguage" - ] + "itemCount", + "items" + ], + "description": "A response for the List Projects endpoint." }, - "language-direction-no-statistics": { - "title": "Language Direction", - "x-stoplight": { - "id": "o2ahlu8d180l0" - }, + "list-source-files-response": { + "title": "List Source Files Response", "type": "object", - "description": "A Language Direction.", "properties": { - "id": { - "type": "string", - "description": "The language direction identifier." - }, - "sourceLanguage": { - "$ref": "#/components/schemas/language" + "itemCount": { + "type": "integer" }, - "targetLanguage": { - "$ref": "#/components/schemas/language" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/source-file" + } } }, "required": [ - "id", - "sourceLanguage", - "targetLanguage" - ] + "itemCount", + "items" + ], + "description": "A response for the List Source Files endpoint." }, - "language-direction-item": { - "title": "Language Direction Item", + "list-source-file-versions-response": { + "title": "List Source File Versions Response", "type": "object", - "description": "", "properties": { - "id": { - "type": "string", - "description": "The language direction identifier." + "itemCount": { + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/source-file-version" + } } }, "required": [ - "id" - ] + "itemCount", + "items" + ], + "description": "A response for the List Source File Versions endpoint." }, - "language-price": { - "title": "Language Prices", - "x-stoplight": { - "id": "a0c8ffb7ad3c9" - }, + "list-target-files-response": { + "title": "List Target Files Response", "type": "object", "properties": { - "sourceLanguage": { - "type": "string", - "description": "The source language code. For example: \"en-US\", \"de-DE\"." - }, - "targetLanguage": { - "type": "string", - "description": "The target language code. For example: \"en-US\", \"de-DE\"." - }, - "contextMatch": { - "type": "number", - "description": "
default
The price of context matches.", - "x-default-field": true - }, - "exactMatch": { - "type": "number", - "description": "
default
The price of exact matches.", - "x-default-field": true - }, - "new": { - "description": "
default
The price of new matches.", - "type": "number", - "x-default-field": true - }, - "perfectMatch": { - "type": "number", - "description": "
default
The price of PerfectMatches.", - "x-default-field": true - }, - "repetition": { - "type": "number", - "description": "
default
The price of repetition matches.", - "x-default-field": true - }, - "machineTranslation": { - "type": "number", - "description": "
default
The price of machine translation matches.", - "x-default-field": true - }, - "pricingUnit": { - "x-stoplight": { - "id": "tg3y5wcaunacs" - }, - "description": "
default
", - "x-default-field": true, - "enum": [ - "words", - "characters" - ] + "itemCount": { + "type": "integer" }, - "fuzzyMatches": { + "items": { "type": "array", - "description": "
default
", - "x-default-field": true, "items": { - "$ref": "#/components/schemas/fuzzy-match", - "x-stoplight": { - "id": "0m8m8t4mg06hy" - } + "$ref": "#/components/schemas/target-file" } + } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List Target Files endpoint." + }, + "list-target-file-versions-response": { + "title": "List Target File Versions Response", + "type": "object", + "description": "A response for the List Target Files Versions endpoint.", + "properties": { + "itemCount": { + "type": "integer" }, - "additionalCosts": { + "items": { "type": "array", - "description": "
default
", - "x-default-field": true, "items": { - "$ref": "#/components/schemas/additional-cost-language", - "x-stoplight": { - "id": "eskiho7o9q38f" - } + "$ref": "#/components/schemas/target-file-version" } } }, "required": [ - "sourceLanguage", - "targetLanguage" + "itemCount", + "items" ] }, - "language-direction-request": { - "title": "Language Direction Request", + "list-tasks-response": { + "title": "List Tasks Response", "type": "object", - "description": "The language directions model used for creating or updating a project.", "properties": { - "sourceLanguage": { - "$ref": "#/components/schemas/source-language-request" + "itemCount": { + "type": "integer" }, - "targetLanguage": { - "$ref": "#/components/schemas/target-language-request" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task" + } } }, "required": [ - "sourceLanguage", - "targetLanguage" - ] + "itemCount", + "items" + ], + "description": "A response for the List Tasks endpoint." }, - "language-processing-rule": { - "title": "Language Processing Rule", + "list-task-types-response": { + "title": "List Task Types Response", "type": "object", "properties": { - "id": { - "type": "string", - "description": "The language processing rule identifier." - }, - "name": { - "type": "string", - "description": "
default
The language processing rule name.
", - "x-default-field": true + "itemCount": { + "type": "integer" }, - "description": { - "type": "string", - "description": "The language processing rule description." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-type" + } } }, "required": [ - "id" - ] + "itemCount", + "items" + ], + "description": "A response for the List Task types endpoint." }, - "language-request": { - "title": "Language Request", + "list-tqa-profiles-response": { + "title": "List TQA Profiles Response", "type": "object", + "description": "", "properties": { - "languageCode": { - "type": "string" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/tqa-profile" + } + }, + "itemCount": { + "type": "integer" } }, "required": [ - "languageCode" + "items", + "itemCount" ] }, - "language-pair": { - "title": "Language Pair", - "x-stoplight": { - "id": "61t8792ya7zez" - }, + "list-termbase-templates-response": { + "title": "List Termbase Templates Response", "type": "object", + "description": "The termbase templates response.", "properties": { - "source": { - "type": "string", - "x-stoplight": { - "id": "0xwwyeclt9qb9" - }, - "description": "Language code. ex: \"en-US\", de-DE\"." + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-template" + } }, - "target": { - "type": "string", - "x-stoplight": { - "id": "0ndrvic0areb1" - }, - "description": "Language code. ex: \"en-US\", de-DE\"." + "itemCount": { + "type": "integer" } }, "required": [ - "source", - "target" - ], - "description": "" + "items", + "itemCount" + ] }, - "language-pair-resource": { - "title": "Language Pair Resource", - "x-stoplight": { - "id": "62g4076dmqp0x" - }, + "list-termbases-response": { + "title": "List Termbases Response", "type": "object", - "description": "Resource describing a Translation Memory, Termbase or Machine Translation used in a Translation Engine.", + "description": "The list termbases response.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the Translation Memory, the Termbase or the Machine Translation." - }, - "type": { - "type": "string", - "x-stoplight": { - "id": "1smtmeliso6fm" - }, - "description": "The resource type. ", - "enum": [ - "TM", - "MT", - "TB" - ] - }, - "penalty": { - "type": "integer", - "x-stoplight": { - "id": "465u0rm7i1n97" - } - }, - "lookup": { - "type": "boolean", - "x-stoplight": { - "id": "bnsbqsinf3azu" + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase" } }, - "concordance": { - "type": "boolean", - "x-stoplight": { - "id": "6h3n7qz9llokc" + "itemCount": { + "type": "integer" + } + }, + "required": [ + "items", + "itemCount" + ] + }, + "list-termbase-terms-response": { + "title": "List Termbase Terms Response", + "type": "object", + "description": "The list termbase terms response.", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-term" } }, - "update": { - "type": "boolean", - "x-stoplight": { - "id": "euo2zyycwz99m" + "itemCount": { + "type": "integer" + } + }, + "required": [ + "items", + "itemCount" + ] + }, + "list-termbase-entries-response": { + "title": "List Termbase Entries Response", + "type": "object", + "description": "The list termbase entries response.", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry" } }, - "systemId": { - "type": "string", - "x-stoplight": { - "id": "xvf797250xe34" - }, - "description": "Required only for neural Machine Translation resources." + "itemCount": { + "type": "integer" } }, "required": [ - "id", - "type" + "items", + "itemCount" ] }, - "list-customers-response": { - "title": "List Customers Response", + "list-termbase-import-history": { + "title": "Get Termbase Import History", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-import-history-response" + } + }, + "itemCount": { + "type": "integer" + } + } + }, + "list-translation-engines-response": { + "title": "List Translation Engines Response", "type": "object", "properties": { "itemCount": { @@ -18990,7 +21483,7 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/customer" + "$ref": "#/components/schemas/translation-engine" } } }, @@ -18998,12 +21491,11 @@ "itemCount", "items" ], - "description": "A response for the List Customers endpoint." + "description": "A response for the List Translation Engines endpoint." }, - "list-custom-field-definitions-response": { - "title": "List Custom Field Definitions Response", + "list-translation-memories-reposne": { + "title": "List Translation Memories Response", "type": "object", - "description": "A response for the List Custom Field Definitions endpoint.", "properties": { "itemCount": { "type": "integer" @@ -19011,18 +21503,38 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/custom-field-definition" + "$ref": "#/components/schemas/translation-memory" } } }, "required": [ "itemCount", "items" - ] + ], + "description": "A response for the List Translation Memories endpoint." }, - "list-file-processing-configurations-response": { - "title": "List File Processing Configurations Response", + "list-translation-memory-import-history": { + "title": "Get Translation Memory Import History", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-memory-import-history-response" + } + }, + "itemCount": { + "type": "integer" + } + } + }, + "list-translation-memory-field-templates": { + "title": "List Translation Memory Field Templates", + "x-stoplight": { + "id": "icrpz2hliblzj" + }, "type": "object", + "description": "A response for the List Translation Memory Field Templates endpoint.", "properties": { "itemCount": { "type": "integer" @@ -19030,40 +21542,50 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/file-processing-configuration" + "$ref": "#/components/schemas/translation-memory-field-template" } } }, "required": [ "itemCount", "items" - ], - "description": "A response for the List File Processing Configurations endpoint." + ] }, - "list-file-type-settings-response": { - "title": "List File Type Settings Response", + "list-translation-service-types-response": { + "title": "List Translation Service Types Response", + "x-stoplight": { + "id": "hfotzd0fq5zx2" + }, "type": "object", - "description": "A response for the List File Type Settings endpoint.", + "description": "A response for the List Translation Service Types endpoint.", "required": [ "itemCount", "items" ], "properties": { "itemCount": { - "type": "integer" + "type": "integer", + "x-stoplight": { + "id": "izsgcvo2ilhmt" + } }, "items": { "type": "array", + "x-stoplight": { + "id": "dvdp579kl1cc5" + }, "items": { - "$ref": "#/components/schemas/file-type-setting" + "$ref": "#/components/schemas/translation-service-type", + "x-stoplight": { + "id": "b2c2bbjsoepdb" + } } } } }, - "list-folders-response": { - "title": "List Folders Response", + "list-users-response": { + "title": "List Users Response", "type": "object", - "description": "A response for the List Folders endpoint.", "properties": { "itemCount": { "type": "integer" @@ -19071,1588 +21593,2072 @@ "items": { "type": "array", "items": { - "$ref": "#/components/schemas/folder" + "$ref": "#/components/schemas/user" } } }, "required": [ "itemCount", "items" - ] + ], + "description": "A response for the List Users endpoint." }, - "list-groups-response": { - "title": "List Groups Response", + "list-workflows-response": { + "title": "List Workflows Response", "type": "object", "properties": { "itemCount": { "type": "integer" }, - "items": { + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow" + } + } + }, + "required": [ + "itemCount", + "items" + ], + "description": "A response for the List Workflows endpoint." + }, + "llm-configuration-response": { + "title": "LLM Configuration Response", + "x-stoplight": { + "id": "kp7sn68d75t8z" + }, + "type": "object", + "description": "The LLM configuration details", + "required": [ + "id", + "model", + "type", + "isDefault", + "isActive" + ], + "properties": { + "id": { + "type": "string", + "x-stoplight": { + "id": "53ri5rgnwgj3c" + }, + "description": "The LLM configuraiton identifier." + }, + "description": { + "type": "string", + "x-stoplight": { + "id": "l1t1rrfi16rl6" + }, + "description": "The configuration description." + }, + "model": { + "type": "string", + "x-stoplight": { + "id": "83vangex352aj" + }, + "description": "The model name." + }, + "type": { + "type": "string", + "x-stoplight": { + "id": "lsb4gvpmerg7z" + }, + "enum": [ + "azureOpenAI", + "awsBedrock" + ], + "description": "The LLM provider type." + }, + "isDefault": { + "type": "boolean", + "x-stoplight": { + "id": "8co4b9p37he2y" + }, + "description": "Flag representing whether the LLM configuration is default." + }, + "isActive": { + "type": "boolean", + "x-stoplight": { + "id": "1bw7exz7k43o4" + }, + "description": "Flag representing whether the LLM configuration is active." + } + } + }, + "list-llm-configurations-response": { + "title": "List LLM Configurations Response", + "x-stoplight": { + "id": "zax5a75zj3u5f" + }, + "type": "object", + "required": [ + "itemCount", + "items" + ], + "properties": { + "itemCount": { + "type": "integer", + "x-stoplight": { + "id": "xt0e6xcbjnlds" + }, + "description": "The total item count." + }, + "items": { + "type": "array", + "x-stoplight": { + "id": "zdj0fmsdrjuma" + }, + "items": { + "$ref": "#/components/schemas/llm-configuration-response", + "x-stoplight": { + "id": "834zntr25p2xt" + } + } + } + }, + "description": "A response for the List LLM Configurations endpoint." + }, + "machine-translation": { + "title": "Machine Translation", + "x-stoplight": { + "id": "q83tushwc71wu" + }, + "type": "object", + "description": "Machine translation resource.", + "properties": { + "id": { + "type": "string" + }, + "provider": { + "type": "string", + "description": "
Provider of the machine translation.
", + "x-default-field": true, + "x-stoplight": { + "id": "o2vxfwxx5ypjq" + } + }, + "type": { + "type": "string", + "x-stoplight": { + "id": "027ukef1wajci" + }, + "description": "Type of the machine translation. Can be generic or neural." + }, + "systemId": { + "type": "string", + "x-stoplight": { + "id": "6inesg0lkfqtn" + }, + "description": "
default
Appears if the machine translation is neural." + }, + "modelSourceLanguage": { + "x-stoplight": { + "id": "ujzglo1mwl4pl" + }, + "type": "string", + "description": "Model Source language" + }, + "modelTargetLanguage": { + "type": "string", + "x-stoplight": { + "id": "dssycbmasvpyc" + }, + "description": "Model Target language" + }, + "matchingSourceLanguage": { + "type": "string", + "x-stoplight": { + "id": "rxm5xpz6oj11t" + }, + "description": "Specific source language supported by the model, matching the query " + }, + "matchingTargetLanguages": { "type": "array", + "x-stoplight": { + "id": "ncr79i78eof3x" + }, + "description": "Specific target languages supported by the model, matching the query ", "items": { - "$ref": "#/components/schemas/group" + "x-stoplight": { + "id": "7ekyl863df2e7" + }, + "type": "string" } } }, "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Groups endpoint." - }, - "list-jwks": { - "title": "List JWKs Response", - "type": "array", - "items": { - "$ref": "#/components/schemas/jwk" - } + "id", + "provider", + "type", + "modelSourceLanguage", + "modelTargetLanguage", + "matchingSourceLanguage", + "matchingTargetLanguages" + ] }, - "list-languages-response": { - "title": "List Languages Response", + "object-id": { + "title": "Object Identifier", "type": "object", + "description": "An object with identifier.", "properties": { - "itemCount": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/language" - } + "id": { + "type": "string" } }, "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Languages endpoint." + "id" + ] }, - "list-language-processing-rules": { - "title": "List Language Processing Rules", + "object-id-request": { + "title": "Object Identifier Request", "type": "object", + "description": "An object with identifier.", "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/language-processing-rule" - } - }, - "itemCount": { + "id": { "type": "string" } }, "required": [ - "items", - "itemCount" + "id" ] }, - "list-machine-translations-response": { - "title": "List Machine Translations Response", + "perfect-match-candidate": { + "title": "PerfectMatch Candidate", "x-stoplight": { - "id": "fhk9xi0bpvf3x" + "id": "fx87e3hzcrq7z" }, "type": "object", - "description": "A response for the List Machine Translations endpoint.", + "x-internal": false, + "required": [ + "score", + "fileId" + ], "properties": { - "itemCount": { - "type": "integer" + "score": { + "type": "number", + "x-stoplight": { + "id": "fm35hes639la9" + }, + "format": "double", + "description": "The match score.", + "minimum": 0, + "maximum": 100 }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/machine-translation" - } + "fileId": { + "type": "string", + "x-stoplight": { + "id": "vs2ndi7jr87fl" + }, + "description": "The file identifier:\r\n- `targetFileId` if file is a project file\r\n- `fileId` if file is user provided" + }, + "project": { + "$ref": "#/components/schemas/project", + "x-stoplight": { + "id": "umsyu9xmi8sqp" + }, + "description": "The project from where the candidate was selected." } }, - "required": [ - "itemCount", - "items" - ] + "description": "A project file that can be used as a match for PerfectMatch" }, - "list-my-accounts-response": { - "title": "List My Accounts Response", + "perfect-match-custom-file-mapping-request": { + "title": "PerfectMatch Custom File Mapping Request", + "x-stoplight": { + "id": "c787724801aca" + }, + "description": "Provide you own matching file.", "type": "object", + "required": [ + "properties", + "file" + ], "properties": { - "itemCount": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/account" + "properties": { + "type": "object", + "x-stoplight": { + "id": "q75mghzupqq7g" + }, + "required": [ + "name", + "targetLanguage" + ], + "properties": { + "name": { + "type": "string", + "x-stoplight": { + "id": "df0d1cic1j71s" + }, + "description": "The file name." + }, + "targetLanguage": { + "type": "string", + "x-stoplight": { + "id": "2pdl6nnrb1ar4" + } + } } + }, + "file": { + "type": "string", + "x-stoplight": { + "id": "1yko3sjshe3k8" + }, + "format": "binary", + "description": "The source file (binary string). Only SDLXLIFF files are accepted." } + } + }, + "perfect-match-mapping-create-request": { + "title": "PerfectMatch Mapping Create Request", + "x-stoplight": { + "id": "q81dfuu1hzfp8" }, + "type": "object", + "description": "A request to create a new PerfectMatch mapping.", "required": [ - "itemCount", - "items" + "projectId" ], - "description": "A response for the List My Accounts endpoint." - }, - "list-pricing-models-response": { - "title": "List Pricing Models Response", - "type": "object", "properties": { - "itemCount": { - "type": "integer" + "projectId": { + "type": "string", + "x-stoplight": { + "id": "nemjj434jweo7" + }, + "description": "The project identifier this mapping will be used on." }, - "items": { + "matchingProjects": { "type": "array", + "x-stoplight": { + "id": "cizz5j6yddvzh" + }, + "description": "A collection of projects that will be used to find matches and candidates for PerfectMatch mapping.", + "minItems": 0, + "maxItems": 10, "items": { - "$ref": "#/components/schemas/pricing-model" + "x-stoplight": { + "id": "52fzpqwxdoc9p" + }, + "type": "string" } } + } + }, + "perfect-match-mapping-response": { + "type": "object", + "x-examples": { + "Example 1": { + "id": "string", + "projectId": "string", + "createdBy": "string", + "mappings": [ + { + "id": "string", + "projectMappingId": "string", + "batch": 1073741824, + "mappingStatus": "GENERATED", + "mappingProviders": [ + { + "projectId": "string" + } + ], + "files": [ + { + "id": "string", + "fileId": "string", + "fileStorageId": "string", + "fileName": "string", + "path": [ + "string" + ], + "languageMappings": [ + { + "targetLanguage": "string", + "match": { + "fileName": "string", + "path": [ + "string" + ], + "origin": { + "fileId": "string", + "projectId": "string", + "matchSource": "USER", + "type": "BCM" + } + } + } + ] + } + ] + } + ] + } }, + "title": "PerfectMatch Mapping Response", "required": [ - "itemCount", - "items" + "id" ], - "description": "A response for the List Pricing Models endpoint." - }, - "list-project-templates-response": { - "title": "List Project Templates Response", - "type": "object", "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The mapping identifier." }, - "items": { + "project": { + "$ref": "#/components/schemas/project", + "description": "The project id where this mapping is used.", + "x-stoplight": { + "id": "cw1yohtjvixag" + } + }, + "createdBy": { + "$ref": "#/components/schemas/user", + "description": "The account user who created the mapping." + }, + "batchMappings": { "type": "array", + "description": "A collection of mappings per project batches.", "items": { - "$ref": "#/components/schemas/project-template-response" + "$ref": "#/components/schemas/perfect-match-batch-mapping", + "x-stoplight": { + "id": "gp890bw2rx06u" + } } } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Project Templates endpoint." + } }, - "list-schedule-templates-response": { - "title": "List Schedule Templates Response", + "perfect-match-mapping-simple-response": { + "type": "object", "x-stoplight": { - "id": "1rzz3ctuczv9f" + "id": "y1b8w4daohpzi" }, - "type": "object", - "description": "A response for the List Schedule Templates endpoint.", - "properties": { - "itemCount": { - "type": "integer" - }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/schedule-template" - } + "x-examples": { + "Example 1": { + "id": "string", + "projectId": "string", + "createdBy": "string", + "mappings": [ + { + "id": "string", + "projectMappingId": "string", + "batch": 1073741824, + "mappingStatus": "GENERATED", + "mappingProviders": [ + { + "projectId": "string" + } + ], + "files": [ + { + "id": "string", + "fileId": "string", + "fileStorageId": "string", + "fileName": "string", + "path": [ + "string" + ], + "languageMappings": [ + { + "targetLanguage": "string", + "match": { + "fileName": "string", + "path": [ + "string" + ], + "origin": { + "fileId": "string", + "projectId": "string", + "matchSource": "USER", + "type": "BCM" + } + } + } + ] + } + ] + } + ] } }, + "title": "PerfectMatch Mapping Response", "required": [ - "itemCount", - "items" - ] - }, - "list-rate-limits-response": { - "title": "List Rate Limits Response", - "type": "object", + "id" + ], "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The mapping identifier." }, - "items": { + "createdBy": { + "$ref": "#/components/schemas/user", + "description": "The account user who created the mapping." + }, + "batchMappings": { "type": "array", + "description": "A collection of mappings per project batches.", "items": { - "$ref": "#/components/schemas/rate-limit" + "$ref": "#/components/schemas/perfect-match-batch-mapping" } } }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Rate Limits endpoint." + "description": "PerfectMatch Mapping (Not available for List Projects endpoint)" }, - "list-perfect-match-candidates-response": { - "title": "List PerfectMatch Candidates Response", + "perfect-match-mapping-create-response": { + "type": "object", "x-stoplight": { - "id": "i66skbktv8vko" + "id": "ztgh3mwksij6k" }, - "type": "object", - "description": "A response for the Get PerfectMatch Candidates endpoint.", + "x-examples": { + "Example 1": { + "id": "string", + "projectId": "string", + "createdBy": "string", + "mappings": [ + { + "id": "string", + "projectMappingId": "string", + "batch": 1073741824, + "mappingStatus": "GENERATED", + "mappingProviders": [ + { + "projectId": "string" + } + ], + "files": [ + { + "id": "string", + "fileId": "string", + "fileStorageId": "string", + "fileName": "string", + "path": [ + "string" + ], + "languageMappings": [ + { + "targetLanguage": "string", + "match": { + "fileName": "string", + "path": [ + "string" + ], + "origin": { + "fileId": "string", + "projectId": "string", + "matchSource": "USER", + "type": "BCM" + } + } + } + ] + } + ] + } + ] + } + }, + "title": "PerfectMatch Mapping Create Response", "required": [ - "itemCount", - "items" + "id" ], "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The mapping identifier." }, - "items": { + "project": { + "$ref": "#/components/schemas/project", + "description": "The project id where this mapping is used." + }, + "createdBy": { + "$ref": "#/components/schemas/user", + "description": "The account user who created the mapping." + }, + "batchMappings": { "type": "array", + "description": "A collection of mappings per project batches.", "items": { - "$ref": "#/components/schemas/perfect-match-candidate" + "$ref": "#/components/schemas/perfect-match-batch-mapping-created-response" } } } }, - "list-project-groups-response": { - "title": "List Project Groups Response", + "perfect-match-project-file-mapping-request": { "type": "object", - "description": "A response for the List Project Groups endpoint.", + "title": "PerfectMatch Project File Mapping Request", + "description": "Provide a matching file from an existing project.", + "required": [ + "fileId", + "projectId" + ], "properties": { - "itemCount": { - "type": "integer" + "fileId": { + "type": "string", + "description": "The `targetFileId` from the referenced project. Must be from a PerfectMatch Candidate." }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-group" - } + "projectId": { + "type": "string", + "description": "Specifies which project the matching file belongs to. Must be from a PerfectMatch Candidate." } - }, - "required": [ - "itemCount", - "items" - ] + } }, - "list-projects-response": { - "title": "List Projects Response", + "perfect-match-batch-mapping-created-response": { + "title": "PerfectMatch Batch Mapping Created Response", + "x-stoplight": { + "id": "sd4wox8a8yxu0" + }, "type": "object", + "required": [ + "id" + ], "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The identifier of this batch mapping." }, - "items": { + "batch": { + "type": "integer", + "minimum": 1, + "description": "The project batch associated with this mapping." + }, + "status": { + "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", + "type": "string", + "enum": [ + "generating", + "generated", + "pending" + ] + }, + "matchingProjects": { "type": "array", "items": { "$ref": "#/components/schemas/project" } } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Projects endpoint." + } }, - "list-source-files-response": { - "title": "List Source Files Response", + "perfect-match-batch-mapping-update-request": { + "title": "PerfectMatch Batch Mapping Update Request", "type": "object", + "required": [ + "languageDirections", + "files" + ], "properties": { - "itemCount": { - "type": "integer" - }, - "items": { + "languageDirections": { "type": "array", + "x-stoplight": { + "id": "wx7ycae79bp99" + }, "items": { - "$ref": "#/components/schemas/source-file" + "$ref": "#/components/schemas/language-direction-request", + "x-stoplight": { + "id": "onvc9ppeqn9nx" + } } - } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Source Files endpoint." - }, - "list-source-file-versions-response": { - "title": "List Source File Versions Response", - "type": "object", - "properties": { - "itemCount": { - "type": "integer" }, - "items": { + "files": { "type": "array", + "x-stoplight": { + "id": "bfels2gzsvw4f" + }, "items": { - "$ref": "#/components/schemas/source-file-version" + "$ref": "#/components/schemas/perfect-match-file-mapping-request", + "x-stoplight": { + "id": "c174aqqs2sxuq" + } } - } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Source File Versions endpoint." - }, - "list-target-files-response": { - "title": "List Target Files Response", - "type": "object", - "properties": { - "itemCount": { - "type": "integer" }, - "items": { + "matchingProjects": { "type": "array", + "x-stoplight": { + "id": "1i0ai06fg30tf" + }, + "maxItems": 10, + "description": "A collection of project identifiers that will be used to find matches and candidates for PerfectMatch mapping.", "items": { - "$ref": "#/components/schemas/target-file" + "x-stoplight": { + "id": "1tzpb2tsqipah" + }, + "type": "string" } } + } + }, + "perfect-match-batch-mapping": { + "title": "PerfectMatch Batch Mapping", + "x-stoplight": { + "id": "9cda3eljxhu3a" }, + "type": "object", "required": [ - "itemCount", - "items" + "id" ], - "description": "A response for the List Target Files endpoint." - }, - "list-target-file-versions-response": { - "title": "List Target File Versions Response", - "type": "object", - "description": "A response for the List Target Files Versions endpoint.", "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "x-stoplight": { + "id": "oxnybhlyo0zi7" + }, + "description": "The identifier of this batch mapping." }, - "items": { + "batch": { + "type": "integer", + "x-stoplight": { + "id": "s6rq1wfw9jdy1" + }, + "minimum": 1, + "description": "The project batch associated with this mapping." + }, + "status": { + "x-stoplight": { + "id": "vaorrbeajdfu5" + }, + "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", + "type": "string", + "enum": [ + "generating", + "generated", + "pending" + ] + }, + "matchingProjects": { "type": "array", + "x-stoplight": { + "id": "friowu6zupizf" + }, "items": { - "$ref": "#/components/schemas/target-file-version" + "$ref": "#/components/schemas/project", + "x-stoplight": { + "id": "oc87tuszl8nfk" + } } - } - }, - "required": [ - "itemCount", - "items" - ] - }, - "list-tasks-response": { - "title": "List Tasks Response", - "type": "object", - "properties": { - "itemCount": { - "type": "integer" }, - "items": { + "matchingFiles": { "type": "array", + "x-stoplight": { + "id": "9jd93fqm2ltik" + }, + "description": "The file matches identified based on this mapping. Matching files will be available when status is `generated`.", "items": { - "$ref": "#/components/schemas/task" + "$ref": "#/components/schemas/perfect-match-file-mapping", + "x-stoplight": { + "id": "9pjk6n73h08ny" + } } } + } + }, + "perfect-match-file-match": { + "title": "PerfectMatch File Match", + "x-stoplight": { + "id": "6cznfvzrl2f6u" }, + "type": "object", "required": [ - "itemCount", - "items" + "fileName", + "targetLanguage" ], - "description": "A response for the List Tasks endpoint." - }, - "list-task-types-response": { - "title": "List Task Types Response", - "type": "object", "properties": { - "itemCount": { - "type": "integer" + "fileName": { + "type": "string", + "x-stoplight": { + "id": "1p98snhwpm9z2" + }, + "description": "The file name." }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/task-type" - } + "targetLanguage": { + "$ref": "#/components/schemas/language", + "x-stoplight": { + "id": "08vniy685mxh2" + }, + "description": "The target language this is matched to." + }, + "origin": { + "$ref": "#/components/schemas/perfect-match-file-origin", + "x-stoplight": { + "id": "id0ppt1te182q" + }, + "description": "The source of this match." } + } + }, + "perfect-match-file-mapping": { + "title": "PerfectMatch File Mapping", + "x-stoplight": { + "id": "03dgg9mbsdrab" }, + "type": "object", "required": [ - "itemCount", - "items" + "fileMappingId", + "targetLanguages", + "matches" ], - "description": "A response for the List Task types endpoint." - }, - "list-tqa-profiles-response": { - "title": "List TQA Profiles Response", - "type": "object", - "description": "", "properties": { - "items": { + "fileMappingId": { + "type": "string", + "x-stoplight": { + "id": "a3wt6g7te3bf4" + }, + "description": "The identifier of this file mapping." + }, + "fileId": { + "type": "string", + "x-stoplight": { + "id": "z52hcnkibqypu" + }, + "description": "The file identifier." + }, + "fileName": { + "type": "string", + "x-stoplight": { + "id": "8ol3pommxgmwx" + }, + "description": "The file name." + }, + "targetLanguages": { "type": "array", + "x-stoplight": { + "id": "r4uvpx3hkfk6r" + }, + "description": "File target languages.", "items": { - "$ref": "#/components/schemas/tqa-profile" + "$ref": "#/components/schemas/language", + "x-stoplight": { + "id": "wgqj3aq90fxrl" + } } }, - "itemCount": { - "type": "integer" - } - }, - "required": [ - "items", - "itemCount" - ] - }, - "list-termbase-templates-response": { - "title": "List Termbase Templates Response", - "type": "object", - "description": "The termbase templates response.", - "properties": { - "items": { + "matches": { "type": "array", + "x-stoplight": { + "id": "lrkirjzhqym3j" + }, + "description": "The file matches.", "items": { - "$ref": "#/components/schemas/termbase-template" + "$ref": "#/components/schemas/perfect-match-file-match", + "x-stoplight": { + "id": "h0414pn1x8ebh" + } } - }, - "itemCount": { - "type": "integer" } - }, - "required": [ - "items", - "itemCount" - ] + } }, - "list-termbases-response": { - "title": "List Termbases Response", + "perfect-match-file-mapping-request": { + "title": "PerfectMatch File Mapping Request", + "x-stoplight": { + "id": "mtvcmglyse666" + }, "type": "object", - "description": "The list termbases response.", + "required": [ + "sourceFileId", + "fileName" + ], "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase" + "sourceFileId": { + "type": "string", + "description": "The source file identifier.", + "x-stoplight": { + "id": "6gsxau7p4z2t8" } }, - "itemCount": { - "type": "integer" - } - }, - "required": [ - "items", - "itemCount" - ] - }, - "list-termbase-terms-response": { - "title": "List Termbase Terms Response", - "type": "object", - "description": "The list termbase terms response.", - "properties": { - "items": { + "fileName": { + "type": "string", + "description": "The file name." + }, + "targetLanguages": { "type": "array", + "description": "File target languages. If no languages are specified, all language directions from the batch mapping will be used.", "items": { - "$ref": "#/components/schemas/termbase-term" + "$ref": "#/components/schemas/target-language-request" } - }, - "itemCount": { - "type": "integer" } - }, - "required": [ - "items", - "itemCount" - ] + } }, - "list-termbase-entries-response": { - "title": "List Termbase Entries Response", + "perfect-match-file-origin": { + "title": "PerfectMatch File Origin", + "x-stoplight": { + "id": "bv5cnpx9k3iny" + }, "type": "object", - "description": "The list termbase entries response.", + "required": [ + "fileId" + ], "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-entry" + "fileId": { + "type": "string", + "x-stoplight": { + "id": "f2apl2q7ak1dd" } }, - "itemCount": { - "type": "integer" - } - }, - "required": [ - "items", - "itemCount" - ] - }, - "list-termbase-import-history": { - "title": "Get Termbase Import History", - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-import-history-response" + "matchSource": { + "x-stoplight": { + "id": "hnztp78j7k3kv" + }, + "type": "string", + "enum": [ + "userUpload", + "perfectMatch", + "candidateConfirm", + "userSelection" + ] + }, + "projectId": { + "type": "string", + "x-stoplight": { + "id": "zq9xsxg01n4cr" } }, - "itemCount": { - "type": "integer" + "type": { + "x-stoplight": { + "id": "plrs8n0348nq8" + }, + "type": "string", + "enum": [ + "bcm", + "sdlXliff" + ] } } }, - "list-translation-engines-response": { - "title": "List Translation Engines Response", + "pricing-model": { + "title": "Pricing Model", "type": "object", + "description": "Pricing Model resource. (Not available for List Projects endpoint)", + "required": [ + "id" + ], "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The pricing model identifier." }, - "items": { + "name": { + "type": "string", + "description": "
default
The name of the Pricing Model.
" + }, + "description": { + "type": "string", + "description": "The description of the Pricing Model. ", + "x-stoplight": { + "id": "ip7d3npquqhtm" + } + }, + "currencyCode": { + "type": "string", + "description": "
default
The currency code (ISO 4217).
", + "x-default-field": true + }, + "location": { + "$ref": "#/components/schemas/folder-v2", + "x-default-field": true + }, + "languageDirectionPricing": { "type": "array", + "description": "Costs applied for languages.", "items": { - "$ref": "#/components/schemas/translation-engine" + "$ref": "#/components/schemas/language-direction-cost", + "x-stoplight": { + "id": "iulcrkpbt2dkl" + } } - } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Translation Engines endpoint." - }, - "list-translation-memories-reposne": { - "title": "List Translation Memories Response", - "type": "object", - "properties": { - "itemCount": { - "type": "integer" }, - "items": { + "additionalCosts": { + "description": "Additional costs applied at project level.", "type": "array", "items": { - "$ref": "#/components/schemas/translation-memory" + "$ref": "#/components/schemas/project-cost", + "x-stoplight": { + "id": "8mgl2ge6it23h" + } } } + } + }, + "pricing-model-create-request": { + "title": "Pricing Model Create Request", + "x-stoplight": { + "id": "84rdt11xy57je" }, + "type": "object", "required": [ - "itemCount", - "items" + "name", + "currencyCode", + "location", + "languageDirectionPricing" ], - "description": "A response for the List Translation Memories endpoint." - }, - "list-translation-memory-import-history": { - "title": "Get Translation Memory Import History", - "type": "object", "properties": { - "items": { + "name": { + "type": "string", + "x-stoplight": { + "id": "ux0n1of3l2fcg" + }, + "minLength": 1, + "maxLength": 100, + "description": "The name of the Pricing Model. " + }, + "description": { + "type": "string", + "x-stoplight": { + "id": "lqs1u6y1jp99p" + }, + "maxLength": 1000, + "description": "The description of the Pricing Model. " + }, + "currencyCode": { + "type": "string", + "x-stoplight": { + "id": "p7je5zmdu0oft" + }, + "description": "The currency code (ISO 4217)." + }, + "location": { + "x-stoplight": { + "id": "ut6kllrmvrxi3" + }, + "type": "string", + "description": "The location of the pricing model." + }, + "languageDirectionPricing": { "type": "array", + "x-stoplight": { + "id": "5fvs81l6ulki3" + }, + "description": "Costs applied for languages.", "items": { - "$ref": "#/components/schemas/translation-memory-import-history-response" + "$ref": "#/components/schemas/language-direction-cost-request", + "x-stoplight": { + "id": "bx0acxg9bor4s" + } } }, - "itemCount": { - "type": "integer" + "additionalCosts": { + "type": "array", + "x-stoplight": { + "id": "ibv6uo16upgzt" + }, + "description": "Additional costs applied at project level.", + "items": { + "$ref": "#/components/schemas/project-cost-request", + "x-stoplight": { + "id": "lj22tg789rgr1" + } + } } } }, - "list-translation-memory-field-templates": { - "title": "List Translation Memory Field Templates", + "pricing-model-update-request": { + "title": "Pricing Model Update Request", "x-stoplight": { - "id": "icrpz2hliblzj" + "id": "1c3gw712tops3" }, "type": "object", - "description": "A response for the List Translation Memory Field Templates endpoint.", "properties": { - "itemCount": { - "type": "integer" + "name": { + "type": "string", + "x-stoplight": { + "id": "xv08h2p68irht" + }, + "description": "The name of the Pricing Model. ", + "minLength": 1, + "maxLength": 100 }, - "items": { + "description": { + "type": "string", + "x-stoplight": { + "id": "kqq1pm5c0nbkt" + }, + "description": "The description of the Pricing Model. ", + "maxLength": 1000 + }, + "currencyCode": { + "type": "string", + "x-stoplight": { + "id": "640ojrh29nljb" + }, + "description": "The currency code (ISO 4217)." + }, + "languageDirectionPricing": { + "x-stoplight": { + "id": "24gog5ehhl04i" + }, + "description": "Costs applied for languages.", "type": "array", "items": { - "$ref": "#/components/schemas/translation-memory-field-template" + "$ref": "#/components/schemas/language-direction-cost-request", + "x-stoplight": { + "id": "8bkrkdfcb2s15" + } } - } - }, - "required": [ - "itemCount", - "items" - ] - }, - "list-users-response": { - "title": "List Users Response", - "type": "object", - "properties": { - "itemCount": { - "type": "integer" }, - "items": { + "additionalCosts": { + "x-stoplight": { + "id": "buk3e62if233x" + }, + "description": "Additional costs applied at project level.", "type": "array", "items": { - "$ref": "#/components/schemas/user" + "$ref": "#/components/schemas/project-cost-request", + "x-stoplight": { + "id": "dd4fhfzp4hqx2" + } } } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Users endpoint." + } }, - "list-workflows-response": { - "title": "List Workflows Response", + "project-pricing-model-update-request": { + "title": "Update project pricing model request", "type": "object", + "required": [ + "id" + ], "properties": { - "itemCount": { - "type": "integer" + "id": { + "type": "string", + "description": "The pricing model identifier." }, - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow" - } + "strategy": { + "type": "string", + "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", + "default": "copy", + "enum": [ + "copy", + "use" + ] } - }, - "required": [ - "itemCount", - "items" - ], - "description": "A response for the List Workflows endpoint." + } }, - "machine-translation": { - "title": "Machine Translation", - "x-stoplight": { - "id": "q83tushwc71wu" - }, + "pricing-unit-type": { + "title": "Pricing Unit Type", + "enum": [ + "words", + "characters" + ] + }, + "project": { + "title": "Project", "type": "object", - "description": "Machine translation resource.", + "description": "Project resource.", + "required": [ + "id" + ], "properties": { "id": { - "type": "string" + "type": "string", + "description": "The project identifier." }, - "provider": { + "shortId": { "type": "string", - "description": "
Provider of the machine translation.
", - "x-default-field": true, - "x-stoplight": { - "id": "o2vxfwxx5ypjq" - } + "description": "The short identifier of the project." }, - "type": { + "name": { "type": "string", - "x-stoplight": { - "id": "027ukef1wajci" - }, - "description": "Type of the machine translation. Can be generic or neural." + "description": "
default
The project name.
", + "x-default-field": true }, - "systemId": { + "description": { "type": "string", - "x-stoplight": { - "id": "6inesg0lkfqtn" - }, - "description": "
default
Appears if the machine translation is neural." + "description": "The project description." }, - "modelSourceLanguage": { - "x-stoplight": { - "id": "ujzglo1mwl4pl" - }, + "dueBy": { "type": "string", - "description": "Model Source language" + "example": "2022-01-12T12:00:00.000Z", + "description": "The project due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true }, - "modelTargetLanguage": { + "deliveredBy": { "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": " UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true, "x-stoplight": { - "id": "dssycbmasvpyc" - }, - "description": "Model Target language" + "id": "xxmhjuc5d6ohd" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The project's creation date and time.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time", + "nullable": true + }, + "status": { + "type": "string", + "description": "The project's status.", + "enum": [ + "created", + "inProgress", + "completed", + "archived" + ], + "nullable": true + }, + "statusHistory": { + "type": "array", + "description": "The project's status history.", + "nullable": true, + "items": { + "$ref": "#/components/schemas/project-status-history" + } + }, + "languageDirections": { + "type": "array", + "description": "
default
The project's language directions.
", + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/language-direction" + } + }, + "customer": { + "$ref": "#/components/schemas/customer" + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "location": { + "$ref": "#/components/schemas/folder-v2", + "description": "
default
The resource folder.
", + "x-default-field": true + }, + "projectTemplate": { + "$ref": "#/components/schemas/project-template-response" + }, + "translationEngine": { + "$ref": "#/components/schemas/translation-engine" + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/file-processing-configuration" + }, + "pricingModel": { + "$ref": "#/components/schemas/pricing-model" + }, + "workflow": { + "$ref": "#/components/schemas/workflow" + }, + "projectPlan": { + "$ref": "#/components/schemas/project-plan" + }, + "analytics": { + "$ref": "#/components/schemas/analytics" + }, + "analysisStatistics": { + "$ref": "#/components/schemas/analysis-statistics" + }, + "quote": { + "$ref": "#/components/schemas/quote" + }, + "customFields": { + "type": "array", + "description": "The Custom Fields", + "items": { + "$ref": "#/components/schemas/custom-field" + } + }, + "tqaProfile": { + "$ref": "#/components/schemas/tqa-profile" + }, + "forceOnline": { + "type": "boolean", + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." }, - "matchingSourceLanguage": { - "type": "string", - "x-stoplight": { - "id": "rxm5xpz6oj11t" - }, - "description": "Specific source language supported by the model, matching the query " + "quoteTemplate": { + "$ref": "#/components/schemas/project-quote-template" }, - "matchingTargetLanguages": { + "projectGroup": { + "$ref": "#/components/schemas/project-group" + }, + "projectManagers": { "type": "array", - "x-stoplight": { - "id": "ncr79i78eof3x" - }, - "description": "Specific target languages supported by the model, matching the query ", "items": { - "x-stoplight": { - "id": "7ekyl863df2e7" - }, - "type": "string" + "$ref": "#/components/schemas/project-manager-response" } - } - }, - "required": [ - "id", - "provider", - "type", - "modelSourceLanguage", - "modelTargetLanguage", - "matchingSourceLanguage", - "matchingTargetLanguages" - ] - }, - "object-id": { - "title": "Object Identifier", - "type": "object", - "description": "An object with identifier.", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "object-id-request": { - "title": "Object Identifier Request", - "type": "object", - "description": "An object with identifier.", - "properties": { - "id": { - "type": "string" - } - }, - "required": [ - "id" - ] - }, - "perfect-match-candidate": { - "title": "PerfectMatch Candidate", - "x-stoplight": { - "id": "fx87e3hzcrq7z" - }, - "type": "object", - "x-internal": false, - "required": [ - "score", - "fileId" - ], - "properties": { - "score": { - "type": "number", - "x-stoplight": { - "id": "fm35hes639la9" - }, - "format": "double", - "description": "The match score.", - "minimum": 0, - "maximum": 100 }, - "fileId": { - "type": "string", + "scheduleTemplate": { + "$ref": "#/components/schemas/schedule-template", "x-stoplight": { - "id": "vs2ndi7jr87fl" - }, - "description": "The file identifier:\r\n- `targetFileId` if file is a project file\r\n- `fileId` if file is user provided" + "id": "dsvy1i7nqqv3z" + } }, - "project": { - "$ref": "#/components/schemas/project", - "x-stoplight": { - "id": "umsyu9xmi8sqp" - }, - "description": "The project from where the candidate was selected." - } - }, - "description": "A project file that can be used as a match for PerfectMatch" - }, - "perfect-match-custom-file-mapping-request": { - "title": "PerfectMatch Custom File Mapping Request", - "x-stoplight": { - "id": "c787724801aca" - }, - "description": "Provide you own matching file.", - "type": "object", - "required": [ - "properties", - "file" - ], - "properties": { - "properties": { - "type": "object", + "perfectMatchMapping": { + "$ref": "#/components/schemas/perfect-match-mapping-simple-response", "x-stoplight": { - "id": "q75mghzupqq7g" - }, - "required": [ - "name", - "targetLanguage" - ], - "properties": { - "name": { - "type": "string", - "x-stoplight": { - "id": "df0d1cic1j71s" - }, - "description": "The file name." - }, - "targetLanguage": { - "type": "string", - "x-stoplight": { - "id": "2pdl6nnrb1ar4" - } - } + "id": "15ak4sadvjb89" } }, - "file": { - "type": "string", + "settings": { + "$ref": "#/components/schemas/project-settings-response", "x-stoplight": { - "id": "1yko3sjshe3k8" - }, - "format": "binary", - "description": "The source file (binary string). Only SDLXLIFF files are accepted." + "id": "k0yk2u3skecpf" + } } } }, - "perfect-match-mapping-create-request": { - "title": "PerfectMatch Mapping Create Request", - "x-stoplight": { - "id": "q81dfuu1hzfp8" - }, + "project-create-request": { + "title": "Project Create Request", "type": "object", - "description": "A request to create a new PerfectMatch mapping.", + "description": "Input for Project creation.\n\nBefore starting the project, the required configuration resources (translation engine, file processing configuration and workflow) should be set either explicitly or through a project template that contains references to these configuration resources.", "required": [ - "projectId" + "name", + "dueBy", + "languageDirections", + "location" ], "properties": { - "projectId": { + "name": { "type": "string", - "x-stoplight": { - "id": "nemjj434jweo7" - }, - "description": "The project identifier this mapping will be used on." + "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 }, - "matchingProjects": { + "description": { + "type": "string", + "description": "The project description.", + "maxLength": 1000 + }, + "dueBy": { + "$ref": "#/components/schemas/date-time" + }, + "projectTemplate": { + "$ref": "#/components/schemas/object-id-request" + }, + "languageDirections": { "type": "array", - "x-stoplight": { - "id": "cizz5j6yddvzh" - }, - "description": "A collection of projects that will be used to find matches and candidates for PerfectMatch mapping.", - "minItems": 0, - "maxItems": 10, - "items": { - "x-stoplight": { - "id": "52fzpqwxdoc9p" - }, - "type": "string" - } - } - } - }, - "perfect-match-mapping-response": { - "type": "object", - "x-examples": { - "Example 1": { - "id": "string", - "projectId": "string", - "createdBy": "string", - "mappings": [ - { - "id": "string", - "projectMappingId": "string", - "batch": 1073741824, - "mappingStatus": "GENERATED", - "mappingProviders": [ - { - "projectId": "string" - } - ], - "files": [ - { - "id": "string", - "fileId": "string", - "fileStorageId": "string", - "fileName": "string", - "path": [ - "string" - ], - "languageMappings": [ - { - "targetLanguage": "string", - "match": { - "fileName": "string", - "path": [ - "string" - ], - "origin": { - "fileId": "string", - "projectId": "string", - "matchSource": "USER", - "type": "BCM" - } - } - } - ] - } - ] - } - ] - } - }, - "title": "PerfectMatch Mapping Response", - "required": [ - "id" - ], - "properties": { - "id": { + "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "location": { "type": "string", - "description": "The mapping identifier." + "description": "The folder identifier where the project should be created." }, - "project": { - "$ref": "#/components/schemas/project", - "description": "The project id where this mapping is used.", - "x-stoplight": { - "id": "cw1yohtjvixag" + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" } }, - "createdBy": { - "$ref": "#/components/schemas/user", - "description": "The account user who created the mapping." + "tqaProfile": { + "$ref": "#/components/schemas/configuration-resource-request" }, - "batchMappings": { + "forceOnline": { + "type": "boolean", + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." + }, + "projectManagers": { "type": "array", - "description": "A collection of mappings per project batches.", "items": { - "$ref": "#/components/schemas/perfect-match-batch-mapping", - "x-stoplight": { - "id": "gp890bw2rx06u" - } + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-settings-request", + "x-stoplight": { + "id": "53re0us2no8zk" } } } }, - "perfect-match-mapping-simple-response": { + "project-configuration": { + "title": "Project Configuration", + "x-stoplight": { + "id": "qx05l6h0joh9h" + }, + "description": "The configuration settings for a project.", "type": "object", + "properties": { + "translationMemoryFields": { + "$ref": "#/components/schemas/translation-memory-fields", + "description": "
default
", + "x-default-field": true + }, + "updateTranslationMemory": { + "$ref": "#/components/schemas/update-translation-memory", + "x-stoplight": { + "id": "akhqz2lu4ks2b" + } + } + } + }, + "project-configuration-request": { + "title": "Project Configuration Request", "x-stoplight": { - "id": "y1b8w4daohpzi" + "id": "5ivmv9i754acq" }, - "x-examples": { - "Example 1": { - "id": "string", - "projectId": "string", - "createdBy": "string", - "mappings": [ - { - "id": "string", - "projectMappingId": "string", - "batch": 1073741824, - "mappingStatus": "GENERATED", - "mappingProviders": [ - { - "projectId": "string" - } - ], - "files": [ - { - "id": "string", - "fileId": "string", - "fileStorageId": "string", - "fileName": "string", - "path": [ - "string" - ], - "languageMappings": [ - { - "targetLanguage": "string", - "match": { - "fileName": "string", - "path": [ - "string" - ], - "origin": { - "fileId": "string", - "projectId": "string", - "matchSource": "USER", - "type": "BCM" - } - } - } - ] - } - ] - } - ] + "type": "object", + "description": "A request used to update the configuration settings for a project.", + "properties": { + "translationMemoryFieldsSettings": { + "$ref": "#/components/schemas/translation-memory-fields-update-request" + }, + "updateTranslationMemory": { + "$ref": "#/components/schemas/update-translation-memory", + "x-stoplight": { + "id": "zx6orwsjfd51g" + } + }, + "perfectMatchMappingId": { + "type": "string", + "x-stoplight": { + "id": "84cmud84h1lf6" + }, + "description": "The PerfectMatch mapping to be associated with the project." } + } + }, + "project-cost-request": { + "title": "Project Cost Request", + "x-stoplight": { + "id": "c3890498b55df" }, - "title": "PerfectMatch Mapping Response", + "type": "object", "required": [ - "id" + "name", + "type" ], "properties": { - "id": { + "name": { "type": "string", - "description": "The mapping identifier." + "description": "The name of the additional cost. " }, - "createdBy": { - "$ref": "#/components/schemas/user", - "description": "The account user who created the mapping." + "type": { + "$ref": "#/components/schemas/project-cost-type", + "description": "The type of the additional cost." }, - "batchMappings": { + "index": { + "type": "number", + "description": "The number of the additional cost." + }, + "costPerUnit": { + "type": "number", + "description": "The cost of a unit." + }, + "unitCount": { + "type": "number", + "description": "The number of units for which a cost is applied." + }, + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as reference for the unit cost." + }, + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Only for the Conditional type." + }, + "costOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "zqif0hjssiw1a" + } + }, + "costVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "Only for the Conditional type.", + "x-stoplight": { + "id": "3a5ok8ukdtldt" + } + }, + "operand": { + "type": "number", + "description": "Operand of the Conditional type cost." + }, + "serviceTypes": { "type": "array", - "description": "A collection of mappings per project batches.", + "x-stoplight": { + "id": "k49y0alzptb99" + }, + "description": "Array of Service Type identifiers where this additional cost is applied.", "items": { - "$ref": "#/components/schemas/perfect-match-batch-mapping" + "x-stoplight": { + "id": "mg7w7sqohrgze" + }, + "type": "string" } + }, + "customUnitName": { + "type": "string", + "x-stoplight": { + "id": "1jvy04hcveeqt" + }, + "maxLength": 100, + "description": "The name of the custom unit. Required when `volumeUnitType` is `custom`." } + } + }, + "project-cost-type": { + "title": "Project Cost Type", + "x-stoplight": { + "id": "nu6db8fhwsnqb" }, - "description": "PerfectMatch Mapping (Not available for List Projects endpoint)" - }, - "perfect-match-mapping-create-response": { - "type": "object", - "x-stoplight": { - "id": "ztgh3mwksij6k" - }, - "x-examples": { - "Example 1": { - "id": "string", - "projectId": "string", - "createdBy": "string", - "mappings": [ - { - "id": "string", - "projectMappingId": "string", - "batch": 1073741824, - "mappingStatus": "GENERATED", - "mappingProviders": [ - { - "projectId": "string" - } - ], - "files": [ - { - "id": "string", - "fileId": "string", - "fileStorageId": "string", - "fileName": "string", - "path": [ - "string" - ], - "languageMappings": [ - { - "targetLanguage": "string", - "match": { - "fileName": "string", - "path": [ - "string" - ], - "origin": { - "fileId": "string", - "projectId": "string", - "matchSource": "USER", - "type": "BCM" - } - } - } - ] - } - ] - } - ] - } - }, - "title": "PerfectMatch Mapping Create Response", - "required": [ - "id" - ], + "enum": [ + "volume", + "perTargetLanguage", + "perFile", + "hourly", + "percentage", + "perPage", + "conditional", + "adhoc", + "adhocVolume" + ] + }, + "project-group": { + "title": "Project Group", + "type": "object", + "description": "Project Group resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", - "description": "The mapping identifier." + "description": "The project group identifier." }, - "project": { - "$ref": "#/components/schemas/project", - "description": "The project id where this mapping is used." + "shortId": { + "type": "string", + "description": "The short identifier of the project group." }, - "createdBy": { - "$ref": "#/components/schemas/user", - "description": "The account user who created the mapping." + "name": { + "type": "string", + "description": "
default
The project group name.
", + "x-default-field": true }, - "batchMappings": { + "description": { + "type": "string", + "description": "The project group description." + }, + "status": { + "type": "string", + "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", + "enum": [ + "new", + "inProgress", + "completed", + "deleting" + ] + }, + "projects": { "type": "array", - "description": "A collection of mappings per project batches.", + "description": "The projects in the project group.", "items": { - "$ref": "#/components/schemas/perfect-match-batch-mapping-created-response" + "$ref": "#/components/schemas/project-group-project" } + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" } - } + }, + "required": [ + "id" + ] }, - "perfect-match-project-file-mapping-request": { + "project-group-create-response": { + "title": "Project Group Create Response", "type": "object", - "title": "PerfectMatch Project File Mapping Request", - "description": "Provide a matching file from an existing project.", - "required": [ - "fileId", - "projectId" - ], + "description": "The Project Group Create response. ", "properties": { - "fileId": { + "id": { "type": "string", - "description": "The `targetFileId` from the referenced project. Must be from a PerfectMatch Candidate." + "description": "The project group identifier." }, - "projectId": { + "name": { "type": "string", - "description": "Specifies which project the matching file belongs to. Must be from a PerfectMatch Candidate." + "description": "The project group name." + }, + "description": { + "type": "string", + "description": "The project group description." + }, + "status": { + "type": "string", + "description": "The status of the projects in the project group.\n\n- `new`: the group is newly created, or all the projects in the group have the \"New\" status \n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have the \"Completed\" status \n\n- `deleting`: the group is being deleted and the projects will be removed", + "enum": [ + "new", + "inProgress", + "completed", + "deleting" + ] + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "shortId": { + "type": "string", + "x-stoplight": { + "id": "g72simvju3z9z" + } + }, + "createdAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "format": "date-time" } - } - }, - "perfect-match-batch-mapping-created-response": { - "title": "PerfectMatch Batch Mapping Created Response", - "x-stoplight": { - "id": "sd4wox8a8yxu0" }, - "type": "object", "required": [ "id" - ], + ] + }, + "project-group-project": { + "title": "Project Group Project", + "type": "object", + "description": "Project resource for project group.", "properties": { "id": { "type": "string", - "description": "The identifier of this batch mapping." - }, - "batch": { - "type": "integer", - "minimum": 1, - "description": "The project batch associated with this mapping." + "description": "The project identifier." }, "status": { - "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", "type": "string", + "description": "The project's status.", "enum": [ - "generating", - "generated", - "pending" + "attaching", + "attached", + "detaching", + "updating", + "failed" ] - }, - "matchingProjects": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project" - } } + }, + "required": [ + "id" + ], + "x-stoplight": { + "id": "kia482tzj55ou" } }, - "perfect-match-batch-mapping-update-request": { - "title": "PerfectMatch Batch Mapping Update Request", + "project-group-project-request": { + "title": "Project Group Project Request", + "x-stoplight": { + "id": "abqotabie1tzm" + }, "type": "object", + "properties": { + "id": { + "type": "string", + "description": "A project id." + } + }, "required": [ - "languageDirections", - "files" - ], + "id" + ] + }, + "project-group-create-request": { + "title": "Project Group Create Request", + "type": "object", + "description": "Input for project group creation.", "properties": { - "languageDirections": { - "type": "array", - "x-stoplight": { - "id": "wx7ycae79bp99" - }, - "items": { - "$ref": "#/components/schemas/language-direction-request", - "x-stoplight": { - "id": "onvc9ppeqn9nx" - } - } + "name": { + "type": "string", + "description": "The project group name.\\\nMust be unique per location.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 }, - "files": { - "type": "array", - "x-stoplight": { - "id": "bfels2gzsvw4f" - }, - "items": { - "$ref": "#/components/schemas/perfect-match-file-mapping-request", - "x-stoplight": { - "id": "c174aqqs2sxuq" - } - } + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 }, - "matchingProjects": { - "type": "array", - "x-stoplight": { - "id": "1i0ai06fg30tf" - }, - "maxItems": 10, - "description": "A collection of project identifiers that will be used to find matches and candidates for PerfectMatch mapping.", - "items": { - "x-stoplight": { - "id": "1tzpb2tsqipah" - }, - "type": "string" - } + "location": { + "type": "string", + "description": "The folder identifier where the project group should be created. If it isn't mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error. " + } + }, + "required": [ + "name" + ] + }, + "project-group-update-request": { + "title": "Project Group Update Request", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The project group name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project group description.", + "maxLength": 1000 } } }, - "perfect-match-batch-mapping": { - "title": "PerfectMatch Batch Mapping", + "project-manager-request": { + "title": "Project Manager Request", "x-stoplight": { - "id": "9cda3eljxhu3a" + "id": "6j883j92igshf" }, "type": "object", - "required": [ - "id" - ], "properties": { "id": { "type": "string", - "x-stoplight": { - "id": "oxnybhlyo0zi7" - }, - "description": "The identifier of this batch mapping." - }, - "batch": { - "type": "integer", - "x-stoplight": { - "id": "s6rq1wfw9jdy1" - }, - "minimum": 1, - "description": "The project batch associated with this mapping." + "description": "Depending on the type, User identifier or Group identifier." }, - "status": { - "x-stoplight": { - "id": "vaorrbeajdfu5" - }, - "description": "The status of the matching operation.\r\n\r\n- `pending` - The matching background operation has not started yet.\r\n- `generating` - The system is currently matching candidates.\r\n- `generated` - The matching background operation has finished and any possible candidates have been found.", + "type": { "type": "string", "enum": [ - "generating", - "generated", - "pending" + "group", + "user" ] - }, - "matchingProjects": { - "type": "array", - "x-stoplight": { - "id": "friowu6zupizf" - }, - "items": { - "$ref": "#/components/schemas/project", - "x-stoplight": { - "id": "oc87tuszl8nfk" - } - } - }, - "matchingFiles": { - "type": "array", - "x-stoplight": { - "id": "9jd93fqm2ltik" - }, - "description": "The file matches identified based on this mapping. Matching files will be available when status is `generated`.", - "items": { - "$ref": "#/components/schemas/perfect-match-file-mapping", - "x-stoplight": { - "id": "9pjk6n73h08ny" - } - } } - } + }, + "required": [ + "id", + "type" + ] }, - "perfect-match-file-match": { - "title": "PerfectMatch File Match", + "project-manager-response": { + "title": "Project Manager Response", "x-stoplight": { - "id": "6cznfvzrl2f6u" + "id": "jpzqsh6pvehw6" }, "type": "object", - "required": [ - "fileName", - "targetLanguage" - ], + "description": "", "properties": { - "fileName": { + "type": { "type": "string", - "x-stoplight": { - "id": "1p98snhwpm9z2" - }, - "description": "The file name." + "enum": [ + "group", + "user" + ] }, - "targetLanguage": { - "$ref": "#/components/schemas/language", - "x-stoplight": { - "id": "08vniy685mxh2" - }, - "description": "The target language this is matched to." + "user": { + "$ref": "#/components/schemas/user" }, - "origin": { - "$ref": "#/components/schemas/perfect-match-file-origin", - "x-stoplight": { - "id": "id0ppt1te182q" - }, - "description": "The source of this match." + "group": { + "$ref": "#/components/schemas/group" } } }, - "perfect-match-file-mapping": { - "title": "PerfectMatch File Mapping", + "project-settings-request": { + "title": "Project Settings", "x-stoplight": { - "id": "03dgg9mbsdrab" + "id": "7hz2hdu01vw0w" }, "type": "object", - "required": [ - "fileMappingId", - "targetLanguages", - "matches" - ], "properties": { - "fileMappingId": { - "type": "string", - "x-stoplight": { - "id": "a3wt6g7te3bf4" - }, - "description": "The identifier of this file mapping." - }, - "fileId": { - "type": "string", - "x-stoplight": { - "id": "z52hcnkibqypu" - }, - "description": "The file identifier." - }, - "fileName": { - "type": "string", - "x-stoplight": { - "id": "8ol3pommxgmwx" - }, - "description": "The file name." - }, - "targetLanguages": { - "type": "array", + "general": { + "$ref": "#/components/schemas/project-settings-general-request", "x-stoplight": { - "id": "r4uvpx3hkfk6r" - }, - "description": "File target languages.", - "items": { - "$ref": "#/components/schemas/language", - "x-stoplight": { - "id": "wgqj3aq90fxrl" - } + "id": "uv85h82rgn4ao" } - }, - "matches": { - "type": "array", + } + } + }, + "project-settings-response": { + "title": "Project Settings", + "x-stoplight": { + "id": "79vl39jda1he7" + }, + "type": "object", + "properties": { + "general": { + "$ref": "#/components/schemas/project-settings-general-response", + "description": "
default
\r\n" + } + } + }, + "project-settings-general-request": { + "title": "Project General Settings", + "x-stoplight": { + "id": "6dnig61u68hsr" + }, + "type": "object", + "properties": { + "completionConfiguration": { + "$ref": "#/components/schemas/completion-config-request", "x-stoplight": { - "id": "lrkirjzhqym3j" - }, - "description": "The file matches.", - "items": { - "$ref": "#/components/schemas/perfect-match-file-match", - "x-stoplight": { - "id": "h0414pn1x8ebh" - } + "id": "k15wt6trvjgbt" } } } }, - "perfect-match-file-mapping-request": { - "title": "PerfectMatch File Mapping Request", + "project-settings-general-response": { + "title": "Project General Settings", "x-stoplight": { - "id": "mtvcmglyse666" + "id": "v82ei22cerb0w" }, "type": "object", - "required": [ - "sourceFileId", - "fileName" - ], "properties": { - "sourceFileId": { + "completionConfiguration": { + "$ref": "#/components/schemas/completion-config-response", + "description": "
default
" + } + } + }, + "project-update-request": { + "title": "Project Update Request", + "type": "object", + "properties": { + "name": { "type": "string", - "description": "The source file identifier.", - "x-stoplight": { - "id": "6gsxau7p4z2t8" - } + "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", + "minLength": 1, + "maxLength": 100 }, - "fileName": { + "description": { "type": "string", - "description": "The file name." + "description": "The project description.", + "maxLength": 1000 + }, + "dueBy": { + "$ref": "#/components/schemas/date-time" + }, + "deliveredBy": { + "$ref": "#/components/schemas/date-time", + "x-stoplight": { + "id": "jlta5oi7fu3kf" + }, + "description": "Value used to automatically update dueBy of the project at the Customer Quote Approval step, if this step exists in the project workflow." + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request", + "description": "Resource configuration properties. Pricing model can only be updated for projects that are not started." + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "projectPlan": { + "$ref": "#/components/schemas/project-plan-update-request" + }, + "tqaProfile": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "quote": { + "$ref": "#/components/schemas/quote-update-request" + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } }, - "targetLanguages": { + "projectManagers": { "type": "array", - "description": "File target languages. If no languages are specified, all language directions from the batch mapping will be used.", "items": { - "$ref": "#/components/schemas/target-language-request" + "$ref": "#/components/schemas/project-manager-request" + } + }, + "settings": { + "$ref": "#/components/schemas/project-settings-request", + "x-stoplight": { + "id": "xd2b0b8qrxmfl" } } } }, - "perfect-match-file-origin": { - "title": "PerfectMatch File Origin", - "x-stoplight": { - "id": "bv5cnpx9k3iny" - }, + "project-template-create-request": { + "title": "Project Template Create Request", "type": "object", + "description": "Input for Project Template creation.", "required": [ - "fileId" + "name", + "location", + "fileProcessingConfiguration" ], "properties": { - "fileId": { + "name": { + "type": "string", + "description": "The project template name.", + "minLength": 1, + "maxLength": 100 + }, + "description": { + "type": "string", + "description": "The project description.", + "maxLength": 1000 + }, + "location": { "type": "string", + "description": "The folder identifier where the project should be created." + }, + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request", "x-stoplight": { - "id": "f2apl2q7ak1dd" + "id": "uj8d2oyrr72tr" } }, - "matchSource": { + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } + }, + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request", "x-stoplight": { - "id": "hnztp78j7k3kv" - }, - "type": "string", - "enum": [ - "userUpload", - "perfectMatch", - "candidateConfirm", - "userSelection" - ] + "id": "rg3f3u9tenpfl" + } }, - "projectId": { - "type": "string", + "languageDirections": { + "type": "array", + "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "customFields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-field-request" + } + }, + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request", "x-stoplight": { - "id": "zq9xsxg01n4cr" + "id": "thx33vvuk5gyo" } }, - "type": { + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request", "x-stoplight": { - "id": "plrs8n0348nq8" - }, - "type": "string", - "enum": [ - "bcm", - "sdlXliff" - ] + "id": "qmx22fog888cz" + } + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "7djywbuahg9ha" + } + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-request", + "x-stoplight": { + "id": "ygnao3kecn7hc" + } } } }, - "pricing-model": { - "title": "Pricing Model", + "project-template-update-request": { + "title": "Project Template Update Request", + "x-stoplight": { + "id": "udaysucy7sgy4" + }, "type": "object", - "description": "Pricing Model resource. (Not available for List Projects endpoint)", + "description": "Input for Project Template creation.", "properties": { - "id": { - "type": "string", - "description": "The pricing model identifier." - }, "name": { "type": "string", - "description": "The name of the Pricing Model. " + "description": "The project template name.", + "minLength": 1, + "maxLength": 100 }, "description": { "type": "string", - "description": "The description of the Pricing Model. ", - "x-stoplight": { - "id": "ip7d3npquqhtm" - } + "description": "The project description.", + "maxLength": 1000 }, - "currencyCode": { - "type": "string", - "description": "
default
The currency code (ISO 4217).
", - "x-default-field": true + "fileProcessingConfiguration": { + "$ref": "#/components/schemas/configuration-resource-request" }, - "location": { - "$ref": "#/components/schemas/folder-v2", - "x-default-field": true + "projectManagers": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-manager-request" + } }, - "languageDirectionPricing": { + "scheduleTemplate": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "languageDirections": { "type": "array", + "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", "items": { - "$ref": "#/components/schemas/language-price", - "x-stoplight": { - "id": "iulcrkpbt2dkl" - } + "$ref": "#/components/schemas/language-direction-request" } }, - "additionalCosts": { + "customFields": { "type": "array", "items": { - "$ref": "#/components/schemas/additional-cost", - "x-stoplight": { - "id": "8mgl2ge6it23h" - } + "$ref": "#/components/schemas/custom-field-request" } - } - }, - "required": [ - "id", - "name" - ] - }, - "project-pricing-model-update-request": { - "title": "Update project pricing model request", - "type": "object", - "required": [ - "id" - ], - "properties": { - "id": { - "type": "string", - "description": "The pricing model identifier." }, - "strategy": { - "type": "string", - "description": "\"copy\": A copy of the resource will be used for the project execution. This is the default strategy.\n\n\"use\": The actual resource will be used for the project execution.", - "default": "copy", - "enum": [ - "copy", - "use" - ] + "translationEngine": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "pricingModel": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "workflow": { + "$ref": "#/components/schemas/configuration-resource-request" + }, + "settings": { + "$ref": "#/components/schemas/project-template-settings-update-request" } } }, - "project": { - "title": "Project", + "project-template-response": { + "title": "Project Template", + "x-stoplight": { + "id": "f513d3d83fd5d" + }, "type": "object", - "description": "Project resource.", + "description": "Project Template resource. (Not available for List Projects endpoint)", "required": [ "id" ], "properties": { "id": { "type": "string", - "description": "The project identifier." - }, - "shortId": { - "type": "string", - "description": "The short identifier of the project." + "description": "The project template identifier." }, "name": { "type": "string", - "description": "
default
The project name.
", + "description": "
default
The project template name.
", "x-default-field": true }, "description": { "type": "string", - "description": "The project description." - }, - "dueBy": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The project due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time", - "nullable": true - }, - "deliveredBy": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": " UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time", - "nullable": true, - "x-stoplight": { - "id": "xxmhjuc5d6ohd" - } - }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The project's creation date and time.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time", - "nullable": true - }, - "status": { - "type": "string", - "description": "The project's status.", - "enum": [ - "created", - "inProgress", - "completed", - "archived" - ], - "nullable": true - }, - "statusHistory": { - "type": "array", - "description": "The project's status history.", - "nullable": true, - "items": { - "$ref": "#/components/schemas/project-status-history" - } + "description": "The project template description." }, "languageDirections": { "type": "array", - "description": "
default
The project's language directions.
", - "x-default-field": true, "items": { - "$ref": "#/components/schemas/language-direction" + "$ref": "#/components/schemas/language-direction-no-statistics" } }, - "customer": { - "$ref": "#/components/schemas/customer" - }, - "createdBy": { - "$ref": "#/components/schemas/user" - }, "location": { - "$ref": "#/components/schemas/folder-v2", - "description": "
default
The resource folder.
", - "x-default-field": true - }, - "projectTemplate": { - "$ref": "#/components/schemas/project-template-response" + "$ref": "#/components/schemas/folder-v2" }, "translationEngine": { "$ref": "#/components/schemas/translation-engine" @@ -20666,37 +23672,17 @@ "workflow": { "$ref": "#/components/schemas/workflow" }, - "projectPlan": { - "$ref": "#/components/schemas/project-plan" - }, - "analytics": { - "$ref": "#/components/schemas/analytics" - }, - "analysisStatistics": { - "$ref": "#/components/schemas/analysis-statistics" - }, - "quote": { - "$ref": "#/components/schemas/quote" - }, "customFields": { "type": "array", - "description": "The Custom Fields", + "description": "The Custom Fields.", "items": { "$ref": "#/components/schemas/custom-field" } }, - "tqaProfile": { - "$ref": "#/components/schemas/tqa-profile" - }, "forceOnline": { "type": "boolean", - "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." - }, - "quoteTemplate": { - "$ref": "#/components/schemas/project-quote-template" - }, - "projectGroup": { - "$ref": "#/components/schemas/project-group" + "description": "(Deprecated) Moved under settings.general.forceOnline", + "deprecated": true }, "projectManagers": { "type": "array", @@ -20704,1074 +23690,1490 @@ "$ref": "#/components/schemas/project-manager-response" } }, + "quoteTemplate": { + "$ref": "#/components/schemas/project-quote-template-deprecated" + }, "scheduleTemplate": { "$ref": "#/components/schemas/schedule-template", "x-stoplight": { - "id": "dsvy1i7nqqv3z" - } - }, - "perfectMatchMapping": { - "$ref": "#/components/schemas/perfect-match-mapping-simple-response", - "x-stoplight": { - "id": "15ak4sadvjb89" + "id": "anjnnapb4ow78" } }, "settings": { - "$ref": "#/components/schemas/project-settings-response", + "$ref": "#/components/schemas/project-template-settings-response", "x-stoplight": { - "id": "k0yk2u3skecpf" + "id": "s2h6ypp5yywjr" } } } }, - "project-create-request": { - "title": "Project Create Request", + "project-template-settings-request": { + "title": "Project Template Settings", + "x-stoplight": { + "id": "188a054a839d7" + }, "type": "object", - "description": "Input for Project creation.\n\nBefore starting the project, the required configuration resources (translation engine, file processing configuration and workflow) should be set either explicitly or through a project template that contains references to these configuration resources.", - "required": [ - "name", - "dueBy", - "languageDirections", - "location" - ], + "description": "Input for Project Template settings.", "properties": { - "name": { - "type": "string", - "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "minLength": 1, - "maxLength": 100 + "general": { + "$ref": "#/components/schemas/project-template-general-settings-request" }, - "description": { - "type": "string", - "description": "The project description.", - "maxLength": 1000 + "qualityManagement": { + "$ref": "#/components/schemas/project-template-quality-management-settings" + } + } + }, + "project-template-settings-update-request": { + "title": "Project Template Settings", + "x-stoplight": { + "id": "dn5d77vdz1lvw" + }, + "type": "object", + "description": "Input for Project Template settings.", + "properties": { + "general": { + "$ref": "#/components/schemas/project-template-general-settings-update" }, - "dueBy": { - "$ref": "#/components/schemas/date-time" + "qualityManagement": { + "$ref": "#/components/schemas/project-template-quality-management-settings" + } + } + }, + "project-template-settings-response": { + "title": "Project Template Settings", + "x-stoplight": { + "id": "rfvf2oks12otx" + }, + "type": "object", + "description": "Project Template settings. See detailed description of options on the Official Documentation page. \n\r (Not available for List Projects/ProjectTemplates endpoint)", + "properties": { + "general": { + "$ref": "#/components/schemas/project-template-general-settings-response", + "x-default-field": true, + "description": "
default
General settings, are detailed in section 10.a
" }, - "projectTemplate": { - "$ref": "#/components/schemas/object-id-request" + "batchTasks": { + "$ref": "#/components/schemas/project-template-batch-tasks-settings" }, - "languageDirections": { - "type": "array", - "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", - "items": { - "$ref": "#/components/schemas/language-direction-request" + "verification": { + "$ref": "#/components/schemas/project-template-verification-settings" + }, + "qualityManagement": { + "$ref": "#/components/schemas/project-template-quality-management-settings-response" + }, + "translationMemorySettings": { + "$ref": "#/components/schemas/project-template-translation-memory-settings" + } + } + }, + "project-template-general-settings-request": { + "title": "General settings", + "x-stoplight": { + "id": "96ba14884fdf8" + }, + "type": "object", + "description": "General settings", + "properties": { + "forceOnline": { + "type": "boolean", + "x-stoplight": { + "id": "dya48eul3lslu" + }, + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", + "default": false + }, + "quoteTemplate": { + "$ref": "#/components/schemas/configuration-resource-request", + "x-stoplight": { + "id": "0l9y1waovurvh" } }, - "location": { - "type": "string", - "description": "The folder identifier where the project should be created." + "customerPortalVisibility": { + "type": "boolean", + "x-stoplight": { + "id": "76vxoxivbrgmb" + }, + "description": "Customer Portal visibility", + "default": true }, - "translationEngine": { - "$ref": "#/components/schemas/configuration-resource-request" + "completionConfiguration": { + "$ref": "#/components/schemas/completion-config-request" + } + } + }, + "project-template-general-settings-update": { + "title": "General settings", + "x-stoplight": { + "id": "qjkldydwydntm" + }, + "type": "object", + "description": "General settings", + "properties": { + "forceOnline": { + "type": "boolean", + "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", + "default": false }, - "fileProcessingConfiguration": { + "quoteTemplate": { "$ref": "#/components/schemas/configuration-resource-request" }, - "workflow": { - "$ref": "#/components/schemas/configuration-resource-request" + "customerPortalVisibility": { + "type": "boolean", + "description": "Customer Portal visibility", + "default": true }, - "pricingModel": { - "$ref": "#/components/schemas/configuration-resource-request" + "completionConfiguration": { + "$ref": "#/components/schemas/completion-config-request", + "x-stoplight": { + "id": "zkvabfvamhyoj" + } + } + } + }, + "project-template-general-settings-response": { + "title": "General settings", + "x-stoplight": { + "id": "d6p1yr5skykdb" + }, + "type": "object", + "description": "General settings, are detailed in section 10.a", + "properties": { + "forceOnline": { + "type": "boolean", + "description": "
default
Restrict file downloads.", + "x-default-field": true, + "default": false + }, + "allowSourceEdit": { + "type": "boolean", + "description": "
default
Allow editing of source text in segments.", + "x-default-field": true, + "default": false + }, + "quoteTemplate": { + "$ref": "#/components/schemas/project-quote-template", + "x-default-field": true, + "description": "
default
" + }, + "customerPortalVisibility": { + "type": "boolean", + "description": "
default
Customer Portal visibility", + "x-default-field": true, + "default": true + }, + "completionConfiguration": { + "$ref": "#/components/schemas/completion-config-request", + "x-stoplight": { + "id": "z9j2lhijfy67v" + }, + "description": "
default
\r\n" + } + } + }, + "project-template-batch-tasks-settings": { + "title": "Project Template Batch Tasks Settings", + "type": "object", + "description": "Project Template Batch Tasks Settings", + "properties": { + "preProcessing": { + "$ref": "#/components/schemas/project-template-batch-tasks-preprocessing-settings", + "x-default-field": true, + "x-stoplight": { + "id": "fd9mooc8in0k8" + }, + "description": "
default
Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b
" }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-field-request" - } + "updateTranslationMemory": { + "$ref": "#/components/schemas/update-translation-memory-settings", + "x-default-field": true, + "x-stoplight": { + "id": "mm94ig682wabo" + }, + "description": "
default
Configure how TMs are updated throughout the project workflow depending on the status of the segments. Are detailed in section 10.c
" + } + } + }, + "project-template-verification-settings": { + "title": "Project Template Verification Settings", + "type": "object", + "description": "", + "properties": { + "tagVerifier": { + "$ref": "#/components/schemas/project-template-verification-tag-verifier-settings", + "x-default-field": true, + "description": "
default
Tag Verifier Settings, are detailed in section 10.d
" }, + "qaChecker": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-settings", + "x-default-field": true, + "description": "
default
QA Checker Settings, are detailed in section 10.e
" + } + } + }, + "project-template-quality-management-settings": { + "title": "Quality Managment", + "type": "object", + "properties": { "tqaProfile": { - "$ref": "#/components/schemas/configuration-resource-request" - }, - "forceOnline": { - "type": "boolean", - "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively." - }, - "projectManagers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-manager-request" - } - }, - "scheduleTemplate": { - "$ref": "#/components/schemas/configuration-resource-request" - }, - "settings": { - "$ref": "#/components/schemas/project-settings-request", + "$ref": "#/components/schemas/configuration-resource-request", "x-stoplight": { - "id": "53re0us2no8zk" + "id": "9n13w0ndmh8tv" } } } }, - "project-configuration": { - "title": "Project Configuration", + "project-template-quality-management-settings-response": { + "title": "Quality Managment", "x-stoplight": { - "id": "qx05l6h0joh9h" + "id": "a5bkdzgg7q3eh" }, - "description": "The configuration settings for a project.", "type": "object", "properties": { - "translationMemoryFields": { - "$ref": "#/components/schemas/translation-memory-fields", - "description": "
default
", - "x-default-field": true - }, - "updateTranslationMemory": { - "$ref": "#/components/schemas/update-translation-memory", + "tqaProfile": { + "$ref": "#/components/schemas/tqa-profile", "x-stoplight": { - "id": "akhqz2lu4ks2b" + "id": "ln71gs3m3v6lo" } } } }, - "project-configuration-request": { - "title": "Project Configuration Request", + "project-template-translation-memory-settings": { + "title": "Translation Memory settings", "x-stoplight": { - "id": "5ivmv9i754acq" + "id": "f358c4e03ac33" }, "type": "object", - "description": "A request used to update the configuration settings for a project.", + "description": "Translation Memory settings", "properties": { - "translationMemoryFieldsSettings": { - "$ref": "#/components/schemas/translation-memory-fields-update-request" - }, - "updateTranslationMemory": { - "$ref": "#/components/schemas/update-translation-memory", - "x-stoplight": { - "id": "zx6orwsjfd51g" - } - }, - "perfectMatchMappingId": { - "type": "string", - "x-stoplight": { - "id": "84cmud84h1lf6" - }, - "description": "The PerfectMatch mapping to be associated with the project." + "penalties": { + "$ref": "#/components/schemas/project-template-TM-penalties", + "description": "
default
" } } }, - "project-group": { - "title": "Project Group", + "project-template-batch-tasks-preprocessing-settings": { + "title": "Pre-Processing Settings", + "x-stoplight": { + "id": "3dzxuz1skn1pl" + }, "type": "object", - "description": "Project Group resource. (Not available for List Projects endpoint)", + "description": "Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b", "properties": { - "id": { - "type": "string", - "description": "The project group identifier." - }, - "shortId": { - "type": "string", - "description": "The short identifier of the project group." - }, - "name": { - "type": "string", - "description": "
default
The project group name.
", + "minimumMatchValue": { + "type": "integer", + "minimum": 50, + "maximum": 100, + "default": 70, + "description": "
default
", "x-default-field": true }, - "description": { - "type": "string", - "description": "The project group description." - }, - "status": { - "type": "string", - "description": "The status of the projects in the project group.\n\n- `new`: the group is new created, or all projects in the group have status New\n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have status Completed\n\n- `deleting`: the group is getting deleted and the projects are removing from it", + "translationOverwriteMode": { "enum": [ - "new", - "inProgress", - "completed", - "deleting" - ] + "keepExisting", + "overwriteIfBetter", + "overwriteAlways", + "overwriteExceptPerfectMatch" + ], + "description": "
default
Options: \r\n- `keepExisting`: no segments are overwritten, existing segments are kept;\r\n- `overwriteIfBetter`: unlocked segments (including confirmed segments) are overwritten, while unlocked PerfectMatch segments and locked segments are not overwritten; \r\n- `overwriteAlways`: PerfectMatch segments (both locked and unlocked) are overwritten, while other locked segments are not overwritten;\r\n- `overwriteExceptPerfectMatch`: unlocked segments (including confirmed segments) and locked segments are overwritten, while unlocked PerfectMatch segments are not overwritten;
", + "x-default-field": true, + "default": "overwriteIfBetter" }, - "projects": { + "afterApplyingTranslations": { "type": "array", - "description": "The projects in the project group.", + "x-default-field": true, + "description": "
default
Default: `confirmExactMatches`, `confirmContextMatches`
", "items": { - "$ref": "#/components/schemas/project-group-project" + "enum": [ + "confirmExactMatches", + "confirmContextMatches", + "lockExactMatches", + "lockContextMatches", + "lockGreenSegments", + "lockAmberSegments", + "lockRedSegments" + ], + "default": "confirmContextMatches" } }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "noMatchFoundAction": { + "enum": [ + "leaveTargetSegmentsEmpty", + "copySourceToTarget" + ], + "description": "
default
", + "x-default-field": true, + "default": "leaveTargetSegmentsEmpty" }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", - "format": "date-time" + "reportCrossFileRepetition": { + "type": "boolean", + "default": false, + "description": "If enabled repetitions are identified and included in analysis reports." }, - "lastModifiedAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time" + "excludeLockedSegments": { + "type": "boolean", + "default": false, + "description": "If enabled locked segments (content that must not be translated) are excluded from translation. " } - }, - "required": [ - "id" - ] + } }, - "project-group-create-response": { - "title": "Project Group Create Response", + "project-template-verification-tag-verifier-settings": { + "title": "Tag Verifier Settings", "type": "object", - "description": "The Project Group Create response. ", + "description": "Tag Verifier Settings, are detailed in section 10.d", "properties": { - "id": { - "type": "string", - "description": "The project group identifier." + "enabled": { + "type": "boolean", + "x-stoplight": { + "id": "zzdaica4ipzsl" + } + }, + "checkAddedTags": { + "type": "boolean", + "x-stoplight": { + "id": "7jxj0g9hrjxdd" + }, + "x-default-field": true, + "default": true, + "description": "
default
" + }, + "addedTagsSeverity": { + "x-stoplight": { + "id": "ceijjmhck9qpn" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" + }, + "checkDeletedTags": { + "type": "boolean", + "x-stoplight": { + "id": "rw3qbpbox585c" + }, + "x-default-field": true, + "default": true, + "description": "
default
" + }, + "deletedTagsSeverity": { + "x-stoplight": { + "id": "v1367u510xuxk" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" + }, + "checkTagOrderChanged": { + "type": "boolean", + "x-stoplight": { + "id": "ug2e4khwq9yjn" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "name": { - "type": "string", - "description": "The project group name." + "tagOrderChangedSeverity": { + "x-stoplight": { + "id": "61mcttvp5oynd" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "description": { - "type": "string", - "description": "The project group description." + "checkSpacingAroundTags": { + "type": "boolean", + "x-stoplight": { + "id": "vje5xtur0mstq" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "status": { - "type": "string", - "description": "The status of the projects in the project group.\n\n- `new`: the group is newly created, or all the projects in the group have the \"New\" status \n\n- `inProgress`: at least one project in the group is in progress\n\n- `completed`: all projects in the group have the \"Completed\" status \n\n- `deleting`: the group is being deleted and the projects will be removed", + "spaceAroundTagsSeverity": { + "x-stoplight": { + "id": "a8nhawfmukkbc" + }, "enum": [ - "new", - "inProgress", - "completed", - "deleting" - ] - }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "error", + "warning", + "note" + ], + "default": "note" }, - "shortId": { - "type": "string", + "ignoreFormattingTags": { + "type": "boolean", "x-stoplight": { - "id": "g72simvju3z9z" - } + "id": "ucwul9whydkkk" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time" + "ignoreLockedSegments": { + "type": "boolean", + "x-stoplight": { + "id": "votezrhazpcr8" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "lastModifiedAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the project group was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "format": "date-time" + "ignoreDifferenceBetweenNormalAndNonBreakingSpace": { + "type": "boolean", + "x-stoplight": { + "id": "2tutxpylevgp5" + }, + "x-default-field": true, + "default": true, + "description": "
default
" } }, "required": [ - "id" + "enabled" ] }, - "project-group-project": { - "title": "Project Group Project", + "project-template-verification-qa-checker-settings": { + "title": "QA checker", "type": "object", - "description": "Project resource for project group.", + "description": "QA Checker Settings, are detailed in section 10.e", "properties": { - "id": { - "type": "string", - "description": "The project identifier." + "enabled": { + "type": "boolean", + "x-stoplight": { + "id": "ht01a321btv9x" + }, + "default": true }, - "status": { - "type": "string", - "description": "The project's status.", - "enum": [ - "attaching", - "attached", - "detaching", - "updating", - "failed" - ] + "allLanguages": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-all-languages", + "x-stoplight": { + "id": "v2h7hwcxscvdm" + }, + "x-default-field": true, + "description": "
default
" + }, + "perTargetLanguage": { + "type": "array", + "x-stoplight": { + "id": "doi99m8k1nucn" + }, + "items": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-per-target-language", + "x-stoplight": { + "id": "pt6p63qkx37fh" + } + } } }, "required": [ - "id" - ], - "x-stoplight": { - "id": "kia482tzj55ou" - } + "enabled" + ] }, - "project-group-project-request": { - "title": "Project Group Project Request", + "project-template-verification-qa-checker-all-languages": { + "title": "All Languages settings", "x-stoplight": { - "id": "abqotabie1tzm" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "A project id." - } + "id": "u7dex87q8i5am" }, - "required": [ - "id" - ] - }, - "project-group-create-request": { - "title": "Project Group Create Request", "type": "object", - "description": "Input for project group creation.", "properties": { - "name": { - "type": "string", - "description": "The project group name.\\\nMust be unique per location.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "minLength": 1, - "maxLength": 100 + "segmentsVerification": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-verification", + "x-stoplight": { + "id": "gxhqy9p1q87jg" + }, + "x-default-field": true, + "description": "
default
" }, - "description": { - "type": "string", - "description": "The project group description.", - "maxLength": 1000 + "segmentsToExclude": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-to-exclude", + "x-stoplight": { + "id": "z3drrdagwesm7" + }, + "x-default-field": true, + "description": "
default
" }, - "location": { - "type": "string", - "description": "The folder identifier where the project group should be created. If it isn't mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error. " - } - }, - "required": [ - "name" - ] - }, - "project-group-update-request": { - "title": "Project Group Update Request", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The project group name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "minLength": 1, - "maxLength": 100 + "inconsistencies": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-inconsistencies", + "x-default-field": true, + "description": "
default
" }, - "description": { - "type": "string", - "description": "The project group description.", - "maxLength": 1000 - } - } - }, - "project-manager-request": { - "title": "Project Manager Request", - "x-stoplight": { - "id": "6j883j92igshf" - }, - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "Depending on the type, User identifier or Group identifier." + "punctuation": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", + "x-stoplight": { + "id": "ps49964fkhoes" + }, + "x-default-field": true, + "description": "
default
" }, - "type": { - "type": "string", - "enum": [ - "group", - "user" - ] - } - }, - "required": [ - "id", - "type" - ] - }, - "project-manager-response": { - "title": "Project Manager Response", - "x-stoplight": { - "id": "jpzqsh6pvehw6" - }, - "type": "object", - "description": "", - "properties": { - "type": { - "type": "string", - "enum": [ - "group", - "user" - ] + "numbers": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", + "x-stoplight": { + "id": "0uo9yg9qgw90j" + }, + "x-default-field": true, + "description": "
default
" }, - "user": { - "$ref": "#/components/schemas/user" + "wordList": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", + "x-stoplight": { + "id": "j7c3kcgbk71ct" + }, + "x-default-field": true, + "description": "
default
" }, - "group": { - "$ref": "#/components/schemas/group" + "regularExpressions": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", + "x-stoplight": { + "id": "dedwuc8etbbew" + }, + "x-default-field": true, + "description": "
default
" + }, + "trademarkCheck": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-trademark-check", + "x-stoplight": { + "id": "f5jsh5byu5ncp" + }, + "x-default-field": true, + "description": "
default
" + }, + "lengthVerification": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-length-verification", + "x-stoplight": { + "id": "e0fx768sgm9t2" + }, + "x-default-field": true, + "description": "
default
" } } }, - "project-settings-request": { - "title": "Project Settings", + "project-template-verification-qa-checker-per-target-language": { + "title": "Per Language Settings", "x-stoplight": { - "id": "7hz2hdu01vw0w" + "id": "huunxvvs0cbps" }, "type": "object", "properties": { - "general": { - "$ref": "#/components/schemas/project-settings-general-request", + "targetLanguage": { "x-stoplight": { - "id": "uv85h82rgn4ao" - } + "id": "k7hb7dlfim7t9" + }, + "$ref": "#/components/schemas/language" + }, + "punctuation": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", + "x-default-field": true, + "description": "
default
" + }, + "numbers": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", + "x-default-field": true, + "description": "
default
" + }, + "wordList": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", + "x-default-field": true, + "description": "
default
" + }, + "regularExpressions": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", + "x-default-field": true, + "description": "
default
" } - } - }, - "project-settings-response": { - "title": "Project Settings", - "x-stoplight": { - "id": "79vl39jda1he7" }, - "type": "object", - "properties": { - "general": { - "$ref": "#/components/schemas/project-settings-general-response", - "description": "
default
\r\n" - } - } + "required": [ + "targetLanguage" + ] }, - "project-settings-general-request": { - "title": "Project General Settings", + "project-template-verification-qa-checker-segments-verification": { + "title": "Segments Verification", "x-stoplight": { - "id": "6dnig61u68hsr" + "id": "p5v3db4luaxqz" }, "type": "object", "properties": { - "completionConfiguration": { - "$ref": "#/components/schemas/completion-config-request", + "checkForgottenTranslation": { + "type": "boolean", + "default": true, "x-stoplight": { - "id": "k15wt6trvjgbt" - } - } - } - }, - "project-settings-general-response": { - "title": "Project General Settings", - "x-stoplight": { - "id": "v82ei22cerb0w" - }, - "type": "object", - "properties": { - "completionConfiguration": { - "$ref": "#/components/schemas/completion-config-response", - "description": "
default
" - } - } - }, - "project-update-request": { - "title": "Project Update Request", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The project name.\\\nUnsupported characters in the name: `\\` `/` `:` ` *` `?` `\"` `<` `>` `|`", - "minLength": 1, - "maxLength": 100 + "id": "xsjmebx726d3x" + }, + "x-default-field": true, + "description": "
default
" }, - "description": { - "type": "string", - "description": "The project description.", - "maxLength": 1000 + "forgottenTranslationSeverity": { + "x-stoplight": { + "id": "0jd2dz8tdy6br" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" }, - "dueBy": { - "$ref": "#/components/schemas/date-time" + "checkSourceTargetIdentical": { + "type": "boolean", + "x-stoplight": { + "id": "qmqj04ozi91bk" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "deliveredBy": { - "$ref": "#/components/schemas/date-time", + "sourceTargetIdenticalSeverity": { "x-stoplight": { - "id": "jlta5oi7fu3kf" + "id": "c907ccbq4vdxn" }, - "description": "Value used to automatically update dueBy of the project at the Customer Quote Approval step, if this step exists in the project workflow." + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "translationEngine": { - "$ref": "#/components/schemas/configuration-resource-request" + "identicalSegmentsIgnoreTags": { + "type": "boolean", + "x-stoplight": { + "id": "g30eue1qg70r7" + }, + "default": false }, - "fileProcessingConfiguration": { - "$ref": "#/components/schemas/configuration-resource-request" + "identicalSegmentsIgnoreCase": { + "type": "boolean", + "x-stoplight": { + "id": "ici43l9x3dxk1" + }, + "default": false }, - "pricingModel": { - "$ref": "#/components/schemas/configuration-resource-request", - "description": "Resource configuration properties. Pricing model can only be updated for projects that are not started." + "checkTargetLonger": { + "type": "boolean", + "x-stoplight": { + "id": "n80w5dcs09kxa" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "workflow": { - "$ref": "#/components/schemas/configuration-resource-request" + "longerByValue": { + "type": "number", + "x-stoplight": { + "id": "4j31z4qch04fg" + }, + "x-default-field": true, + "default": 50, + "description": "
default
" }, - "projectPlan": { - "$ref": "#/components/schemas/project-plan-update-request" + "checkTargetShorter": { + "type": "boolean", + "x-stoplight": { + "id": "hpzbjbr8t6zhx" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "tqaProfile": { - "$ref": "#/components/schemas/configuration-resource-request" + "shorterByValue": { + "type": "number", + "x-stoplight": { + "id": "6h9vfjna8ialu" + }, + "x-default-field": true, + "default": 50, + "description": "
default
" }, - "quote": { - "$ref": "#/components/schemas/quote-update-request" + "ignoreSegmentsFewerThanCount": { + "type": "number", + "x-stoplight": { + "id": "0y7rzdh9vmpvr" + }, + "x-default-field": true, + "default": 2, + "description": "
default
" }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-field-request" - } + "ignoreSegmentsFewerThanBase": { + "x-stoplight": { + "id": "17melvff79o5q" + }, + "enum": [ + "words", + "characters" + ], + "default": "characters", + "x-default-field": true, + "description": "
default
" + }, + "checkForbiddenChars": { + "type": "boolean", + "x-stoplight": { + "id": "l4ma0z3xj33q3" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "projectManagers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-manager-request" - } + "forbiddenChars": { + "type": "string", + "x-stoplight": { + "id": "wi6dozpt4rqaw" + }, + "x-default-field": true, + "description": "
default
" }, - "settings": { - "$ref": "#/components/schemas/project-settings-request", + "forbiddenCharsSeverity": { "x-stoplight": { - "id": "xd2b0b8qrxmfl" - } + "id": "widdgh98t4w1g" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" } } }, - "project-template-create-request": { - "title": "Project Template Create Request", + "project-template-verification-qa-checker-segments-to-exclude": { + "title": "Segments to Exclude", + "x-stoplight": { + "id": "1rb61vur5mzn3" + }, "type": "object", - "description": "Input for Project Template creation.", - "required": [ - "name", - "location", - "fileProcessingConfiguration" - ], "properties": { - "name": { - "type": "string", - "description": "The project template name.", - "minLength": 1, - "maxLength": 100 + "excludePerfectMatchSegments": { + "type": "boolean", + "default": true, + "x-stoplight": { + "id": "lns6fv1v15m9r" + }, + "x-default-field": true, + "description": "
default
" }, - "description": { - "type": "string", - "description": "The project description.", - "maxLength": 1000 + "excludeExactMatches": { + "type": "boolean", + "x-stoplight": { + "id": "hkmg7bvsderss" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "location": { - "type": "string", - "description": "The folder identifier where the project should be created." + "excludeFuzzyMatches": { + "type": "boolean", + "x-stoplight": { + "id": "40bzc9xgu79j6" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "fileProcessingConfiguration": { - "$ref": "#/components/schemas/configuration-resource-request", + "excludeFuzzyMatchesValue": { + "type": "number", "x-stoplight": { - "id": "uj8d2oyrr72tr" - } + "id": "6nb9cw19h7j8g" + }, + "x-default-field": true, + "default": 99, + "description": "
default
" }, - "projectManagers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-manager-request" - } + "excludeNewTranslation": { + "type": "boolean", + "x-stoplight": { + "id": "q9nay4my2ax0d" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "scheduleTemplate": { - "$ref": "#/components/schemas/configuration-resource-request", + "excludeConfirmedTranslations": { + "type": "boolean", "x-stoplight": { - "id": "rg3f3u9tenpfl" - } + "id": "5qr82fuljzh9c" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "languageDirections": { - "type": "array", - "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", - "items": { - "$ref": "#/components/schemas/language-direction-request" - } + "excludeLockedSegments": { + "type": "boolean", + "x-stoplight": { + "id": "zxvvu2p3el9vo" + }, + "x-default-field": true, + "description": "
default
" }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-field-request" - } + "excludeIdentical": { + "type": "boolean", + "x-stoplight": { + "id": "wt06ljmjtzxx1" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "translationEngine": { - "$ref": "#/components/schemas/configuration-resource-request", + "elementContextExclusion": { + "type": "boolean", "x-stoplight": { - "id": "thx33vvuk5gyo" - } + "id": "ihg0auk684zwo" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "pricingModel": { - "$ref": "#/components/schemas/configuration-resource-request", + "exclusionContextList": { + "type": "array", "x-stoplight": { - "id": "qmx22fog888cz" - } + "id": "w8wid64dh2ofd" + }, + "x-default-field": true, + "items": { + "x-stoplight": { + "id": "uold0rq8drd0g" + }, + "type": "string" + }, + "description": "
default
" }, - "workflow": { - "$ref": "#/components/schemas/configuration-resource-request", + "reportAllNonExcluded": { + "type": "boolean", "x-stoplight": { - "id": "7djywbuahg9ha" - } + "id": "two2plqqt9g76" + }, + "x-default-field": true, + "default": false, + "description": "
default
" }, - "settings": { - "$ref": "#/components/schemas/project-template-settings-request", + "reportAllNonExcludedSeverity": { "x-stoplight": { - "id": "ygnao3kecn7hc" - } + "id": "24w5oqpge9vtt" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "note" } } }, - "project-template-update-request": { - "title": "Project Template Update Request", + "project-template-verification-qa-checker-inconsistencies": { + "title": "QA Checker Inconsistencies", "x-stoplight": { - "id": "udaysucy7sgy4" + "id": "iosfg9dirb8hw" }, "type": "object", - "description": "Input for Project Template creation.", "properties": { - "name": { - "type": "string", - "description": "The project template name.", - "minLength": 1, - "maxLength": 100 + "checkInconsistentTranslations": { + "type": "boolean", + "default": false, + "x-default-field": true, + "description": "
default
" }, - "description": { - "type": "string", - "description": "The project description.", - "maxLength": 1000 + "checkInconsistentTranslationsSeverity": { + "x-stoplight": { + "id": "bsouwbxqv95ye" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "fileProcessingConfiguration": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkInconsistentTranslationsIgnoreTags": { + "type": "boolean", + "x-stoplight": { + "id": "3koq6k6fd9l44" + }, + "default": false }, - "projectManagers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-manager-request" - } + "checkInconsistentTranslationsIgnoreCase": { + "type": "boolean", + "x-stoplight": { + "id": "6cmbn8w6k7fg4" + }, + "default": false + }, + "checkRepeatedWords": { + "type": "boolean", + "x-stoplight": { + "id": "57vj6px0vfsie" + }, + "x-default-field": true, + "default": true, + "description": "
default
" + }, + "checkRepeatedWordsSeverity": { + "x-stoplight": { + "id": "72j1swplvu10s" + }, + "enum": [ + "error", + "warning", + " Note" + ], + "default": "warning" }, - "scheduleTemplate": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkRepeatedWordsIgnoreNumbers": { + "type": "boolean", + "x-stoplight": { + "id": "h48hxx4si6aoh" + }, + "default": false }, - "languageDirections": { - "type": "array", - "description": "The language directions.\n\nWhen creating a project using a project template that supports multiple source languages, you must supply the `languageDirections`.
Note: The values for source and targe language must have the same value as the source and target language from project template.", - "items": { - "$ref": "#/components/schemas/language-direction-request" - } + "checkRepeatedWordsIgnoreCase": { + "type": "boolean", + "x-stoplight": { + "id": "0pjpiv5gt6y7k" + }, + "default": false }, - "customFields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-field-request" - } + "checkUneditedSegmentsFuzzy": { + "x-stoplight": { + "id": "t9fk4h0hrr5co" + }, + "type": "boolean", + "x-default-field": true, + "default": true, + "description": "
default
" }, - "translationEngine": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkUneditedSegmentsFuzzySeverity": { + "x-stoplight": { + "id": "ry42m8y5j21he" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "pricingModel": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkOnlyConfirmedSegments": { + "type": "boolean", + "x-stoplight": { + "id": "ng703myrxolr9" + }, + "default": false }, - "workflow": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkIfMatchScoresBelow": { + "type": "boolean", + "x-stoplight": { + "id": "i05vug43v8q0w" + }, + "default": false }, - "settings": { - "$ref": "#/components/schemas/project-template-settings-update-request" + "checkIfMatchScoresBelowValue": { + "type": "number", + "default": 99 } } }, - "project-template-response": { - "title": "Project Template", + "project-template-verification-qa-checker-punctuation": { + "title": "QA Checker Punctuation", "x-stoplight": { - "id": "f513d3d83fd5d" + "id": "9sidt6n9cxt5y" }, "type": "object", - "description": "Project Template resource. (Not available for List Projects endpoint)", - "required": [ - "id" - ], "properties": { - "id": { - "type": "string", - "description": "The project template identifier." - }, - "name": { - "type": "string", - "description": "
default
The project template name.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "The project template description." - }, - "languageDirections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/language-direction-no-statistics" - } - }, - "location": { - "$ref": "#/components/schemas/folder-v2" - }, - "translationEngine": { - "$ref": "#/components/schemas/translation-engine" - }, - "fileProcessingConfiguration": { - "$ref": "#/components/schemas/file-processing-configuration" - }, - "pricingModel": { - "$ref": "#/components/schemas/pricing-model" - }, - "workflow": { - "$ref": "#/components/schemas/workflow" + "checkIdenticalPunctuation": { + "type": "boolean", + "default": true, + "x-default-field": true, + "x-stoplight": { + "id": "fvt9f95rf0uen" + }, + "description": "
default
" }, - "customFields": { - "type": "array", - "description": "The Custom Fields.", - "items": { - "$ref": "#/components/schemas/custom-field" - } + "checkIdenticalPunctuationSeverity": { + "x-stoplight": { + "id": "1fcl96sxrs5wx" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "forceOnline": { + "checkSpanishPunctuation": { + "x-stoplight": { + "id": "7fnmgzkao3fxi" + }, + "x-default-field": true, + "default": false, "type": "boolean", - "description": "(Deprecated) Moved under settings.general.forceOnline", - "deprecated": true + "description": "
default
" }, - "projectManagers": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-manager-response" - } + "checkSpanishPunctuationSeverity": { + "x-stoplight": { + "id": "f0umcr7ywjnsf" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "quoteTemplate": { - "$ref": "#/components/schemas/project-quote-template-deprecated" + "checkUnintentionalSpacesBeforePunctuation": { + "type": "boolean", + "x-stoplight": { + "id": "4wnyw10rl8k1m" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "scheduleTemplate": { - "$ref": "#/components/schemas/schedule-template", + "checkUnintentionalSpacesBeforePunctuationSeverity": { "x-stoplight": { - "id": "anjnnapb4ow78" - } + "id": "9up0q78jlw73a" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "settings": { - "$ref": "#/components/schemas/project-template-settings-response", + "checkUnintentionalSpacesBeforePunctuationValues": { + "type": "string", "x-stoplight": { - "id": "s2h6ypp5yywjr" - } - } - } - }, - "project-template-settings-request": { - "title": "Project Template Settings", - "x-stoplight": { - "id": "188a054a839d7" - }, - "type": "object", - "description": "Input for Project Template settings.", - "properties": { - "general": { - "$ref": "#/components/schemas/project-template-general-settings-request" + "id": "bukb4vmlo01si" + }, + "default": ":!?;" }, - "qualityManagement": { - "$ref": "#/components/schemas/project-template-quality-management-settings" - } - } - }, - "project-template-settings-update-request": { - "title": "Project Template Settings", - "x-stoplight": { - "id": "dn5d77vdz1lvw" - }, - "type": "object", - "description": "Input for Project Template settings.", - "properties": { - "general": { - "$ref": "#/components/schemas/project-template-general-settings-update" + "punctuationSpacesFrench": { + "type": "boolean", + "x-stoplight": { + "id": "n2amwff6y1fru" + }, + "default": false }, - "qualityManagement": { - "$ref": "#/components/schemas/project-template-quality-management-settings" - } - } - }, - "project-template-settings-response": { - "title": "Project Template Settings", - "x-stoplight": { - "id": "rfvf2oks12otx" - }, - "type": "object", - "description": "Project Template settings. See detailed description of options on the Official Documentation page. \n\r (Not available for List Projects/ProjectTemplates endpoint)", - "properties": { - "general": { - "$ref": "#/components/schemas/project-template-general-settings-response", + "checkMultipleSpaces": { + "type": "boolean", + "x-stoplight": { + "id": "371vnwmqt53uv" + }, "x-default-field": true, - "description": "
default
General settings, are detailed in section 10.a
" + "default": true, + "description": "
default
" + }, + "checkMultipleSpacesSeverity": { + "x-stoplight": { + "id": "z1snyx22cm8kp" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "note" }, - "batchTasks": { - "$ref": "#/components/schemas/project-template-batch-tasks-settings" + "checkMultipleDots": { + "type": "boolean", + "x-stoplight": { + "id": "wxxvehvri3o8q" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "verification": { - "$ref": "#/components/schemas/project-template-verification-settings" + "checkMultipleDotsSeverity": { + "x-stoplight": { + "id": "s3nerdbtbe17i" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "note" }, - "qualityManagement": { - "$ref": "#/components/schemas/project-template-quality-management-settings-response" + "ignoreThreeDots": { + "type": "boolean", + "x-stoplight": { + "id": "128751e5f7bb0" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "translationMemorySettings": { - "$ref": "#/components/schemas/project-template-translation-memory-settings" - } - } - }, - "project-template-general-settings-request": { - "title": "General settings", - "x-stoplight": { - "id": "96ba14884fdf8" - }, - "type": "object", - "description": "General settings", - "properties": { - "forceOnline": { + "checkExtraSpace": { "type": "boolean", "x-stoplight": { - "id": "dya48eul3lslu" + "id": "rczo8oi443l7b" }, - "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", - "default": false + "x-default-field": true, + "default": true, + "description": "
default
" }, - "quoteTemplate": { - "$ref": "#/components/schemas/configuration-resource-request", + "checkExtraSpaceSeverity": { "x-stoplight": { - "id": "0l9y1waovurvh" - } + "id": "b9qsayeygu8d5" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "customerPortalVisibility": { + "checkCapitalizationOfInitials": { "type": "boolean", "x-stoplight": { - "id": "76vxoxivbrgmb" + "id": "94fhj5alcziax" }, - "description": "Customer Portal visibility", - "default": true + "x-default-field": true, + "default": false, + "description": "
default
" }, - "completionConfiguration": { - "$ref": "#/components/schemas/completion-config-request" - } - } - }, - "project-template-general-settings-update": { - "title": "General settings", - "x-stoplight": { - "id": "qjkldydwydntm" - }, - "type": "object", - "description": "General settings", - "properties": { - "forceOnline": { + "checkCapitalizationOfInitialsSeverity": { + "x-stoplight": { + "id": "btsm5s1bzz7aq" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" + }, + "checkConsistencyOfGlobalCapitalization": { + "x-stoplight": { + "id": "2b9wdh315dahs" + }, "type": "boolean", - "description": "This forces the project to be translated using the Trados Cloud Platform Online Editor exclusively.", - "default": false + "x-default-field": true, + "default": false, + "description": "
default
" }, - "quoteTemplate": { - "$ref": "#/components/schemas/configuration-resource-request" + "checkConsistencyOfGlobalCapitalizationSeverity": { + "x-stoplight": { + "id": "4eohngzh0e2bc" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" }, - "customerPortalVisibility": { + "checkBrackets": { "type": "boolean", - "description": "Customer Portal visibility", - "default": true + "x-stoplight": { + "id": "lw5s7boith817" + }, + "x-default-field": true, + "default": true, + "description": "
default
" }, - "completionConfiguration": { - "$ref": "#/components/schemas/completion-config-request", + "checkBracketsSeverity": { "x-stoplight": { - "id": "zkvabfvamhyoj" - } + "id": "f8rpatoa21n08" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" } } }, - "project-template-general-settings-response": { - "title": "General settings", + "project-template-verification-qa-checker-numbers": { + "title": "QA Checker Numbers", "x-stoplight": { - "id": "d6p1yr5skykdb" + "id": "95nv42e499dwi" }, "type": "object", - "description": "General settings, are detailed in section 10.a", "properties": { - "forceOnline": { + "checkNumbers": { "type": "boolean", - "description": "
default
Restrict file downloads.", + "default": false, "x-default-field": true, - "default": false + "x-stoplight": { + "id": "jmx3msjbemxdr" + }, + "description": "
default
" }, - "allowSourceEdit": { + "checkNumbersSeverity": { + "x-stoplight": { + "id": "05931rv7v34yd" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" + }, + "checkTimes": { "type": "boolean", - "description": "
default
Allow editing of source text in segments.", + "x-stoplight": { + "id": "yjnavlbjro7zn" + }, "x-default-field": true, - "default": false + "default": false, + "description": "
default
" }, - "quoteTemplate": { - "$ref": "#/components/schemas/project-quote-template", - "x-default-field": true, - "description": "
default
" + "checkTimesSeverity": { + "x-stoplight": { + "id": "p7a2a445i131t" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" }, - "customerPortalVisibility": { + "checkDates": { "type": "boolean", - "description": "
default
Customer Portal visibility", - "x-default-field": true, - "default": true - }, - "completionConfiguration": { - "$ref": "#/components/schemas/completion-config-request", "x-stoplight": { - "id": "z9j2lhijfy67v" + "id": "yccnoxkca39wp" }, - "description": "
default
\r\n" - } - } - }, - "project-template-batch-tasks-settings": { - "title": "Project Template Batch Tasks Settings", - "type": "object", - "description": "Project Template Batch Tasks Settings", - "properties": { - "preProcessing": { - "$ref": "#/components/schemas/project-template-batch-tasks-preprocessing-settings", "x-default-field": true, + "default": false, + "description": "
default
" + }, + "checkDatesSeverity": { "x-stoplight": { - "id": "fd9mooc8in0k8" + "id": "9e40z6bd9mv8q" }, - "description": "
default
Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b
" + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" }, - "updateTranslationMemory": { - "$ref": "#/components/schemas/update-translation-memory-settings", - "x-default-field": true, + "checkMeasurements": { + "type": "boolean", "x-stoplight": { - "id": "mm94ig682wabo" + "id": "9w2l7x89okahm" }, - "description": "
default
Configure how TMs are updated throughout the project workflow depending on the status of the segments. Are detailed in section 10.c
" - } - } - }, - "project-template-verification-settings": { - "title": "Project Template Verification Settings", - "type": "object", - "description": "", - "properties": { - "tagVerifier": { - "$ref": "#/components/schemas/project-template-verification-tag-verifier-settings", - "x-default-field": true, - "description": "
default
Tag Verifier Settings, are detailed in section 10.d
" - }, - "qaChecker": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-settings", "x-default-field": true, - "description": "
default
QA Checker Settings, are detailed in section 10.e
" - } - } - }, - "project-template-quality-management-settings": { - "title": "Quality Managment", - "type": "object", - "properties": { - "tqaProfile": { - "$ref": "#/components/schemas/configuration-resource-request", + "default": false, + "description": "
default
" + }, + "checkMeasurementsSeverity": { "x-stoplight": { - "id": "9n13w0ndmh8tv" - } + "id": "5isqhxzz365vq" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "error" } } }, - "project-template-quality-management-settings-response": { - "title": "Quality Managment", + "project-template-verification-qa-checker-word-list": { + "title": "QA Checker Word list", "x-stoplight": { - "id": "a5bkdzgg7q3eh" + "id": "jcu8333uzax64" }, "type": "object", "properties": { - "tqaProfile": { - "$ref": "#/components/schemas/tqa-profile", + "enabled": { + "type": "boolean", + "default": false, "x-stoplight": { - "id": "ln71gs3m3v6lo" + "id": "1i43kmdizt8f9" } + }, + "searchWholeWords": { + "type": "boolean", + "x-stoplight": { + "id": "mtexp5nafx5d4" + }, + "x-default-field": true, + "default": false, + "description": "
default
" + }, + "ignoreCase": { + "type": "boolean", + "x-stoplight": { + "id": "lw4spspstngjb" + }, + "x-default-field": true, + "default": false, + "description": "
default
" + }, + "checkWordListSeverity": { + "x-stoplight": { + "id": "4dxqub35774eb" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" + }, + "wordList": { + "type": "array", + "x-stoplight": { + "id": "rjn2ec0xqsm0k" + }, + "x-default-field": true, + "items": { + "x-stoplight": { + "id": "2rknpju6n8z56" + }, + "type": "object", + "properties": { + "wrongForm": { + "type": "string", + "x-stoplight": { + "id": "u9yi9ohufpdvp" + }, + "x-default-field": true + }, + "correctForm": { + "type": "string", + "x-stoplight": { + "id": "h4itahton32nl" + }, + "x-default-field": true + } + } + }, + "description": "
default
" } - } + }, + "required": [ + "enabled" + ] }, - "project-template-translation-memory-settings": { - "title": "Translation Memory settings", + "project-template-verification-qa-checker-regular-expressions": { + "title": "QA Checker Regular Expressions", "x-stoplight": { - "id": "f358c4e03ac33" + "id": "xem3u8m9wipd6" }, "type": "object", - "description": "Translation Memory settings", "properties": { - "penalties": { - "$ref": "#/components/schemas/project-template-TM-penalties", + "checkRegularExpressions": { + "type": "boolean", + "default": false, + "x-stoplight": { + "id": "83h1307cwqhw9" + }, + "description": "" + }, + "regularExpressionSeverity": { + "x-stoplight": { + "id": "xmi8dmu62uzi8" + }, + "enum": [ + "error", + "warning", + "note" + ], + "default": "warning" + }, + "regularExpressions": { + "type": "array", + "x-stoplight": { + "id": "6z45r3k1a1b4o" + }, + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions-model", + "x-stoplight": { + "id": "5e6hkwes4mo6a" + } + }, "description": "
default
" } - } + }, + "required": [ + "checkRegularExpressions" + ] }, - "project-template-batch-tasks-preprocessing-settings": { - "title": "Pre-Processing Settings", + "project-template-verification-qa-checker-regular-expressions-model": { + "title": "Regular Expressions Model", "x-stoplight": { - "id": "3dzxuz1skn1pl" + "id": "2rx3df3vczsr1" }, "type": "object", - "description": "Pre-Processing Settings, configure how TMs are applied, are detailed in section 10.b", "properties": { - "minimumMatchValue": { - "type": "integer", - "minimum": 50, - "maximum": 100, - "default": 70, - "description": "
default
", - "x-default-field": true - }, - "translationOverwriteMode": { - "enum": [ - "keepExisting", - "overwriteIfBetter", - "overwriteAlways", - "overwriteExceptPerfectMatch" - ], - "description": "
default
Options: \r\n- `keepExisting`: no segments are overwritten, existing segments are kept;\r\n- `overwriteIfBetter`: unlocked segments (including confirmed segments) are overwritten, while unlocked PerfectMatch segments and locked segments are not overwritten; \r\n- `overwriteAlways`: PerfectMatch segments (both locked and unlocked) are overwritten, while other locked segments are not overwritten;\r\n- `overwriteExceptPerfectMatch`: unlocked segments (including confirmed segments) and locked segments are overwritten, while unlocked PerfectMatch segments are not overwritten;
", + "description": { + "type": "string", + "x-stoplight": { + "id": "20v4paozpk91g" + }, "x-default-field": true, - "default": "overwriteIfBetter" + "description": "
default
" }, - "afterApplyingTranslations": { - "type": "array", + "regexSource": { + "x-stoplight": { + "id": "e9lfc0qm2td5k" + }, + "type": "string", "x-default-field": true, - "description": "
default
Default: `confirmExactMatches`, `confirmContextMatches`
", - "items": { - "enum": [ - "confirmExactMatches", - "confirmContextMatches", - "lockExactMatches", - "lockContextMatches", - "lockGreenSegments", - "lockAmberSegments", - "lockRedSegments" - ], - "default": "confirmContextMatches" - } + "description": "
default
" }, - "noMatchFoundAction": { - "enum": [ - "leaveTargetSegmentsEmpty", - "copySourceToTarget" - ], - "description": "
default
", + "regexTarget": { + "type": "string", + "x-stoplight": { + "id": "k7olv3yojvixm" + }, "x-default-field": true, - "default": "leaveTargetSegmentsEmpty" + "description": "
default
" }, - "reportCrossFileRepetition": { + "ignoreCase": { "type": "boolean", + "x-stoplight": { + "id": "21avhvnk4l142" + }, + "x-default-field": true, "default": false, - "description": "If enabled repetitions are identified and included in analysis reports." + "description": "
default
" }, - "excludeLockedSegments": { - "type": "boolean", - "default": false, - "description": "If enabled locked segments (content that must not be translated) are excluded from translation. " + "condition": { + "x-stoplight": { + "id": "nmhpp19inyk2n" + }, + "enum": [ + "targetAndSource", + "targetNotSource", + "sourceNotTarget", + "sourceOnly", + "targetOnly", + "differentCount", + "groupedTargetAndSource" + ], + "x-default-field": true, + "description": "
default
" } } }, - "project-template-verification-tag-verifier-settings": { - "title": "Tag Verifier Settings", + "project-template-verification-qa-checker-trademark-check": { + "title": "QA Checker Trademark check", + "x-stoplight": { + "id": "l65c655atolg3" + }, "type": "object", - "description": "Tag Verifier Settings, are detailed in section 10.d", "properties": { "enabled": { "type": "boolean", - "x-stoplight": { - "id": "zzdaica4ipzsl" - } - }, - "checkAddedTags": { - "type": "boolean", - "x-stoplight": { - "id": "7jxj0g9hrjxdd" - }, - "x-default-field": true, "default": true, - "description": "
default
" + "x-stoplight": { + "id": "hrisnih0vgd4w" + } }, - "addedTagsSeverity": { + "trademarkSeverity": { "x-stoplight": { - "id": "ceijjmhck9qpn" + "id": "dfa7w4qetxl2c" }, "enum": [ "error", @@ -21780,18 +25182,52 @@ ], "default": "error" }, - "checkDeletedTags": { - "type": "boolean", + "trademarkSymbols": { + "type": "array", "x-stoplight": { - "id": "rw3qbpbox585c" + "id": "i0um9xob8izp7" }, "x-default-field": true, + "items": { + "x-stoplight": { + "id": "d32mt39hj0fer" + }, + "type": "string" + }, + "default": [ + "®", + "©", + "™", + "(c)", + "(r)", + "(tm)" + ], + "description": "
default
" + } + }, + "required": [ + "enabled" + ] + }, + "project-template-verification-qa-checker-length-verification": { + "title": "QA Checker Length Verification", + "x-stoplight": { + "id": "ex9iomj4a786f" + }, + "type": "object", + "properties": { + "checkLengthLimitation": { + "type": "boolean", "default": true, + "x-default-field": true, + "x-stoplight": { + "id": "7bxsr6dzipk4m" + }, "description": "
default
" }, - "deletedTagsSeverity": { + "checkLengthLimitationSeverity": { "x-stoplight": { - "id": "v1367u510xuxk" + "id": "3wlsd7f20hftl" }, "enum": [ "error", @@ -21800,2402 +25236,2338 @@ ], "default": "error" }, - "checkTagOrderChanged": { - "type": "boolean", + "targetSegmentsVerificationType": { "x-stoplight": { - "id": "ug2e4khwq9yjn" + "id": "147n1oindvqf3" }, "x-default-field": true, - "default": true, + "enum": [ + "fileSpecificLimit", + "absoluteCharacterCount" + ], + "default": "fileSpecificLimit", "description": "
default
" }, - "tagOrderChangedSeverity": { + "absoluteCharCountValue": { + "type": "number", "x-stoplight": { - "id": "61mcttvp5oynd" + "id": "i88shddbsddjo" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "x-default-field": true, + "description": "
default
Used in case `targetSegmentsVerificationType = absoluteCharacterCount`
", + "default": 50 + } + } + }, + "project-template-TM-penalties": { + "title": "Translation Memory Penalties", + "type": "object", + "description": "Translation Memory Penalties", + "properties": { + "standardPenalties": { + "$ref": "#/components/schemas/project-template-TM-standard-penalties", + "description": "
default
", + "x-default-field": true, + "type": "object", + "x-stoplight": { + "id": "rx66lu3x78mvr" + } }, - "checkSpacingAroundTags": { - "type": "boolean", + "translationUnitStatusPenalties": { + "$ref": "#/components/schemas/project-template-TM-translation-unit-status-penalties", + "description": "
default
", + "x-default-field": true, + "type": "object", "x-stoplight": { - "id": "vje5xtur0mstq" + "id": "7g27gag166myh" + } + } + } + }, + "project-template-TM-standard-penalties": { + "title": "Translation Memory Standard Penalties", + "type": "object", + "description": "Translation Memory Standard Penalties", + "properties": { + "missingFormatting": { + "description": "
default
", + "x-default-field": true, + "x-stoplight": { + "id": "pdzeu7k11vkc4" }, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 1 + }, + "differentFormatting": { + "description": "
default
", "x-default-field": true, - "default": true, - "description": "
default
" + "x-stoplight": { + "id": "bspk3rj8xswag" + }, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 1 + }, + "multipleTranslations": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 1 + }, + "autoLocalization": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "textReplacement": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "alignment": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 1 + }, + "characterWidthDifference": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 1 + } + } + }, + "project-template-TM-translation-unit-status-penalties": { + "title": "Translation Memory Translation Unit Status Penalties", + "type": "object", + "description": "Translation Memory Translation Unit Status Penalties", + "properties": { + "translated": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "rejectedTranslation": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "approvedTranslation": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "rejectedSignOff": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "approvedSignOff": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "notTranslated": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + }, + "draft": { + "description": "
default
", + "x-default-field": true, + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0 + } + } + }, + "project-plan": { + "title": "Project Plan", + "type": "object", + "description": "The configurations of the tasks that will be created in the future.\n\nAvailable now directly after project creation, project does not need to be started to be populated. \n\n(Not available for List Projects endpoint)", + "properties": { + "taskConfigurations": { + "type": "array", + "items": { + "$ref": "#/components/schemas/project-plan-task-configuration" + } + } + } + }, + "project-plan-task-configuration": { + "title": "Project Plan Task Configuration", + "type": "object", + "description": "The configuration of a task that will be created in the future.", + "properties": { + "taskTemplate": { + "$ref": "#/components/schemas/object-id" }, - "spaceAroundTagsSeverity": { - "x-stoplight": { - "id": "a8nhawfmukkbc" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "note" + "scope": { + "$ref": "#/components/schemas/task-configuration-scope" }, - "ignoreFormattingTags": { - "type": "boolean", - "x-stoplight": { - "id": "ucwul9whydkkk" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-task-assignee" + } }, - "ignoreLockedSegments": { + "isSkipped": { "type": "boolean", - "x-stoplight": { - "id": "votezrhazpcr8" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "description": "
default
Specifies if the task will be skipped.
", + "nullable": true, + "x-default-field": true }, - "ignoreDifferenceBetweenNormalAndNonBreakingSpace": { - "type": "boolean", - "x-stoplight": { - "id": "2tutxpylevgp5" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "dueBy": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The due date of the future task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", + "nullable": true } }, "required": [ - "enabled" + "taskTemplate", + "scope" ] }, - "project-template-verification-qa-checker-settings": { - "title": "QA checker", + "project-plan-task-assignee-request": { + "title": "Project Plan Task Assignee Request", "type": "object", - "description": "QA Checker Settings, are detailed in section 10.e", "properties": { - "enabled": { - "type": "boolean", - "x-stoplight": { - "id": "ht01a321btv9x" - }, - "default": true - }, - "allLanguages": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-all-languages", - "x-stoplight": { - "id": "v2h7hwcxscvdm" - }, - "x-default-field": true, - "description": "
default
" + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator" + ] }, - "perTargetLanguage": { + "id": { + "type": "string", + "description": "The user, group or vendor identifier, depending on the type chosen. It is not required for `projectCreator`." + } + }, + "required": [ + "type" + ] + }, + "project-plan-update-request": { + "title": "Project Plan Update Request", + "type": "object", + "description": "Updates the configurations of the tasks that will be created in the future. \nFor example, you can change the assignee of the \"translation\" task while the project is in the \"preprocessing\" phase.", + "properties": { + "taskConfigurations": { "type": "array", - "x-stoplight": { - "id": "doi99m8k1nucn" - }, + "minItems": 1, "items": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-per-target-language", - "x-stoplight": { - "id": "pt6p63qkx37fh" - } + "$ref": "#/components/schemas/project-plan-task-configuration-request" } } }, "required": [ - "enabled" + "taskConfigurations" ] }, - "project-template-verification-qa-checker-all-languages": { - "title": "All Languages settings", - "x-stoplight": { - "id": "u7dex87q8i5am" + "project-plan-task-configuration-request": { + "title": "Project Plan Task Configuration Request", + "type": "object", + "description": "A project plan task configuration request. Used to update a task that will be created in the future.", + "properties": { + "taskTemplate": { + "$ref": "#/components/schemas/object-id-request" + }, + "isSkipped": { + "type": "boolean", + "description": "Specifies if the task will be skipped. \n If you want to skip all the target languages for the given task, set the scope as \"global\"." + }, + "assignees": { + "type": "array", + "description": "Specifies the list of assignees for the future task. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/project-plan-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + }, + "dueBy": { + "$ref": "#/components/schemas/date-time" + } }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "project-status-history": { + "title": "Project Status History Item", "type": "object", + "description": "An Item which describes a change in the status of the project.", "properties": { - "segmentsVerification": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-verification", - "x-stoplight": { - "id": "gxhqy9p1q87jg" - }, - "x-default-field": true, - "description": "
default
" + "from": { + "type": "string", + "description": "Specifies the project status previous to the change.", + "enum": [ + "none", + "created", + "inProgress", + "completed" + ] }, - "segmentsToExclude": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-segments-to-exclude", - "x-stoplight": { - "id": "z3drrdagwesm7" - }, - "x-default-field": true, - "description": "
default
" + "to": { + "type": "string", + "description": "Specifies the project status post change.", + "enum": [ + "created", + "inProgress", + "completed" + ] }, - "inconsistencies": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-inconsistencies", - "x-default-field": true, - "description": "
default
" + "by": { + "$ref": "#/components/schemas/user" }, - "punctuation": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", - "x-stoplight": { - "id": "ps49964fkhoes" - }, + "timestamp": { + "$ref": "#/components/schemas/date-time", "x-default-field": true, - "description": "
default
" + "description": "The time and date when the status history was updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + } + }, + "required": [ + "from", + "to" + ] + }, + "quote": { + "title": "Quote", + "type": "object", + "description": "Project quote.", + "properties": { + "totalAmount": { + "type": "number", + "description": "
default
Total translation fee.
", + "nullable": true, + "x-default-field": true }, - "numbers": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", - "x-stoplight": { - "id": "0uo9yg9qgw90j" - }, - "x-default-field": true, - "description": "
default
" + "currencyCode": { + "type": "string", + "description": "
default
The currency code (ISO 4217).
", + "x-default-field": true }, - "wordList": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", - "x-stoplight": { - "id": "j7c3kcgbk71ct" - }, - "x-default-field": true, - "description": "
default
" + "translationCosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quote-translation-cost" + } }, - "regularExpressions": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", - "x-stoplight": { - "id": "dedwuc8etbbew" - }, - "x-default-field": true, - "description": "
default
" + "languageCosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quote-language-cost" + } }, - "trademarkCheck": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-trademark-check", - "x-stoplight": { - "id": "f5jsh5byu5ncp" - }, - "x-default-field": true, - "description": "
default
" + "additionalCosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quote-additional-cost" + } }, - "lengthVerification": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-length-verification", + "notes": { + "type": "string", "x-stoplight": { - "id": "e0fx768sgm9t2" + "id": "n1ohftpten9bv" }, - "x-default-field": true, - "description": "
default
" + "description": "A message associated with the quote." } } }, - "project-template-verification-qa-checker-per-target-language": { - "title": "Per Language Settings", - "x-stoplight": { - "id": "huunxvvs0cbps" - }, + "quote-additional-cost": { + "title": "Quote Additional Cost", "type": "object", + "description": "Other extra fees not captured by translationCosts and languageCosts.", "properties": { - "targetLanguage": { - "x-stoplight": { - "id": "k7hb7dlfim7t9" - }, - "$ref": "#/components/schemas/language" + "name": { + "type": "string", + "description": "
default
The name of the additional cost.
" }, - "punctuation": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-punctuation", - "x-default-field": true, - "description": "
default
" + "count": { + "type": "number", + "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", + "nullable": true }, - "numbers": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-numbers", - "x-default-field": true, - "description": "
default
" + "total": { + "type": "number", + "description": "
default
The computed cost.
", + "nullable": true, + "x-default-field": true }, - "wordList": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-word-list", - "x-default-field": true, - "description": "
default
" + "cost": { + "type": "number", + "description": "The cost of a unit.", + "nullable": true }, - "regularExpressions": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions", - "x-default-field": true, - "description": "
default
" - } - }, - "required": [ - "targetLanguage" - ] - }, - "project-template-verification-qa-checker-segments-verification": { - "title": "Segments Verification", - "x-stoplight": { - "id": "p5v3db4luaxqz" - }, - "type": "object", - "properties": { - "checkForgottenTranslation": { - "type": "boolean", - "default": true, - "x-stoplight": { - "id": "xsjmebx726d3x" - }, - "x-default-field": true, - "description": "
default
" + "costType": { + "$ref": "#/components/schemas/project-cost-type", + "description": "The type of the additional cost." }, - "forgottenTranslationSeverity": { - "x-stoplight": { - "id": "0jd2dz8tdy6br" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as a reference for the unit cost." }, - "checkSourceTargetIdentical": { - "type": "boolean", - "x-stoplight": { - "id": "qmqj04ozi91bk" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "costOrder": { + "type": "integer", + "description": "Indicates the order in which the additional cost is computed.", + "nullable": true }, - "sourceTargetIdenticalSeverity": { - "x-stoplight": { - "id": "c907ccbq4vdxn" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Describes how the cost of type 'conditional' will be added to total cost." }, - "identicalSegmentsIgnoreTags": { - "type": "boolean", - "x-stoplight": { - "id": "g30eue1qg70r7" - }, - "default": false + "conditionalCostOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "The operator applied between the 'costVariable' and 'operand'." }, - "identicalSegmentsIgnoreCase": { - "type": "boolean", - "x-stoplight": { - "id": "ici43l9x3dxk1" - }, - "default": false + "conditionalCostVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'." }, - "checkTargetLonger": { - "type": "boolean", - "x-stoplight": { - "id": "n80w5dcs09kxa" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "conditionalCostThreshold": { + "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", + "type": "number", + "nullable": true }, - "longerByValue": { + "runningTotal": { "type": "number", - "x-stoplight": { - "id": "4j31z4qch04fg" - }, - "x-default-field": true, - "default": 50, - "description": "
default
" + "description": "The sum of all the previously computed costs.", + "nullable": true }, - "checkTargetShorter": { - "type": "boolean", + "customUnitName": { + "type": "string", "x-stoplight": { - "id": "hpzbjbr8t6zhx" + "id": "sh8ttf4ncbt4f" }, - "x-default-field": true, - "default": false, - "description": "
default
" + "description": "The name of the custom unit." + } + } + }, + "quote-additional-cost-request": { + "title": "Quote Additional Cost Request", + "type": "object", + "required": [ + "name", + "count", + "cost", + "costOrder", + "conditionalCostThreshold" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the additional cost." }, - "shorterByValue": { + "count": { "type": "number", - "x-stoplight": { - "id": "6h9vfjna8ialu" - }, - "x-default-field": true, - "default": 50, - "description": "
default
" + "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." }, - "ignoreSegmentsFewerThanCount": { + "cost": { "type": "number", - "x-stoplight": { - "id": "0y7rzdh9vmpvr" - }, - "x-default-field": true, - "default": 2, - "description": "
default
" + "description": "The cost of a unit." }, - "ignoreSegmentsFewerThanBase": { - "x-stoplight": { - "id": "17melvff79o5q" - }, - "enum": [ - "words", - "characters" - ], - "default": "characters", - "x-default-field": true, - "description": "
default
" + "costType": { + "$ref": "#/components/schemas/project-cost-type", + "description": "The type of the additional cost.", + "nullable": true }, - "checkForbiddenChars": { - "type": "boolean", - "x-stoplight": { - "id": "l4ma0z3xj33q3" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used for counting the units.", + "nullable": true }, - "forbiddenChars": { - "type": "string", - "x-stoplight": { - "id": "wi6dozpt4rqaw" - }, - "x-default-field": true, - "description": "
default
" + "costOrder": { + "type": "integer", + "description": "Indicates the order in which the additional cost is computed." }, - "forbiddenCharsSeverity": { - "x-stoplight": { - "id": "widdgh98t4w1g" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Describes how the cost of type 'conditional' will be added to total cost.", + "nullable": true + }, + "conditionalCostOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "The operator applied between the 'costVariable' and 'operand'.", + "nullable": true + }, + "conditionalCostVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", + "nullable": true + }, + "conditionalCostThreshold": { + "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", + "type": "number" } } }, - "project-template-verification-qa-checker-segments-to-exclude": { - "title": "Segments to Exclude", - "x-stoplight": { - "id": "1rb61vur5mzn3" - }, + "quote-language-cost": { + "title": "Quote Language Cost", "type": "object", + "description": "Fees relevant for a specific target language.", "properties": { - "excludePerfectMatchSegments": { - "type": "boolean", - "default": true, - "x-stoplight": { - "id": "lns6fv1v15m9r" - }, - "x-default-field": true, - "description": "
default
" + "name": { + "type": "string", + "description": "
default
The name of the additional cost.
", + "x-default-field": true }, - "excludeExactMatches": { - "type": "boolean", - "x-stoplight": { - "id": "hkmg7bvsderss" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "count": { + "type": "number", + "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", + "nullable": true }, - "excludeFuzzyMatches": { - "type": "boolean", - "x-stoplight": { - "id": "40bzc9xgu79j6" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "total": { + "type": "number", + "description": "
default
The computed cost.
", + "nullable": true, + "x-default-field": true }, - "excludeFuzzyMatchesValue": { + "cost": { "type": "number", - "x-stoplight": { - "id": "6nb9cw19h7j8g" - }, - "x-default-field": true, - "default": 99, - "description": "
default
" + "description": "The cost of a unit.", + "nullable": true }, - "excludeNewTranslation": { - "type": "boolean", - "x-stoplight": { - "id": "q9nay4my2ax0d" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "costType": { + "$ref": "#/components/schemas/language-cost-type", + "description": "The type of the additional cost." }, - "excludeConfirmedTranslations": { - "type": "boolean", - "x-stoplight": { - "id": "5qr82fuljzh9c" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used as a reference for the unit cost." }, - "excludeLockedSegments": { - "type": "boolean", - "x-stoplight": { - "id": "zxvvu2p3el9vo" - }, - "x-default-field": true, - "description": "
default
" + "targetLanguage": { + "$ref": "#/components/schemas/language" }, - "excludeIdentical": { - "type": "boolean", - "x-stoplight": { - "id": "wt06ljmjtzxx1" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "costOrder": { + "type": "integer", + "description": "Indicates the order in which the additional cost is computed.", + "nullable": true }, - "elementContextExclusion": { - "type": "boolean", - "x-stoplight": { - "id": "ihg0auk684zwo" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "The condition type of the conditional cost." }, - "exclusionContextList": { - "type": "array", - "x-stoplight": { - "id": "w8wid64dh2ofd" - }, - "x-default-field": true, - "items": { - "x-stoplight": { - "id": "uold0rq8drd0g" - }, - "type": "string" - }, - "description": "
default
" + "conditionalCostOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "The operator applied between the 'costVariable' and 'operand'." }, - "reportAllNonExcluded": { - "type": "boolean", - "x-stoplight": { - "id": "two2plqqt9g76" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "conditionalCostVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'." }, - "reportAllNonExcludedSeverity": { + "conditionalCostThreshold": { + "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", + "type": "number", + "nullable": true + }, + "runningTotal": { + "type": "number", + "description": "The sum of all the previously computed costs.", + "nullable": true + }, + "customUnitName": { + "type": "string", "x-stoplight": { - "id": "24w5oqpge9vtt" + "id": "tdfu8mqyo09if" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "note" + "description": "The name of the custom unit." } } }, - "project-template-verification-qa-checker-inconsistencies": { - "title": "QA Checker Inconsistencies", - "x-stoplight": { - "id": "iosfg9dirb8hw" - }, + "quote-language-cost-request": { + "title": "Quote Language Cost Request", "type": "object", + "required": [ + "name", + "count", + "cost", + "costOrder", + "conditionalCostThreshold" + ], "properties": { - "checkInconsistentTranslations": { - "type": "boolean", - "default": false, - "x-default-field": true, - "description": "
default
" + "name": { + "type": "string", + "description": "The name of the additional cost." }, - "checkInconsistentTranslationsSeverity": { - "x-stoplight": { - "id": "bsouwbxqv95ye" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "count": { + "type": "number", + "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." }, - "checkInconsistentTranslationsIgnoreTags": { - "type": "boolean", - "x-stoplight": { - "id": "3koq6k6fd9l44" - }, - "default": false + "cost": { + "type": "number", + "description": "The cost of a unit." }, - "checkInconsistentTranslationsIgnoreCase": { - "type": "boolean", - "x-stoplight": { - "id": "6cmbn8w6k7fg4" - }, - "default": false + "costType": { + "$ref": "#/components/schemas/language-cost-type", + "description": "The type of the additional cost.", + "nullable": true }, - "checkRepeatedWords": { - "type": "boolean", - "x-stoplight": { - "id": "57vj6px0vfsie" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "volumeUnitType": { + "$ref": "#/components/schemas/volume-unit-type", + "description": "The unit type of the 'volume' cost, used for counting the units.", + "nullable": true }, - "checkRepeatedWordsSeverity": { - "x-stoplight": { - "id": "72j1swplvu10s" - }, - "enum": [ - "error", - "warning", - " Note" - ], - "default": "warning" + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" }, - "checkRepeatedWordsIgnoreNumbers": { - "type": "boolean", - "x-stoplight": { - "id": "h48hxx4si6aoh" - }, - "default": false + "costOrder": { + "type": "integer", + "description": "Indicates the order in which the additional cost is computed." + }, + "conditionalCostType": { + "$ref": "#/components/schemas/conditional-cost-type", + "description": "Describes how the cost of type 'conditional' will be added to total cost.", + "nullable": true + }, + "conditionalCostOperator": { + "$ref": "#/components/schemas/conditional-cost-operator", + "description": "The operator applied between the 'costVariable' and 'operand'.", + "nullable": true + }, + "conditionalCostVariable": { + "$ref": "#/components/schemas/conditional-cost-variable", + "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", + "nullable": true + }, + "conditionalCostThreshold": { + "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", + "type": "number" + } + } + }, + "quote-translation-cost": { + "title": "Quote Translation Cost", + "type": "object", + "description": "Fees calculated based on segment status (new, translated, signed off) and previous leverage (100% match and identical context, 100% match, <100%match, cross-file repetitions).", + "properties": { + "total": { + "type": "number", + "description": "
default
The total cost for the current target language.
", + "nullable": true, + "x-default-field": true + }, + "targetLanguage": { + "$ref": "#/components/schemas/language" }, - "checkRepeatedWordsIgnoreCase": { - "type": "boolean", - "x-stoplight": { - "id": "0pjpiv5gt6y7k" - }, - "default": false + "exactMatch": { + "$ref": "#/components/schemas/translation-cost-item" }, - "checkUneditedSegmentsFuzzy": { - "x-stoplight": { - "id": "t9fk4h0hrr5co" - }, - "type": "boolean", - "x-default-field": true, - "default": true, - "description": "
default
" + "inContextExactMatch": { + "$ref": "#/components/schemas/translation-cost-item" }, - "checkUneditedSegmentsFuzzySeverity": { - "x-stoplight": { - "id": "ry42m8y5j21he" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "new": { + "$ref": "#/components/schemas/translation-cost-item" }, - "checkOnlyConfirmedSegments": { - "type": "boolean", - "x-stoplight": { - "id": "ng703myrxolr9" - }, - "default": false + "perfectMatch": { + "$ref": "#/components/schemas/translation-cost-item" }, - "checkIfMatchScoresBelow": { - "type": "boolean", - "x-stoplight": { - "id": "i05vug43v8q0w" - }, - "default": false + "repetitions": { + "$ref": "#/components/schemas/translation-cost-item" }, - "checkIfMatchScoresBelowValue": { + "machineTranslation": { + "$ref": "#/components/schemas/translation-cost-item" + }, + "fuzzyMatch": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-cost-fuzzy-item" + } + }, + "runningTotal": { "type": "number", - "default": 99 + "description": "
default
The sum of all the previously computed costs.
", + "nullable": true, + "x-default-field": true } } }, - "project-template-verification-qa-checker-punctuation": { - "title": "QA Checker Punctuation", - "x-stoplight": { - "id": "9sidt6n9cxt5y" - }, + "quote-update-request": { + "title": "Quote Update Request", "type": "object", "properties": { - "checkIdenticalPunctuation": { - "type": "boolean", - "default": true, - "x-default-field": true, - "x-stoplight": { - "id": "fvt9f95rf0uen" - }, - "description": "
default
" + "languageCosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quote-language-cost-request" + } }, - "checkIdenticalPunctuationSeverity": { - "x-stoplight": { - "id": "1fcl96sxrs5wx" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "additionalCosts": { + "type": "array", + "items": { + "$ref": "#/components/schemas/quote-additional-cost-request" + } }, - "checkSpanishPunctuation": { + "notes": { + "type": "string", "x-stoplight": { - "id": "7fnmgzkao3fxi" + "id": "404ggz8hrvbpg" }, - "x-default-field": true, - "default": false, - "type": "boolean", - "description": "
default
" + "description": "A message associated with the quote.", + "maxLength": 3000 + } + } + }, + "project-quote-template": { + "title": "Project Quote Template", + "type": "object", + "description": "Project Quote Template resource.", + "properties": { + "id": { + "type": "string", + "description": "The identifier of the quote template." }, - "checkSpanishPunctuationSeverity": { - "x-stoplight": { - "id": "f0umcr7ywjnsf" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "name": { + "type": "string", + "description": "The name of the quote template." }, - "checkUnintentionalSpacesBeforePunctuation": { - "type": "boolean", - "x-stoplight": { - "id": "4wnyw10rl8k1m" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "description": { + "type": "string", + "description": "The description of the quote template." }, - "checkUnintentionalSpacesBeforePunctuationSeverity": { - "x-stoplight": { - "id": "9up0q78jlw73a" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "location": { + "$ref": "#/components/schemas/folder-v2" + } + }, + "required": [ + "id" + ], + "x-stoplight": { + "id": "0sp6j7989p1j7" + } + }, + "project-quote-template-deprecated": { + "title": "Project Quote Template", + "x-stoplight": { + "id": "cwik0w5o34ix6" + }, + "type": "object", + "description": "(Deprecated) moved under settings.general.quoteTemplate", + "deprecated": true, + "properties": { + "id": { + "type": "string", + "description": "The identifier of the quote template." }, - "checkUnintentionalSpacesBeforePunctuationValues": { + "name": { "type": "string", - "x-stoplight": { - "id": "bukb4vmlo01si" - }, - "default": ":!?;" + "description": "The name of the quote template." }, - "punctuationSpacesFrench": { - "type": "boolean", - "x-stoplight": { - "id": "n2amwff6y1fru" - }, - "default": false + "description": { + "type": "string", + "description": "The description of the quote template." }, - "checkMultipleSpaces": { - "type": "boolean", - "x-stoplight": { - "id": "371vnwmqt53uv" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "location": { + "$ref": "#/components/schemas/folder-v2" + } + }, + "required": [ + "id" + ] + }, + "rate-limit": { + "title": "Rate Limit", + "type": "object", + "description": "Rate Limit entry", + "properties": { + "policyName": { + "type": "string", + "description": "Name of the rate limit policy." }, - "checkMultipleSpacesSeverity": { - "x-stoplight": { - "id": "z1snyx22cm8kp" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "note" + "description": { + "type": "string", + "description": "Describes which endpoints are affected by this limit, and for which time frame." }, - "checkMultipleDots": { - "type": "boolean", - "x-stoplight": { - "id": "wxxvehvri3o8q" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "limit": { + "type": "integer", + "description": "The limit in effect for the endpoint and time frame." }, - "checkMultipleDotsSeverity": { - "x-stoplight": { - "id": "s3nerdbtbe17i" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "note" + "remainingQuota": { + "type": "integer", + "description": "The remaining quota in effect for the endpoint and time frame." + } + }, + "required": [ + "policyName", + "description", + "limit", + "remainingQuota" + ] + }, + "resource-folder-request": { + "title": "Resource Folder Request", + "type": "object", + "description": "Resource folder.", + "properties": { + "id": { + "type": "string", + "description": "The folder identifier." }, - "ignoreThreeDots": { - "type": "boolean", - "x-stoplight": { - "id": "128751e5f7bb0" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "name": { + "type": "string", + "description": "The name of the folder." + } + }, + "required": [ + "id" + ] + }, + "remove-projects-from-group-request": { + "title": "Remove Projects From Group Request", + "type": "object", + "description": "Input for removing projects from group.", + "properties": { + "projects": { + "type": "array", + "description": "The projects to be removed from group.", + "items": { + "$ref": "#/components/schemas/project-group-project-request" + } + } + }, + "required": [ + "projects" + ] + }, + "schedule-template": { + "title": "Schedule Template", + "x-stoplight": { + "id": "c2a2ilce5ag48" + }, + "type": "object", + "description": "Schedule Template resource", + "properties": { + "id": { + "type": "string" }, - "checkExtraSpace": { - "type": "boolean", - "x-stoplight": { - "id": "rczo8oi443l7b" - }, - "x-default-field": true, - "default": true, - "description": "
default
" + "name": { + "type": "string", + "description": "
default
Schedule Template name.
", + "x-default-field": true }, - "checkExtraSpaceSeverity": { - "x-stoplight": { - "id": "b9qsayeygu8d5" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "description": { + "type": "string", + "description": "Schedule Template description." }, - "checkCapitalizationOfInitials": { - "type": "boolean", - "x-stoplight": { - "id": "94fhj5alcziax" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "location": { + "$ref": "#/components/schemas/folder-v2" }, - "checkCapitalizationOfInitialsSeverity": { + "configurations": { + "type": "array", "x-stoplight": { - "id": "btsm5s1bzz7aq" + "id": "w3yw55a536y3m" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "items": { + "$ref": "#/components/schemas/schedule-template-configuration", + "x-stoplight": { + "id": "z1pcd596vxyhe" + } + } }, - "checkConsistencyOfGlobalCapitalization": { + "projectScheduleConfiguration": { + "$ref": "#/components/schemas/schedule-template-project-configuration", "x-stoplight": { - "id": "2b9wdh315dahs" - }, - "type": "boolean", - "x-default-field": true, - "default": false, - "description": "
default
" - }, - "checkConsistencyOfGlobalCapitalizationSeverity": { + "id": "jh0as6p6odfm0" + } + } + }, + "required": [ + "id" + ] + }, + "schedule-template-configuration": { + "title": "Schedule Template Configuration", + "x-stoplight": { + "id": "p8wulrz2rytzj" + }, + "type": "object", + "description": "Schedule Template Configuration resource", + "properties": { + "taskTypeId": { + "type": "string", "x-stoplight": { - "id": "4eohngzh0e2bc" + "id": "ussbf9yycjf0h" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "description": "The identifier of the human task type. " }, - "checkBrackets": { - "type": "boolean", + "taskTypeName": { + "type": "string", "x-stoplight": { - "id": "lw5s7boith817" + "id": "lny75nk7b0g3j" }, - "x-default-field": true, - "default": true, - "description": "
default
" + "description": "The name of the task type." }, - "checkBracketsSeverity": { + "schedules": { "x-stoplight": { - "id": "f8rpatoa21n08" + "id": "iu34k91wl2eql" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "type": "array", + "items": { + "$ref": "#/components/schemas/schedule-template-configuration-schedules", + "x-stoplight": { + "id": "j29hssjf8a1nu" + } + } } - } + }, + "required": [ + "taskTypeId" + ] }, - "project-template-verification-qa-checker-numbers": { - "title": "QA Checker Numbers", + "schedule-template-project-configuration": { + "title": "Schedule Template Project Configuration", "x-stoplight": { - "id": "95nv42e499dwi" + "id": "ezrw8kwy2cc2x" }, "type": "object", + "description": "Schedule Template Project Configuration resource", "properties": { - "checkNumbers": { - "type": "boolean", - "default": false, - "x-default-field": true, + "duration": { + "type": "integer", "x-stoplight": { - "id": "jmx3msjbemxdr" + "id": "ml3qutq4qy3km" }, - "description": "
default
" + "description": "
default
Expressed in minutes.
", + "default": 0, + "minimum": 0 }, - "checkNumbersSeverity": { + "reminder": { "x-stoplight": { - "id": "05931rv7v34yd" + "id": "3z5tzoznv1gci" }, + "description": "
default
Expressed in minutes.
", "enum": [ - "error", - "warning", - "note" - ], - "default": "error" - }, - "checkTimes": { - "type": "boolean", - "x-stoplight": { - "id": "yjnavlbjro7zn" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + 15, + 30, + 60, + 120, + 480, + 1440, + 2880 + ] + } + } + }, + "schedule-template-configuration-request": { + "title": "Schedule Template Configuration Request", + "x-stoplight": { + "id": "pzjg39ikgktrd" + }, + "type": "object", + "description": "Schedule Template Configuration resource", + "properties": { + "taskTypeId": { + "type": "string", + "description": "The identifier of the human task type. " }, - "checkTimesSeverity": { + "schedules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/schedule-template-configuration-schedules" + } + } + }, + "required": [ + "taskTypeId" + ] + }, + "schedule-template-configuration-schedules": { + "title": "Schedule Template Configuration Schedules", + "x-stoplight": { + "id": "9kw1yuhfb39q1" + }, + "type": "object", + "description": "The Configuration Schedules resource.", + "properties": { + "scope": { + "type": "string", "x-stoplight": { - "id": "p7a2a445i131t" + "id": "gn25uzdk9mu85" }, + "description": "The scope of this configuration schedule. \\\r\nglobal -> schedule of the task \\\r\nsourceLanguage -> schedule of the specific task when the sourceLanguage matches this object's sourceLanguage\\\r\nlanguageDirection -> schedule of the specific task when the languageDirection matches this object's languageDirection", "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + "global", + "sourceLanguage", + "languageDirection" + ] }, - "checkDates": { - "type": "boolean", + "duration": { + "type": "integer", "x-stoplight": { - "id": "yccnoxkca39wp" + "id": "r20a6jq7s4a99" }, - "x-default-field": true, - "default": false, - "description": "
default
" + "description": "Expressed in minutes.", + "minimum": 0 }, - "checkDatesSeverity": { + "reminder": { "x-stoplight": { - "id": "9e40z6bd9mv8q" + "id": "wa77577h9gchk" }, + "description": "Expressed in minutes.\r\n\r\n", "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + 15, + 30, + 60, + 120, + 480, + 1440, + 2880 + ] }, - "checkMeasurements": { - "type": "boolean", + "sourceLanguage": { + "type": "string", "x-stoplight": { - "id": "9w2l7x89okahm" + "id": "x9sswos4516kw" }, - "x-default-field": true, - "default": false, - "description": "
default
" + "example": " \"en-US\", de-DE\"" }, - "checkMeasurementsSeverity": { + "targetLanguage": { + "type": "string", "x-stoplight": { - "id": "5isqhxzz365vq" + "id": "kptfl33vpqdt7" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + "example": " \"en-US\", de-DE\"" } - } + }, + "required": [ + "scope" + ] }, - "project-template-verification-qa-checker-word-list": { - "title": "QA Checker Word list", + "schedule-template-update-request": { + "title": "Schedule Template Update Request", "x-stoplight": { - "id": "jcu8333uzax64" + "id": "eurbufhjxy71a" }, "type": "object", + "description": "Schedule Template update request model", "properties": { - "enabled": { - "type": "boolean", - "default": false, - "x-stoplight": { - "id": "1i43kmdizt8f9" - } + "name": { + "type": "string", + "description": "
Schedule Template name.
", + "maxLength": 50 }, - "searchWholeWords": { - "type": "boolean", + "description": { + "type": "string", + "description": "Schedule Template description.", + "maxLength": 1000 + }, + "configurations": { + "type": "array", "x-stoplight": { - "id": "mtexp5nafx5d4" + "id": "nzqkfrvaq8mck" }, - "x-default-field": true, - "default": false, - "description": "
default
" + "items": { + "$ref": "#/components/schemas/schedule-template-configuration-request", + "x-stoplight": { + "id": "kw88kaez7l361" + } + } }, - "ignoreCase": { - "type": "boolean", + "projectScheduleConfiguration": { + "$ref": "#/components/schemas/schedule-template-project-configuration", "x-stoplight": { - "id": "lw4spspstngjb" - }, - "x-default-field": true, - "default": false, - "description": "
default
" + "id": "glzz39c8n1mpo" + } + } + } + }, + "schedule-template-create-request": { + "title": "Schedule Template Create Request", + "x-stoplight": { + "id": "nzunuxlururt7" + }, + "type": "object", + "description": "Schedule Template create request model", + "properties": { + "name": { + "type": "string", + "description": "
Schedule Template name.
", + "maxLength": 50 }, - "checkWordListSeverity": { + "description": { + "type": "string", + "description": "Schedule Template description.", + "maxLength": 1000 + }, + "location": { + "type": "string", "x-stoplight": { - "id": "4dxqub35774eb" + "id": "j38jg0ywij0e6" }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "warning" + "description": "The folder identifier where the schedule template should be created. " }, - "wordList": { + "configurations": { "type": "array", "x-stoplight": { - "id": "rjn2ec0xqsm0k" + "id": "eufab0pne7lzd" }, - "x-default-field": true, "items": { + "$ref": "#/components/schemas/schedule-template-configuration-request", "x-stoplight": { - "id": "2rknpju6n8z56" - }, - "type": "object", - "properties": { - "wrongForm": { - "type": "string", - "x-stoplight": { - "id": "u9yi9ohufpdvp" - }, - "x-default-field": true - }, - "correctForm": { - "type": "string", - "x-stoplight": { - "id": "h4itahton32nl" - }, - "x-default-field": true - } + "id": "oxk22epaz3rbi" } - }, - "description": "
default
" + } + }, + "projectScheduleConfiguration": { + "$ref": "#/components/schemas/schedule-template-project-configuration", + "x-stoplight": { + "id": "rqi0t3ue6dm3m" + } + } + }, + "required": [ + "name" + ] + }, + "simple-language-direction": { + "title": "Simple Language Direction", + "type": "object", + "description": "A basic language direction.", + "properties": { + "id": { + "type": "string", + "description": "The language direction identifier." + }, + "sourceLanguage": { + "$ref": "#/components/schemas/language", + "description": "
default
The language object.
", + "x-default-field": true + }, + "targetLanguage": { + "$ref": "#/components/schemas/language", + "description": "
default
The language object.
", + "x-default-field": true + } + } + }, + "source-file": { + "title": "Source File", + "type": "object", + "description": "Source File.", + "required": [ + "id" + ], + "properties": { + "id": { + "type": "string" + }, + "name": { + "type": "string", + "description": "
default
The file name.
", + "x-default-field": true + }, + "role": { + "$ref": "#/components/schemas/file-role", + "description": "
default
The file role.
", + "x-default-field": true + }, + "language": { + "$ref": "#/components/schemas/language" + }, + "versions": { + "type": "array", + "description": "The source file versions. (Not available for List endpoints).", + "items": { + "$ref": "#/components/schemas/source-file-version" + } + }, + "targetLanguages": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language" + } + }, + "path": { + "type": "array", + "items": { + "type": "string" + } + }, + "totalWords": { + "type": "integer", + "description": "Word count in the source file. \r\n
\r\nAvailable only for translatable source files, and only after the workflow task with Task Type `convert` (File Format Conversion) was executed on the source file.\r\n
\r\nAvailable only on the List Source Files endpoint." } - }, - "required": [ - "enabled" - ] + } }, - "project-template-verification-qa-checker-regular-expressions": { - "title": "QA Checker Regular Expressions", - "x-stoplight": { - "id": "xem3u8m9wipd6" - }, + "source-file-request": { "type": "object", + "title": "Source File Request", + "description": "Source file properties sent as a JSON inside a text part.", + "required": [ + "name", + "role", + "type", + "language" + ], "properties": { - "checkRegularExpressions": { - "type": "boolean", - "default": false, - "x-stoplight": { - "id": "83h1307cwqhw9" - }, - "description": "" + "name": { + "type": "string", + "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`.\n\n\nThe character limit is calculated together with the `path` length.", + "minLength": 1, + "maxLength": 255 }, - "regularExpressionSeverity": { - "x-stoplight": { - "id": "xmi8dmu62uzi8" - }, + "role": { + "type": "string", "enum": [ - "error", - "warning", - "note" + "translatable", + "reference", + "unknown" ], - "default": "warning" + "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." }, - "regularExpressions": { + "type": { + "type": "string", + "enum": [ + "native", + "bcm", + "sdlxliff" + ], + "description": "The type of the file." + }, + "language": { + "$ref": "#/components/schemas/language-request", + "description": "The language of the file in code 5 (ex. en-US)" + }, + "targetLanguages": { "type": "array", - "x-stoplight": { - "id": "6z45r3k1a1b4o" - }, - "x-default-field": true, + "description": "A list of target languages in code 5 (ex. en-US)", "items": { - "$ref": "#/components/schemas/project-template-verification-qa-checker-regular-expressions-model", - "x-stoplight": { - "id": "5e6hkwes4mo6a" - } - }, - "description": "
default
" + "$ref": "#/components/schemas/language-request" + } + }, + "path": { + "type": "array", + "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\"\n]\n```\n\nThe character limit is calculated together with the `name` length.", + "items": { + "type": "string", + "minLength": 0, + "maxLength": 200 + } } - }, - "required": [ - "checkRegularExpressions" - ] + } }, - "project-template-verification-qa-checker-regular-expressions-model": { - "title": "Regular Expressions Model", - "x-stoplight": { - "id": "2rx3df3vczsr1" - }, + "source-file-rename-request": { + "title": "Source File Rename Request", "type": "object", "properties": { - "description": { - "type": "string", - "x-stoplight": { - "id": "20v4paozpk91g" - }, - "x-default-field": true, - "description": "
default
" - }, - "regexSource": { - "x-stoplight": { - "id": "e9lfc0qm2td5k" - }, - "type": "string", - "x-default-field": true, - "description": "
default
" - }, - "regexTarget": { + "name": { "type": "string", - "x-stoplight": { - "id": "k7olv3yojvixm" - }, - "x-default-field": true, - "description": "
default
" + "description": "The name of the source file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", + "minLength": 1 }, - "ignoreCase": { + "updateTargetFilesName": { "type": "boolean", - "x-stoplight": { - "id": "21avhvnk4l142" - }, - "x-default-field": true, "default": false, - "description": "
default
" - }, - "condition": { - "x-stoplight": { - "id": "nmhpp19inyk2n" - }, - "enum": [ - "targetAndSource", - "targetNotSource", - "sourceNotTarget", - "sourceOnly", - "targetOnly", - "differentCount", - "groupedTargetAndSource" - ], - "x-default-field": true, - "description": "
default
" + "description": "Option for renaming also the target files." } - } - }, - "project-template-verification-qa-checker-trademark-check": { - "title": "QA Checker Trademark check", - "x-stoplight": { - "id": "l65c655atolg3" }, + "required": [ + "name" + ] + }, + "source-files-update-request": { + "title": "Source Files Update Request", "type": "object", "properties": { - "enabled": { - "type": "boolean", - "default": true, - "x-stoplight": { - "id": "hrisnih0vgd4w" - } - }, - "trademarkSeverity": { - "x-stoplight": { - "id": "dfa7w4qetxl2c" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "error" - }, - "trademarkSymbols": { + "files": { "type": "array", - "x-stoplight": { - "id": "i0um9xob8izp7" - }, - "x-default-field": true, "items": { - "x-stoplight": { - "id": "d32mt39hj0fer" - }, - "type": "string" - }, - "default": [ - "®", - "©", - "™", - "(c)", - "(r)", - "(tm)" - ], - "description": "
default
" + "$ref": "#/components/schemas/source-file-update-request" + } } }, "required": [ - "enabled" + "files" ] }, - "project-template-verification-qa-checker-length-verification": { - "title": "QA Checker Length Verification", - "x-stoplight": { - "id": "ex9iomj4a786f" - }, + "source-file-update-request": { + "title": "Source File Update Request", "type": "object", "properties": { - "checkLengthLimitation": { - "type": "boolean", - "default": true, - "x-default-field": true, - "x-stoplight": { - "id": "7bxsr6dzipk4m" - }, - "description": "
default
" - }, - "checkLengthLimitationSeverity": { - "x-stoplight": { - "id": "3wlsd7f20hftl" - }, - "enum": [ - "error", - "warning", - "note" - ], - "default": "error" + "id": { + "type": "string", + "description": "The source file identifier.", + "minLength": 1 }, - "targetSegmentsVerificationType": { - "x-stoplight": { - "id": "147n1oindvqf3" - }, - "x-default-field": true, - "enum": [ - "fileSpecificLimit", - "absoluteCharacterCount" - ], - "default": "fileSpecificLimit", - "description": "
default
" + "name": { + "type": "string", + "description": "The source file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", + "minLength": 1 }, - "absoluteCharCountValue": { - "type": "number", - "x-stoplight": { - "id": "i88shddbsddjo" - }, - "x-default-field": true, - "description": "
default
Used in case `targetSegmentsVerificationType = absoluteCharacterCount`
", - "default": 50 + "updateTargetFilesName": { + "type": "boolean", + "default": false, + "description": "Option for renaming the target files too." + } + }, + "required": [ + "id", + "name" + ] + }, + "source-file-attachment-request": { + "title": "Source File Attachment Request", + "type": "object", + "description": "", + "properties": { + "sourceFilesAttachment": { + "type": "array", + "description": "List of Attached Source File properties referencing previously uploaded file", + "items": { + "$ref": "#/components/schemas/source-file-attachment-request-item" + } } } }, - "project-template-TM-penalties": { - "title": "Translation Memory Penalties", + "source-file-attachment-response": { + "title": "Source File Attachment Response", "type": "object", - "description": "Translation Memory Penalties", + "description": "", "properties": { - "standardPenalties": { - "$ref": "#/components/schemas/project-template-TM-standard-penalties", - "description": "
default
", - "x-default-field": true, - "type": "object", - "x-stoplight": { - "id": "rx66lu3x78mvr" - } - }, - "translationUnitStatusPenalties": { - "$ref": "#/components/schemas/project-template-TM-translation-unit-status-penalties", - "description": "
default
", - "x-default-field": true, - "type": "object", - "x-stoplight": { - "id": "7g27gag166myh" + "sourceFiles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/source-file" } } } }, - "project-template-TM-standard-penalties": { - "title": "Translation Memory Standard Penalties", + "source-file-attachment-request-item": { + "title": "Source File Attachment Request Item", "type": "object", - "description": "Translation Memory Standard Penalties", + "description": "Attached Source File properties referencing previously uploaded file", + "required": [ + "name", + "role", + "fileUrl", + "type", + "language" + ], "properties": { - "missingFormatting": { - "description": "
default
", - "x-default-field": true, - "x-stoplight": { - "id": "pdzeu7k11vkc4" - }, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 1 + "name": { + "type": "string", + "description": "The name of the source file. For example `Finance_2021_dummy_EN.txt`. \n\nThe character limit is calculated together with the `path` length.", + "maxLength": 200, + "minLength": 1 }, - "differentFormatting": { - "description": "
default
", - "x-default-field": true, - "x-stoplight": { - "id": "bspk3rj8xswag" - }, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 1 + "role": { + "type": "string", + "enum": [ + "translatable", + "reference", + "unknown" + ], + "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." }, - "multipleTranslations": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 1 + "fileUrl": { + "type": "string", + "description": "The identifier of the previously uploaded file." }, - "autoLocalization": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 + "type": { + "type": "string", + "enum": [ + "native", + "bcm", + "sdlxliff" + ], + "description": "The type of the file." }, - "textReplacement": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 + "language": { + "$ref": "#/components/schemas/source-language-request" }, - "alignment": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 1 + "targetLanguages": { + "type": "array", + "description": "A list of target languages in code 5 (ex. en-US)", + "items": { + "$ref": "#/components/schemas/target-language-request" + } }, - "characterWidthDifference": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 1 + "path": { + "type": "array", + "description": "Path represents the hierarchy of the source file inside the project.\n\nFor example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\" \n]\n```\n\nThe character limit is calculated together with the `name` length.", + "items": { + "type": "string", + "maxLength": 200, + "minLength": 0 + } } } }, - "project-template-TM-translation-unit-status-penalties": { - "title": "Translation Memory Translation Unit Status Penalties", + "source-file-properties-response": { + "title": "Source File Properties Response", "type": "object", - "description": "Translation Memory Translation Unit Status Penalties", + "description": "", "properties": { - "translated": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 - }, - "rejectedTranslation": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 - }, - "approvedTranslation": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 - }, - "rejectedSignOff": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 - }, - "approvedSignOff": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 + "fileRole": { + "type": "string", + "description": "The file's role.", + "enum": [ + "translatable", + "reference" + ] }, - "notTranslated": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 + "fileTypeSettingsId": { + "type": "string", + "description": "The file type settings identifier." + } + }, + "required": [ + "fileRole", + "fileTypeSettingsId" + ] + }, + "source-file-properties-update-request": { + "title": "Source File Properties Update Request", + "type": "object", + "description": "", + "properties": { + "fileRole": { + "type": "string", + "description": "The file role.", + "enum": [ + "translatable", + "reference" + ] }, - "draft": { - "description": "
default
", - "x-default-field": true, - "type": "integer", - "minimum": 0, - "maximum": 20, - "default": 0 + "fileTypeSettingsId": { + "type": "string", + "description": "The file type settings identifier." } } }, - "project-plan": { - "title": "Project Plan", + "source-file-version-properties-create-request": { + "title": "Source File Version Properties Create Request", "type": "object", - "description": "The configurations of the tasks that will be created in the future.\n\nAvailable now directly after project creation, project does not need to be started to be populated. \n\n(Not available for List Projects endpoint)", + "description": "", "properties": { - "taskConfigurations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/project-plan-task-configuration" - } + "type": { + "type": "string", + "description": "The version type.", + "enum": [ + "bcm", + "native" + ] + }, + "fileTypeSettingsId": { + "type": "string", + "description": "The file type settings identifier." } - } + }, + "required": [ + "type" + ] }, - "project-plan-task-configuration": { - "title": "Project Plan Task Configuration", + "source-file-version": { + "title": "Source File Version", "type": "object", - "description": "The configuration of a task that will be created in the future.", + "description": "Source File Version.", "properties": { - "taskTemplate": { - "$ref": "#/components/schemas/object-id" - }, - "scope": { - "$ref": "#/components/schemas/task-configuration-scope" - }, - "assignees": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow-task-assignee" - } + "id": { + "type": "string", + "description": "The source file version identifier." }, - "isSkipped": { - "type": "boolean", - "description": "
default
Specifies if the task will be skipped.
", + "type": { + "type": "string", + "enum": [ + "native", + "bcm" + ], + "description": "
default
The version type.
", "nullable": true, "x-default-field": true }, - "dueBy": { + "name": { "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The due date of the future task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "nullable": true + "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", + "x-default-field": true + }, + "version": { + "type": "integer", + "description": "A numeric value, incremented for each new version." + }, + "originatingTaskId": { + "type": "string", + "x-stoplight": { + "id": "fsakhiag03gl9" + }, + "description": "The identifier of the task that generated the file." } }, "required": [ - "taskTemplate", - "scope" + "id", + "version" ] }, - "project-plan-task-assignee-request": { - "title": "Project Plan Task Assignee Request", + "source-file-version-response": { + "title": "Source File Version Response", "type": "object", + "description": "", "properties": { - "type": { + "id": { "type": "string", - "enum": [ - "user", - "group", - "vendorOrderTemplate", - "projectCreator" - ] + "description": "The source file version identifier." }, - "id": { + "type": { "type": "string", - "description": "The user, group or vendor identifier, depending on the type chosen. It is not required for `projectCreator`." + "description": "
default
The version type.
", + "enum": [ + "native", + "bcm" + ], + "x-default-field": true } }, "required": [ - "type" + "id" ] }, - "project-plan-update-request": { - "title": "Project Plan Update Request", + "source-language-request": { + "title": "Source Language Request", "type": "object", - "description": "Updates the configurations of the tasks that will be created in the future. \nFor example, you can change the assignee of the \"translation\" task while the project is in the \"preprocessing\" phase.", "properties": { - "taskConfigurations": { - "type": "array", - "minItems": 1, - "items": { - "$ref": "#/components/schemas/project-plan-task-configuration-request" - } + "languageCode": { + "type": "string", + "description": "The language code." } }, "required": [ - "taskConfigurations" + "languageCode" ] }, - "project-plan-task-configuration-request": { - "title": "Project Plan Task Configuration Request", + "target-file-version-properties-create-request": { + "title": "Target File Version Properties Create Request", "type": "object", - "description": "A project plan task configuration request. Used to update a task that will be created in the future.", + "description": "", "properties": { - "taskTemplate": { - "$ref": "#/components/schemas/object-id-request" - }, - "isSkipped": { - "type": "boolean", - "description": "Specifies if the task will be skipped. \n If you want to skip all the target languages for the given task, set the scope as \"global\"." - }, - "assignees": { - "type": "array", - "description": "Specifies the list of assignees for the future task. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", - "items": { - "$ref": "#/components/schemas/project-plan-task-assignee-request" - } - }, - "scope": { - "$ref": "#/components/schemas/task-configuration-scope-request" - }, - "dueBy": { - "$ref": "#/components/schemas/date-time" + "type": { + "type": "string", + "description": "The version type.", + "enum": [ + "bcm", + "native" + ] } }, "required": [ - "taskTemplate", - "isSkipped", - "assignees", - "scope" + "type" ] }, - "project-status-history": { - "title": "Project Status History Item", + "target-file-version-response": { + "title": "Target File Version Response", "type": "object", - "description": "An Item which describes a change in the status of the project.", + "description": "", "properties": { - "from": { + "id": { "type": "string", - "description": "Specifies the project status previous to the change.", - "enum": [ - "none", - "created", - "inProgress", - "completed" - ] + "description": "The target file version identifier." }, - "to": { + "type": { "type": "string", - "description": "Specifies the project status post change.", + "description": "
default
The version type.
", "enum": [ - "created", - "inProgress", - "completed" - ] - }, - "by": { - "$ref": "#/components/schemas/user" - }, - "timestamp": { - "$ref": "#/components/schemas/date-time", - "x-default-field": true, - "description": "The time and date when the status history was updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" + "native", + "bcm" + ], + "x-default-field": true } }, "required": [ - "from", - "to" + "id" ] }, - "quote": { - "title": "Quote", + "task": { + "title": "Task", "type": "object", - "description": "Project quote.", + "description": "Task.", "properties": { - "totalAmount": { - "type": "number", - "description": "
default
Total translation fee.
", - "nullable": true, - "x-default-field": true + "id": { + "type": "string" }, - "currencyCode": { + "status": { "type": "string", - "description": "
default
The currency code (ISO 4217).
", - "x-default-field": true + "description": "
default
The task status.
", + "enum": [ + "created", + "inProgress", + "completed", + "failed", + "skipped", + "canceled" + ], + "x-default-field": true, + "nullable": true }, - "translationCosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/quote-translation-cost" - } + "taskType": { + "$ref": "#/components/schemas/task-type" }, - "languageCosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/quote-language-cost" - } + "input": { + "$ref": "#/components/schemas/task-input" }, - "additionalCosts": { + "inputFiles": { "type": "array", "items": { - "$ref": "#/components/schemas/quote-additional-cost" + "$ref": "#/components/schemas/task-input-file" } }, - "notes": { - "type": "string", - "x-stoplight": { - "id": "n1ohftpten9bv" - }, - "description": "A message associated with the quote." - } - } - }, - "quote-additional-cost": { - "title": "Quote Additional Cost", - "type": "object", - "description": "Other extra fees not captured by translationCosts and languageCosts.", - "properties": { - "name": { - "type": "string", - "description": "
default
The name of the additional cost.
" - }, - "count": { - "type": "number", - "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", - "nullable": true - }, - "total": { - "type": "number", - "description": "
default
The computed cost.
", - "nullable": true, - "x-default-field": true - }, - "cost": { - "type": "number", - "description": "The cost of a unit.", - "nullable": true + "owner": { + "$ref": "#/components/schemas/user" }, - "costType": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-assignee" + } + }, + "dueBy": { "type": "string", - "enum": [ - "volume", - "perTargetLanguage", - "perFile", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost.", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The task due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", "nullable": true }, - "volumeUnitType": { + "createdAt": { "type": "string", - "description": "The unit type of the 'volume' cost, used as a reference for the unit cost.", - "enum": [ - "words", - "characters" - ], + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the task was created.
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", "nullable": true }, - "costOrder": { - "type": "integer", - "description": "Indicates the order in which the additional cost is computed.", - "nullable": true + "applicableOutcomes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-outcome" + } }, - "conditionalCostType": { + "outcome": { "type": "string", - "description": "Describes how the cost of type 'conditional' will be added to total cost.", - "enum": [ - "absolute", - "relative", - "percentage" - ], - "nullable": true + "description": "The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type." }, - "conditionalCostOperator": { + "comment": { "type": "string", - "description": "The operator applied between the 'costVariable' and 'operand'.", - "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" - ], - "nullable": true + "description": "The comment associated with this task at completion." }, - "conditionalCostVariable": { - "type": "string", - "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", - "enum": [ - "wordCount", - "runningTotal" - ], - "nullable": true + "project": { + "$ref": "#/components/schemas/project" }, - "conditionalCostThreshold": { - "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", - "type": "number", - "nullable": true + "failedTask": { + "$ref": "#/components/schemas/failed-task" }, - "runningTotal": { - "type": "number", - "description": "The sum of all the previously computed costs.", - "nullable": true + "completedAt": { + "$ref": "#/components/schemas/date-time", + "description": "The completion timestamp of the task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" } - } + }, + "required": [ + "id" + ] }, - "quote-additional-cost-request": { - "title": "Quote Additional Cost Request", + "task-error": { + "title": "Task Error", "type": "object", + "description": "Task Error.", "properties": { "name": { "type": "string", - "description": "The name of the additional cost." - }, - "count": { - "type": "number", - "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." - }, - "cost": { - "type": "number", - "description": "The cost of a unit." + "description": "The task error name." }, - "costType": { + "code": { "type": "string", - "enum": [ - "volume", - "perTargetLanguage", - "perFile", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost.", - "nullable": true + "description": "The task error code." }, - "volumeUnitType": { + "value": { + "type": "string", + "description": "The task error value." + } + } + }, + "task-assignee": { + "title": "Task Assignee", + "type": "object", + "description": "Task assignee. Based on the \"type\", the following properties can be retrieved: \"user\", \"group\" or \"vendorOrderTemplate\". For \"projectCreator\" and \"projectManager\" no other properties are available.", + "properties": { + "type": { "type": "string", - "description": "The unit type of the 'volume' cost, used for counting the units.", "enum": [ - "words", - "characters" + "user", + "group", + "vendorOrderTemplate", + "projectCreator" ], - "nullable": true + "description": "Type \"projectCreator\" - reserved for future use. Should be able to handle it and ignore it if received." }, - "costOrder": { - "type": "integer", - "description": "Indicates the order in which the additional cost is computed." + "user": { + "$ref": "#/components/schemas/user", + "description": "
default
A user.
", + "x-default-field": true }, - "conditionalCostType": { - "type": "string", - "description": "Describes how the cost of type 'conditional' will be added to total cost.", - "enum": [ - "absolute", - "relative", - "percentage" - ], - "nullable": true + "group": { + "$ref": "#/components/schemas/group", + "description": "
default
A group of users.
", + "x-default-field": true }, - "conditionalCostOperator": { + "vendorOrderTemplate": { + "$ref": "#/components/schemas/vendor-order-template" + } + }, + "required": [ + "type" + ] + }, + "task-assignee-request": { + "title": "Task Assignee Request", + "type": "object", + "properties": { + "id": { "type": "string", - "description": "The operator applied between the 'costVariable' and 'operand'.", - "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" - ], - "nullable": true + "description": "The identifier of the assignee that should correspond to a resource based on the “type” field.
Only required for the `user`, `group`, and `vendorOrderTemplate` types." }, - "conditionalCostVariable": { + "type": { "type": "string", - "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", "enum": [ - "wordCount", - "runningTotal" + "user", + "group", + "vendorOrderTemplate", + "projectManager", + "projectCreator" ], - "nullable": true - }, - "conditionalCostThreshold": { - "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", - "type": "number" + "description": "The assignee type." } }, "required": [ - "name", - "count", - "cost", - "costOrder", - "conditionalCostThreshold" + "type" ] }, - "quote-language-cost": { - "title": "Quote Language Cost", + "task-assign-request": { + "title": "Task Assign Request", "type": "object", - "description": "Fees relevant for a specific target language.", + "description": "Properties of task assignment.\r\n
Total assignee count is limited. See more at [Maximum number of task assignees](https://docs.rws.com/791595/1137562/trados-enterprise---accelerate/maximum-number-of-task-assignees).", "properties": { - "name": { + "assignees": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-assignee-request" + } + } + } + }, + "task-complete-request": { + "title": "Task Complete Request", + "type": "object", + "description": "Properties of task completion.", + "properties": { + "outcome": { "type": "string", - "description": "
default
The name of the additional cost.
", - "x-default-field": true - }, - "count": { - "type": "number", - "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types.", - "nullable": true - }, - "total": { - "type": "number", - "description": "
default
The computed cost.
", - "nullable": true, - "x-default-field": true - }, - "cost": { - "type": "number", - "description": "The cost of a unit.", - "nullable": true + "description": "The outcome should be one of the valid applicable outcomes of the task. If not specified, the default one will be taken." }, - "costType": { + "comment": { "type": "string", - "enum": [ - "volume", - "perTargetLanguage", - "perFile", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost.", - "nullable": true - }, - "volumeUnitType": { + "description": "The comment associated with this task completion.", + "maxLength": 1000 + } + }, + "required": [ + "outcome" + ] + }, + "task-input": { + "title": "Task Input", + "type": "object", + "description": "Task input. Based on the \"type\", the following fields can be retrieved: \"project\", \"sourceFile\", \"targetFile\".", + "properties": { + "type": { "type": "string", - "description": "The unit type of the 'volume' cost, used as a reference for the unit cost.", + "description": "The input type.", "enum": [ - "words", - "characters" - ], - "nullable": true + "project", + "sourceFile", + "targetFile", + "languageDirection" + ] }, - "targetLanguage": { - "$ref": "#/components/schemas/language" + "project": { + "$ref": "#/components/schemas/project", + "description": "
default
Project resource
", + "x-default-field": true }, - "costOrder": { - "type": "integer", - "description": "Indicates the order in which the additional cost is computed.", - "nullable": true + "sourceFile": { + "$ref": "#/components/schemas/source-file", + "description": "
default
Source file.
", + "x-default-field": true }, - "conditionalCostType": { - "type": "string", - "description": "The condition type of the conditional cost.", - "enum": [ - "absolute", - "relative", - "percentage" - ], - "nullable": true + "targetFile": { + "$ref": "#/components/schemas/target-file", + "description": "
default
Target file.
", + "x-default-field": true }, - "conditionalCostOperator": { - "type": "string", - "description": "The operator applied between the 'costVariable' and 'operand'.", - "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" - ], - "nullable": true + "languageDirection": { + "$ref": "#/components/schemas/language-direction", + "description": "
default
A language direction.
", + "x-default-field": true }, - "conditionalCostVariable": { + "vendorOrder": { + "$ref": "#/components/schemas/vendor-order", + "description": "
default
A vendor order resource.
", + "x-default-field": true + } + }, + "required": [ + "type" + ] + }, + "task-input-file": { + "title": "Task Input File", + "type": "object", + "description": "Task input file. Based on the \"type\", only the \"sourceFile\" or \"targetFile\" can be retrieved.", + "properties": { + "type": { "type": "string", - "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", "enum": [ - "wordCount", - "runningTotal" + "sourceFile", + "targetFile" ], - "nullable": true + "nullable": true, + "description": "
default
", + "x-default-field": true }, - "conditionalCostThreshold": { - "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", - "type": "number", - "nullable": true + "sourceFile": { + "$ref": "#/components/schemas/source-file", + "description": "
default
Source file.
", + "x-default-field": true }, - "runningTotal": { - "type": "number", - "description": "The sum of all the previously computed costs.", - "nullable": true + "targetFile": { + "$ref": "#/components/schemas/target-file", + "description": "
default
Target file.
", + "x-default-field": true } } }, - "quote-language-cost-request": { - "title": "Quote Language Cost Request", + "task-type": { + "title": "Task Type", "type": "object", + "description": "Task type.", "properties": { - "name": { - "type": "string", - "description": "The name of the additional cost." - }, - "count": { - "type": "number", - "description": "The number of units used to compute the total. Used only for 'volume', 'hourly', 'perPage' and 'percentage' cost types." - }, - "cost": { - "type": "number", - "description": "The cost of a unit." + "id": { + "type": "string" }, - "costType": { + "key": { "type": "string", - "enum": [ - "volume", - "perTargetLanguage", - "perFile", - "hourly", - "percentage", - "perPage", - "conditional" - ], - "description": "The type of the additional cost.", - "nullable": true + "description": "
default
Identifier key for the task.
", + "x-default-field": true }, - "volumeUnitType": { + "name": { "type": "string", - "description": "The unit type of the 'volume' cost, used for counting the units.", - "enum": [ - "words", - "characters" - ], - "nullable": true + "description": "
default
", + "x-default-field": true }, - "targetLanguage": { - "$ref": "#/components/schemas/target-language-request" + "apiInternalId": { + "type": "string", + "x-stoplight": { + "id": "tavwkrljagcmc" + }, + "description": "
default
Unique identifier of custom task types. Null for default task types." }, - "costOrder": { - "type": "integer", - "description": "Indicates the order in which the additional cost is computed." + "description": { + "type": "string" }, - "conditionalCostType": { - "type": "string", - "description": "Describes how the cost of type 'conditional' will be added to total cost.", - "enum": [ - "absolute", - "relative", - "percentage" - ], + "automatic": { + "type": "boolean", + "description": "This indicates whether the task is automatic or human.", "nullable": true }, - "conditionalCostOperator": { + "scope": { "type": "string", - "description": "The operator applied between the 'costVariable' and 'operand'.", + "description": "The resource type scope for the task.", "enum": [ - "less", - "lessOrEqual", - "greater", - "greaterOrEqual" + "file", + "targetLanguage", + "batch", + "vendorOrder", + "task" ], "nullable": true }, - "conditionalCostVariable": { - "type": "string", - "description": "The variable that is evaluated against the 'operand' based on the 'costOperator'.", - "enum": [ - "wordCount", - "runningTotal" - ], - "nullable": true + "outcomes": { + "type": "array", + "items": { + "$ref": "#/components/schemas/task-type-outcome" + } }, - "conditionalCostThreshold": { - "description": "The value that is evaluated against the 'costVariable' based on the 'costOperator'.", - "type": "number" + "location": { + "$ref": "#/components/schemas/folder-v2" } }, "required": [ - "name", - "count", - "cost", - "costOrder", - "conditionalCostThreshold" + "id" ] }, - "quote-translation-cost": { - "title": "Quote Translation Cost", + "task-outcome": { + "title": "Task Outcome", "type": "object", - "description": "Fees calculated based on segment status (new, translated, signed off) and previous leverage (100% match and identical context, 100% match, <100%match, cross-file repetitions).", + "description": "Outcome a task can be completed with. List will be populated after the task is accepted.", "properties": { - "total": { - "type": "number", - "description": "
default
The total cost for the current target language.
", - "nullable": true, + "name": { + "type": "string", + "description": "
default
Outcome to be used with complete endpoint.", "x-default-field": true }, - "targetLanguage": { - "$ref": "#/components/schemas/language" - }, - "exactMatch": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "inContextExactMatch": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "new": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "perfectMatch": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "repetitions": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "machineTranslation": { - "$ref": "#/components/schemas/translation-cost-item" - }, - "fuzzyMatch": { - "type": "array", - "items": { - "$ref": "#/components/schemas/translation-cost-fuzzy-item" - } + "description": { + "type": "string", + "description": "A human-friendly form of the outcome." }, - "runningTotal": { - "type": "number", - "description": "
default
The sum of all the previously computed costs.
", - "nullable": true, + "default": { + "type": "boolean", + "description": "
default
Specifies if the outcome is the default one for the task.", "x-default-field": true } } }, - "quote-update-request": { - "title": "Quote Update Request", - "type": "object", - "properties": { - "languageCosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/quote-language-cost-request" - } - }, - "additionalCosts": { - "type": "array", - "items": { - "$ref": "#/components/schemas/quote-additional-cost-request" - } - }, - "notes": { - "type": "string", - "x-stoplight": { - "id": "404ggz8hrvbpg" - }, - "description": "A message associated with the quote.", - "maxLength": 3000 - } - } - }, - "project-quote-template": { - "title": "Project Quote Template", + "task-type-outcome": { + "title": "Task Type Outcome", "type": "object", - "description": "Project Quote Template resource.", + "description": "The task type outcome.", "properties": { - "id": { - "type": "string", - "description": "The identifier of the quote template." - }, "name": { "type": "string", - "description": "The name of the quote template." + "description": "
default
", + "x-default-field": true }, "description": { - "type": "string", - "description": "The description of the quote template." + "type": "string" }, - "location": { - "$ref": "#/components/schemas/folder-v2" - } - }, - "required": [ - "id" - ], - "x-stoplight": { - "id": "0sp6j7989p1j7" + "default": { + "type": "boolean", + "nullable": true, + "description": "
default
", + "x-default-field": true + } } }, - "project-quote-template-deprecated": { - "title": "Project Quote Template", - "x-stoplight": { - "id": "cwik0w5o34ix6" - }, + "task-configuration-scope": { + "title": "Workflow Task Configuration Scope", "type": "object", - "description": "(Deprecated) moved under settings.general.quoteTemplate", - "deprecated": true, "properties": { - "id": { + "type": { "type": "string", - "description": "The identifier of the quote template." + "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks which are not associated to a target language\n- sourceLanguage: changes affect only the task associated to the source language specified in **sourceLanguage** field\n- targetLanguage: changes affect only the task associated to the target language specified in **targetLanguage** field\n- languageDirection: changes affect only the task associated to the language direction specified in **languageDirection** field", + "enum": [ + "global", + "sourceLanguage", + "targetLanguage", + "languageDirection" + ] }, - "name": { - "type": "string", - "description": "The name of the quote template." + "sourceLanguage": { + "$ref": "#/components/schemas/language" }, - "description": { - "type": "string", - "description": "The description of the quote template." + "targetLanguage": { + "$ref": "#/components/schemas/language" }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "languageDirection": { + "$ref": "#/components/schemas/language-direction-item" } }, "required": [ - "id" + "type" ] }, - "rate-limit": { - "title": "Rate Limit", + "task-configuration-scope-request": { + "title": "Workflow Task Configuration Scope Request", "type": "object", - "description": "Rate Limit entry", + "description": "", "properties": { - "policyName": { + "type": { "type": "string", - "description": "Name of the rate limit policy." + "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks, that are not associated to a target language \n- sourceLanguage: changes affect only the task associated to the source language specified in `sourceLanguage` field. For using this type, must include the `sourceLanguage` field.\n- targetLanguage: changes affect only the task associated to the target language specified in `targetLanguage` field. For using this type, must include the `targetLanguage` field.\n- languageDirection: changes affect only the task associated to the language direction specified in `languageDirection` field. For using this type, must include the `languageDirection` field.", + "enum": [ + "global", + "sourceLanguage", + "targetLanguage", + "languageDirection" + ] }, - "description": { - "type": "string", - "description": "Describes which endpoints are affected by this limit, and for which time frame." + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request" }, - "limit": { - "type": "integer", - "description": "The limit in effect for the endpoint and time frame." + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" }, - "remainingQuota": { - "type": "integer", - "description": "The remaining quota in effect for the endpoint and time frame." + "languageDirection": { + "$ref": "#/components/schemas/language-direction-item" } }, "required": [ - "policyName", - "description", - "limit", - "remainingQuota" + "type" ] }, - "resource-folder-request": { - "title": "Resource Folder Request", + "target-file": { + "title": "Target File", "type": "object", - "description": "Resource folder.", + "description": "Target File.", "properties": { "id": { - "type": "string", - "description": "The folder identifier." + "type": "string" }, "name": { "type": "string", - "description": "The name of the folder." + "description": "
default
The target file name.
", + "x-default-field": true + }, + "languageDirection": { + "$ref": "#/components/schemas/language-direction", + "description": "
default
A basic language direction.
", + "x-default-field": true + }, + "sourceFile": { + "$ref": "#/components/schemas/source-file" + }, + "latestVersion": { + "$ref": "#/components/schemas/target-file-latest-version" + }, + "analysisStatistics": { + "$ref": "#/components/schemas/analysis-statistics" + }, + "status": { + "type": "string", + "description": "Shows if the file is still being processed (inProgress) or if it has been fully processed (finished) by the workflow. A target file is automatically marked as finished by the workflow engine, once there are no more tasks to be performed on it.", + "enum": [ + "inProgress", + "finished", + "canceled" + ], + "nullable": true } }, "required": [ "id" ] }, - "remove-projects-from-group-request": { - "title": "Remove Projects From Group Request", + "target-file-rename-request": { + "title": "Target File Rename Request", "type": "object", - "description": "Input for removing projects from group.", "properties": { - "projects": { - "type": "array", - "description": "The projects to be removed from group.", - "items": { - "$ref": "#/components/schemas/project-group-project-request" - } + "name": { + "type": "string", + "description": "The name of the target file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", + "minLength": 1 } }, "required": [ - "projects" + "name" ] }, - "schedule-template": { - "title": "Schedule Template", - "x-stoplight": { - "id": "c2a2ilce5ag48" - }, + "target-files-update-request": { + "title": "Target Files Update Request", "type": "object", - "description": "Schedule Template resource", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "
default
Schedule Template name.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "Schedule Template description." - }, - "location": { - "$ref": "#/components/schemas/folder-v2" - }, - "configurations": { + "files": { "type": "array", - "x-stoplight": { - "id": "w3yw55a536y3m" - }, "items": { - "$ref": "#/components/schemas/schedule-template-configuration", - "x-stoplight": { - "id": "z1pcd596vxyhe" - } - } - }, - "projectScheduleConfiguration": { - "$ref": "#/components/schemas/schedule-template-project-configuration", - "x-stoplight": { - "id": "jh0as6p6odfm0" + "$ref": "#/components/schemas/target-file-update-request" } } }, "required": [ - "id" + "files" ] }, - "schedule-template-configuration": { - "title": "Schedule Template Configuration", - "x-stoplight": { - "id": "p8wulrz2rytzj" - }, + "target-file-update-request": { + "title": "Target File Update Request", "type": "object", - "description": "Schedule Template Configuration resource", "properties": { - "taskTypeId": { + "id": { "type": "string", - "x-stoplight": { - "id": "ussbf9yycjf0h" - }, - "description": "The identifier of the human task type. " + "description": "The target file identifier.", + "minLength": 1 }, - "taskTypeName": { + "name": { "type": "string", - "x-stoplight": { - "id": "lny75nk7b0g3j" - }, - "description": "The name of the task type." - }, - "schedules": { - "x-stoplight": { - "id": "iu34k91wl2eql" - }, - "type": "array", - "items": { - "$ref": "#/components/schemas/schedule-template-configuration-schedules", - "x-stoplight": { - "id": "j29hssjf8a1nu" - } - } + "description": "The target file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", + "minLength": 1 } }, "required": [ - "taskTypeId" + "id", + "name" ] }, - "schedule-template-project-configuration": { - "title": "Schedule Template Project Configuration", - "x-stoplight": { - "id": "ezrw8kwy2cc2x" - }, + "target-file-version": { + "title": "Target File Version", "type": "object", - "description": "Schedule Template Project Configuration resource", + "description": "Target File Version.", "properties": { - "duration": { - "type": "integer", - "x-stoplight": { - "id": "ml3qutq4qy3km" - }, - "description": "
default
Expressed in minutes.
", - "default": 0, - "minimum": 0 + "id": { + "type": "string", + "description": "The target file version identifier." }, - "reminder": { - "x-stoplight": { - "id": "3z5tzoznv1gci" - }, - "description": "
default
Expressed in minutes.
", + "type": { + "type": "string", "enum": [ - 15, - 30, - 60, - 120, - 480, - 1440, - 2880 - ] + "native", + "bcm" + ], + "description": "
default
The version type.
", + "nullable": true, + "x-default-field": true + }, + "name": { + "type": "string", + "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", + "x-default-field": true + }, + "version": { + "type": "integer", + "description": "A numeric value, incremented for each new version." + }, + "originatingTaskId": { + "type": "string", + "x-stoplight": { + "id": "yxst0hpphv0tq" + }, + "description": "The identifier of the task that generated the file." } - } + }, + "required": [ + "id", + "version" + ] }, - "schedule-template-configuration-request": { - "title": "Schedule Template Configuration Request", + "target-file-latest-version": { + "title": "Target File Latest Version", "x-stoplight": { - "id": "pzjg39ikgktrd" + "id": "0zlvlegfodgta" }, "type": "object", - "description": "Schedule Template Configuration resource", + "description": "Target File Latest Version.", "properties": { - "taskTypeId": { + "id": { "type": "string", - "description": "The identifier of the human task type. " + "description": "The target file version identifier." }, - "schedules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/schedule-template-configuration-schedules" - } + "type": { + "type": "string", + "enum": [ + "native", + "bcm" + ], + "description": "
default
The version type.
", + "nullable": true, + "x-default-field": true + }, + "version": { + "type": "integer", + "description": "A numeric value, incremented for each new version." } }, "required": [ - "taskTypeId" + "id", + "version" ] }, - "schedule-template-configuration-schedules": { - "title": "Schedule Template Configuration Schedules", - "x-stoplight": { - "id": "9kw1yuhfb39q1" + "target-language-request": { + "title": "Target Language Request", + "type": "object", + "properties": { + "languageCode": { + "type": "string", + "description": "The language code." + } }, + "required": [ + "languageCode" + ], + "description": "" + }, + "termbase-template": { + "title": "Termbase Template", "type": "object", - "description": "The Configuration Schedules resource.", + "description": "The termbase template.", "properties": { - "scope": { + "id": { "type": "string", - "x-stoplight": { - "id": "gn25uzdk9mu85" - }, - "description": "The scope of this configuration schedule. \\\r\nglobal -> schedule of the task \\\r\nsourceLanguage -> schedule of the specific task when the sourceLanguage matches this object's sourceLanguage\\\r\nlanguageDirection -> schedule of the specific task when the languageDirection matches this object's languageDirection", - "enum": [ - "global", - "sourceLanguage", - "languageDirection" - ] + "description": "The identifier of the termbase template." }, - "duration": { - "type": "integer", - "x-stoplight": { - "id": "r20a6jq7s4a99" - }, - "description": "Expressed in minutes.", - "minimum": 0 + "name": { + "type": "string", + "description": "
default
The name of the termbase template.
", + "x-default-field": true }, - "reminder": { - "x-stoplight": { - "id": "wa77577h9gchk" - }, - "description": "Expressed in minutes.\r\n\r\n", - "enum": [ - 15, - 30, - 60, - 120, - 480, - 1440, - 2880 - ] + "description": { + "type": "string", + "description": "The description of the termbase template.", + "nullable": true }, - "sourceLanguage": { + "copyright": { "type": "string", - "x-stoplight": { - "id": "x9sswos4516kw" - }, - "example": " \"en-US\", de-DE\"" + "description": "The copyright of the termbase template.", + "nullable": true }, - "targetLanguage": { + "location": { + "$ref": "#/components/schemas/folder-v2", + "description": "
default
The resource folder.
", + "x-default-field": true + }, + "createdAt": { "type": "string", - "x-stoplight": { - "id": "kptfl33vpqdt7" - }, - "example": " \"en-US\", de-DE\"" + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase template was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "type": { + "type": "string", + "description": "The type of the termbase template.", + "enum": [ + "system", + "userDefined" + ] + }, + "languages": { + "type": "array", + "description": "The languages of the termbase template.", + "items": { + "$ref": "#/components/schemas/language" + } + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field" + } } }, "required": [ - "scope" + "id", + "type" ] }, - "schedule-template-update-request": { - "title": "Schedule Template Update Request", - "x-stoplight": { - "id": "eurbufhjxy71a" - }, + "termbase-template-update-request": { + "title": "Termbase Template Update Request", "type": "object", - "description": "Schedule Template update request model", + "description": "The termbase template update request.", "properties": { "name": { "type": "string", - "description": "
Schedule Template name.
", - "maxLength": 50 + "description": "The name of the Termbase template.", + "maxLength": 50, + "minLength": 1 }, "description": { "type": "string", - "description": "Schedule Template description.", - "maxLength": 1000 + "description": "The description of the Termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true }, - "configurations": { + "copyright": { + "type": "string", + "description": "The copyright of the Termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "languages": { "type": "array", - "x-stoplight": { - "id": "nzqkfrvaq8mck" - }, + "description": "The languages of the termbase template.", "items": { - "$ref": "#/components/schemas/schedule-template-configuration-request", - "x-stoplight": { - "id": "kw88kaez7l361" - } + "$ref": "#/components/schemas/language-request" } }, - "projectScheduleConfiguration": { - "$ref": "#/components/schemas/schedule-template-project-configuration", - "x-stoplight": { - "id": "glzz39c8n1mpo" + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-update-request" } } } }, - "schedule-template-create-request": { - "title": "Schedule Template Create Request", - "x-stoplight": { - "id": "nzunuxlururt7" - }, + "termbase-template-create-request": { + "title": "Termbase Template Create Request", "type": "object", - "description": "Schedule Template create request model", + "description": "The termbase template create request.", "properties": { "name": { "type": "string", - "description": "
Schedule Template name.
", + "description": "The name of the termbase template.", + "minLength": 0, "maxLength": 50 }, "description": { "type": "string", - "description": "Schedule Template description.", - "maxLength": 1000 + "description": "The description of the termbase template.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase template.", + "minLength": 0, + "maxLength": 50, + "nullable": true }, "location": { "type": "string", - "x-stoplight": { - "id": "j38jg0ywij0e6" - }, - "description": "The folder identifier where the schedule template should be created. " + "description": "The folder identifier where the termbase template should be created. If not mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." }, - "configurations": { + "languages": { "type": "array", - "x-stoplight": { - "id": "eufab0pne7lzd" - }, + "description": "The languages of the termbase template.", "items": { - "$ref": "#/components/schemas/schedule-template-configuration-request", - "x-stoplight": { - "id": "oxk22epaz3rbi" - } + "$ref": "#/components/schemas/language-request" } }, - "projectScheduleConfiguration": { - "$ref": "#/components/schemas/schedule-template-project-configuration", - "x-stoplight": { - "id": "rqi0t3ue6dm3m" + "fields": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-create-request" } } }, @@ -24203,3943 +27575,4195 @@ "name" ] }, - "simple-language-direction": { - "title": "Simple Language Direction", + "termbase-structure": { + "title": "Termbase Structure", "type": "object", - "description": "A basic language direction.", + "description": "The termbase structure.", "properties": { - "id": { - "type": "string", - "description": "The language direction identifier." - }, - "sourceLanguage": { - "$ref": "#/components/schemas/language", - "description": "
default
The language object.
", + "languages": { + "type": "array", + "description": "
default
The languages of the termbase.
", + "items": { + "$ref": "#/components/schemas/language" + }, "x-default-field": true }, - "targetLanguage": { - "$ref": "#/components/schemas/language", - "description": "
default
The language object.
", + "fields": { + "type": "array", + "description": "
default
The termbase fields. (Not available for List Termbases endpoint).
", + "items": { + "$ref": "#/components/schemas/termbase-field" + }, "x-default-field": true } } }, - "source-file": { - "title": "Source File", + "termbase-structure-create-request": { + "title": "Termbase Structure Create Request", "type": "object", - "description": "Source File.", + "description": "The termbase structure create request.", "properties": { - "id": { - "type": "string" - }, - "name": { - "type": "string", - "description": "
default
The file name.
", - "x-default-field": true - }, - "role": { - "$ref": "#/components/schemas/file-role", - "description": "
default
The file role.
", - "x-default-field": true - }, - "language": { - "$ref": "#/components/schemas/language" - }, - "versions": { + "languages": { "type": "array", - "description": "The source file versions. (Not available for List endpoints).", + "description": "The languages of the termbase. If not supplied, the termbase will be created using the languages from the specified template. Otherwise it will override the languages from the template.", "items": { - "$ref": "#/components/schemas/source-file-version" + "$ref": "#/components/schemas/language-request" } }, - "targetLanguages": { + "fields": { "type": "array", + "description": "Describes the field structure. If not supplied, the termbase will be created using the fields from the specified template. Otherwise it will override the fields from the template.", "items": { - "$ref": "#/components/schemas/language" + "$ref": "#/components/schemas/termbase-field-create-request" + } + } + } + }, + "termbase-structure-update-request": { + "title": "Termbase Structure Update Request", + "type": "object", + "description": "The termbase structure update request.", + "properties": { + "languages": { + "type": "array", + "description": "The languages of the termbase. If not supplied, the termbase will be updated using the languages from the specified template. Otherwise it will override the languages from the template.", + "items": { + "$ref": "#/components/schemas/language-request" } }, - "path": { + "fields": { "type": "array", + "description": "Describes the field structure. If not supplied, the termbase will be updated using the fields from the specified template. Otherwise it will override the fields from the template.", "items": { - "type": "string" + "$ref": "#/components/schemas/termbase-field-update-request" } } - }, - "required": [ - "id" - ] + } }, - "source-file-request": { + "termbase-field": { + "title": "Termbase Field", "type": "object", - "title": "Source File Request", - "description": "Source file properties sent as a JSON inside a text part.", + "description": "The termbase field.", "required": [ - "name", - "role", - "type", - "language" + "id" ], "properties": { + "id": { + "type": "string", + "description": "The identifier of the termbase field." + }, "name": { "type": "string", - "description": "The name of the source file.\n\n\nThe character limit is calculated together with the `path` length.", - "minLength": 1, - "maxLength": 255 + "description": "
default
The name of the termbase field.
", + "x-default-field": true }, - "role": { + "description": { "type": "string", - "enum": [ - "translatable", - "reference", - "unknown" - ], - "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." + "description": "The description of the termbase field", + "nullable": true }, "type": { "type": "string", + "description": "The type of the termbase field - system or userDefined.", "enum": [ - "native", - "bcm", - "sdlxliff" + "system", + "userDefined" + ] + }, + "level": { + "type": "string", + "enum": [ + "entry", + "language", + "term" ], - "description": "The type of the file." + "description": "
default
The level of which this field applies.
", + "x-default-field": true }, - "language": { - "$ref": "#/components/schemas/language-request", - "description": "The language of the file in code 5 (ex. en-US)" + "dataType": { + "type": "string", + "enum": [ + "text", + "double", + "date", + "picklist", + "boolean" + ], + "description": "
default
The data type of the field.
", + "x-default-field": true }, - "targetLanguages": { + "pickListValues": { "type": "array", - "description": "A list of target languages in code 5 (ex. en-US)", + "uniqueItems": false, + "description": "The pick list options. Only if dataType is \"picklist\".", "items": { - "$ref": "#/components/schemas/language-request" + "type": "string" } }, - "path": { - "type": "array", - "description": "Path represents the hierarchy of the source file inside the zip. For example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\", \n \"Finance_2021_dummy_EN.txt\" \n]\n```\n\nThe character limit is calculated together with the `name` length.", - "items": { - "type": "string", - "minLength": 0, - "maxLength": 200 - } + "allowCustomValues": { + "type": "boolean", + "description": "Specifies if the field allows custom values." + }, + "allowMultiple": { + "type": "boolean", + "description": "Specifies if the field can be used multiple times." + }, + "isMandatory": { + "type": "boolean", + "description": "Specifies if the field is mandatory." } } }, - "source-file-rename-request": { - "title": "Source File Rename Request", + "termbase-field-update-request": { + "title": "Termbase Field Update Request", "type": "object", + "description": "The termbase field update request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", "properties": { + "id": { + "type": "string", + "description": "The identifier of the termbase field to updated. If missing will add a new field." + }, "name": { "type": "string", - "description": "The name of the source file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", - "minLength": 1 + "description": "The name of the termbase field. Must be unique.", + "minLength": 1, + "maxLength": 50 }, - "updateTargetFilesName": { - "type": "boolean", - "default": false, - "description": "Option for renaming also the target files." - } - }, - "required": [ - "name" - ] - }, - "source-files-update-request": { - "title": "Source Files Update Request", - "type": "object", - "properties": { - "files": { + "description": { + "type": "string", + "description": "The description of the termbase field.", + "minLength": 1, + "maxLength": 200, + "nullable": true + }, + "level": { + "type": "string", + "enum": [ + "entry", + "language", + "term" + ], + "description": "The level of which this field applies." + }, + "dataType": { + "type": "string", + "enum": [ + "text", + "double", + "date", + "picklist", + "boolean" + ], + "description": "The data type of the field." + }, + "pickListValues": { "type": "array", + "uniqueItems": true, + "description": "The pick list options. Only if dataType is \"picklist\".", "items": { - "$ref": "#/components/schemas/source-file-update-request" + "type": "string", + "minLength": 1, + "maxLength": 1000 } - } - }, - "required": [ - "files" - ] - }, - "source-file-update-request": { - "title": "Source File Update Request", - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The source file identifier.", - "minLength": 1 }, - "name": { - "type": "string", - "description": "The source file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", - "minLength": 1 + "allowCustomValues": { + "type": "boolean", + "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", + "default": false }, - "updateTargetFilesName": { + "allowMultiple": { "type": "boolean", - "default": false, - "description": "Option for renaming the target files too." + "description": "Specifies if the field can be used multiple times.", + "default": true + }, + "isMandatory": { + "type": "boolean", + "description": "Specifies if the field is mandatory.", + "default": false } }, "required": [ - "id", - "name" + "name", + "level", + "dataType" ] }, - "source-file-attachment-request": { - "title": "Source File Attachment Request", - "type": "object", - "description": "", - "properties": { - "sourceFilesAttachment": { - "type": "array", - "description": "List of Attached Source File properties referencing previously uploaded file", - "items": { - "$ref": "#/components/schemas/source-file-attachment-request-item" - } - } - } - }, - "source-file-attachment-response": { - "title": "Source File Attachment Response", - "type": "object", - "description": "", - "properties": { - "sourceFiles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/source-file" - } - } - } - }, - "source-file-attachment-request-item": { - "title": "Source File Attachment Request Item", + "termbase-field-create-request": { + "title": "Termbase Field Create Request", "type": "object", - "description": "Attached Source File properties referencing previously uploaded file", + "description": "The termbase field request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", "properties": { "name": { "type": "string", - "description": "The name of the source file.\n\nThe character limit is calculated together with the `path` length.", + "description": "The name of the termbase field. Must be unique.", + "minLength": 1, + "maxLength": 50 + }, + "description": { + "type": "string", + "description": "The description of the termbase field.", + "minLength": 1, "maxLength": 200, - "minLength": 1 + "nullable": true }, - "role": { + "level": { "type": "string", "enum": [ - "translatable", - "reference", - "unknown" + "entry", + "language", + "term" ], - "description": "The role of the source file. When set to unknown or translatable, the system will try to detect the file type." - }, - "fileUrl": { - "type": "string", - "description": "The identifier of the previously uploaded file." + "description": "The level of which this field applies." }, - "type": { + "dataType": { "type": "string", "enum": [ - "native", - "bcm", - "sdlxliff" + "text", + "double", + "date", + "picklist", + "boolean" ], - "description": "The type of the file." - }, - "language": { - "$ref": "#/components/schemas/source-language-request" - }, - "targetLanguages": { - "type": "array", - "description": "A list of target languages in code 5 (ex. en-US)", - "items": { - "$ref": "#/components/schemas/target-language-request" - } + "description": "The data type of the field." }, - "path": { + "pickListValues": { "type": "array", - "description": "Path represents the hierarchy of the source file inside the zip. For example `/ZipWithFolders/Finance/2021/Finance_2021_dummy_EN.txt` would be sent as: \n\n```json \n\"path\": [ \n \"ZipWithFolders\", \n \"Finance\", \n \"2021\", \n \"Finance_2021_dummy_EN.txt\" \n]\n```\n\nThe character limit is calculated together with the `name` length.", + "uniqueItems": true, + "description": "The pick list values. Only if dataType is \"picklist\". Values must be unique.", "items": { "type": "string", - "maxLength": 200, - "minLength": 0 + "minLength": 1, + "maxLength": 1000 } + }, + "allowCustomValues": { + "type": "boolean", + "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", + "default": false + }, + "allowMultiple": { + "type": "boolean", + "description": "Specifies if the field can be used multiple times.", + "default": true + }, + "isMandatory": { + "type": "boolean", + "description": "Specifies if the field is mandatory.", + "default": false } }, "required": [ "name", - "role", - "fileUrl", - "type", - "language" + "level", + "dataType" ] }, - "source-file-properties-response": { - "title": "Source File Properties Response", + "termbase": { + "title": "Termbase", "type": "object", - "description": "", + "description": "The termbase.", "properties": { - "fileRole": { + "id": { "type": "string", - "description": "The file's role.", - "enum": [ - "translatable", - "reference" - ] + "description": "The identifier of the termbase." }, - "fileTypeSettingsId": { + "name": { "type": "string", - "description": "The file type settings identifier." - } - }, - "required": [ - "fileRole", - "fileTypeSettingsId" - ] - }, - "source-file-properties-update-request": { - "title": "Source File Properties Update Request", - "type": "object", - "description": "", - "properties": { - "fileRole": { + "description": "
default
The name of the termbase.
", + "x-default-field": true + }, + "description": { "type": "string", - "description": "The file role.", - "enum": [ - "translatable", - "reference" - ] + "description": "The description of the termbase.", + "nullable": true }, - "fileTypeSettingsId": { + "copyright": { "type": "string", - "description": "The file type settings identifier." - } - } - }, - "source-file-version-properties-create-request": { - "title": "Source File Version Properties Create Request", - "type": "object", - "description": "", - "properties": { - "type": { + "description": "The copyright of the termbase.", + "nullable": true + }, + "location": { + "$ref": "#/components/schemas/folder-v2", + "description": "
default
The resource folder.
", + "x-default-field": true + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure" + }, + "numberOfEntries": { + "type": "number", + "description": "The number of entries included in the termbase. (Not available for List Termbases endpoint)" + }, + "status": { "type": "string", - "description": "The version type.", "enum": [ - "bcm", - "native" - ] + "ready", + "processingContent", + "exportingContent", + "deletingContent" + ], + "description": "The status of the termbase. (Not available for List Termbases endpoint)" }, - "fileTypeSettingsId": { + "createdAt": { "type": "string", - "description": "The file type settings identifier." + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase was created. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" + }, + "lastModifiedAt": { + "type": "string", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase was last updated. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "format": "date-time" } }, "required": [ - "type" + "id" ] }, - "source-file-version": { - "title": "Source File Version", + "termbase-create-request": { + "title": "Termbase Create Request", "type": "object", - "description": "Source File Version.", + "description": "Termbase create request.", "properties": { - "id": { + "name": { "type": "string", - "description": "The source file version identifier." + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 }, - "type": { + "description": { "type": "string", - "enum": [ - "native", - "bcm" - ], - "description": "
default
The version type.
", - "nullable": true, - "x-default-field": true + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true }, - "name": { + "copyright": { "type": "string", - "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", - "x-default-field": true + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true }, - "version": { - "type": "integer", - "description": "A numeric value, incremented for each new version." + "location": { + "type": "string", + "description": "The folder identifier where the termbase should be created. If not specified, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." }, - "originatingTaskId": { + "termbaseTemplateId": { "type": "string", - "x-stoplight": { - "id": "fsakhiag03gl9" - }, - "description": "The identifier of the task that generated the file." + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-create-request" } }, "required": [ - "id", - "version" + "name" ] }, - "source-file-version-response": { - "title": "Source File Version Response", + "termbase-update-request": { + "title": "Termbase Update Request", "type": "object", - "description": "", + "description": "Termbase update request.", "properties": { - "id": { + "name": { "type": "string", - "description": "The source file version identifier." + "description": "The name of the termbase.", + "minLength": 1, + "maxLength": 50 }, - "type": { + "description": { "type": "string", - "description": "
default
The version type.
", - "enum": [ - "native", - "bcm" - ], - "x-default-field": true + "description": "The description of the termbase.", + "minLength": 0, + "maxLength": 200, + "nullable": true + }, + "copyright": { + "type": "string", + "description": "The copyright of the termbase.", + "minLength": 0, + "maxLength": 50, + "nullable": true + }, + "termbaseTemplateId": { + "type": "string", + "description": "The termbase template identifier." + }, + "termbaseStructure": { + "$ref": "#/components/schemas/termbase-structure-update-request" } - }, - "required": [ - "id" - ] + } }, - "source-language-request": { - "title": "Source Language Request", + "termbase-field-value-link": { + "title": "Termbase Field Value Link", "type": "object", + "description": "The field value link.", "properties": { - "languageCode": { + "type": { "type": "string", - "description": "The language code." + "enum": [ + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." } }, "required": [ - "languageCode" + "type", + "value" ] }, - "target-file-version-properties-create-request": { - "title": "Target File Version Properties Create Request", + "termbase-field-value-link-update-request": { + "title": "Termbase Field Value Link Update Request", "type": "object", - "description": "", + "description": "The field value link update request.", "properties": { "type": { "type": "string", - "description": "The version type.", "enum": [ - "bcm", - "native" - ] + "term", + "entry", + "external" + ], + "description": "The type of the link." + }, + "value": { + "type": "string", + "description": "The value of the link." } - }, - "required": [ - "type" - ] + } }, - "target-file-version-response": { - "title": "Target File Version Response", + "termbase-field-value-link-create-request": { + "title": "Termbase Field Value Link Create Request", "type": "object", - "description": "", + "description": "The field value link create request.", "properties": { - "id": { - "type": "string", - "description": "The target file version identifier." - }, "type": { "type": "string", - "description": "
default
The version type.
", "enum": [ - "native", - "bcm" + "term", + "entry", + "external" ], - "x-default-field": true + "description": "The type of link." + }, + "value": { + "type": "string", + "description": "The value of the link.", + "minLength": 1 } }, "required": [ - "id" + "type", + "value" ] }, - "task": { - "title": "Task", + "termbase-field-value": { + "title": "Termbase Field Value", "type": "object", - "description": "Task.", + "description": "The termbase field value.", "properties": { "id": { - "type": "string" - }, - "status": { "type": "string", - "description": "
default
The task status.
", - "enum": [ - "created", - "inProgress", - "completed", - "failed", - "skipped", - "canceled" - ], - "x-default-field": true, - "nullable": true - }, - "taskType": { - "$ref": "#/components/schemas/task-type" + "description": "The field value identifier." }, - "input": { - "$ref": "#/components/schemas/task-input" + "name": { + "type": "string", + "description": "The field value name." }, - "inputFiles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/task-input-file" - } + "termbaseFieldId": { + "type": "string", + "description": "The termbase field identifier." }, - "owner": { - "$ref": "#/components/schemas/user" + "value": { + "type": "string", + "description": "The value of the field." }, - "assignees": { + "fieldValueLinks": { "type": "array", "items": { - "$ref": "#/components/schemas/task-assignee" + "$ref": "#/components/schemas/termbase-field-value-link" } }, - "dueBy": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The task due date.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"", - "nullable": true - }, "createdAt": { "type": "string", "format": "date-time", "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the task was created.
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\" ", + "description": "The date and time when the termbase field value was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true }, - "applicableOutcomes": { - "type": "array", - "items": { - "$ref": "#/components/schemas/task-outcome" - } - }, - "outcome": { - "type": "string", - "description": "The outcome of the task type. It is retrieved only if the task is completed. It should match one of the legal outcomes in the task type." - }, - "comment": { - "type": "string", - "description": "The comment associated with this task at completion." - }, - "project": { - "$ref": "#/components/schemas/project" - }, - "failedTask": { - "$ref": "#/components/schemas/failed-task" - }, - "completedAt": { - "$ref": "#/components/schemas/date-time", - "description": "The completion timestamp of the task.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sssZ\"" - } - }, - "required": [ - "id" - ] - }, - "task-error": { - "title": "Task Error", - "type": "object", - "description": "Task Error.", - "properties": { - "name": { - "type": "string", - "description": "The task error name." - }, - "code": { - "type": "string", - "description": "The task error code." - }, - "value": { - "type": "string", - "description": "The task error value." - } - } - }, - "task-assignee": { - "title": "Task Assignee", - "type": "object", - "description": "Task assignee. Based on the \"type\", the following properties can be retrieved: \"user\", \"group\" or \"vendorOrderTemplate\". For \"projectCreator\" and \"projectManager\" no other properties are available.", - "properties": { - "type": { - "type": "string", - "enum": [ - "user", - "group", - "vendorOrderTemplate", - "projectCreator" - ], - "description": "Type \"projectCreator\" - reserved for future use. Should be able to handle it and ignore it if received." - }, - "user": { - "$ref": "#/components/schemas/user", - "description": "
default
A user.
", - "x-default-field": true - }, - "group": { - "$ref": "#/components/schemas/group", - "description": "
default
A group of users.
", - "x-default-field": true + "createdBy": { + "$ref": "#/components/schemas/user" }, - "vendorOrderTemplate": { - "$ref": "#/components/schemas/vendor-order-template" + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase field value was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" } }, "required": [ - "type" + "id", + "name", + "termbaseFieldId", + "value" ] }, - "task-assignee-request": { - "title": "Task Assignee Request", + "termbase-field-value-update-request": { + "title": "Termbase Field Value Update request", "type": "object", + "description": "The termbase field value update request.", "properties": { "id": { "type": "string", - "description": "The identifier of the assignee that should correspond to a resource based on the “type” field.
Only required for the `user`, `group`, and `vendorOrderTemplate` types." + "description": "The field value identifier. Either the `id` or the `name` is mandatory to be provided." }, - "type": { + "name": { "type": "string", - "enum": [ - "user", - "group", - "vendorOrderTemplate", - "projectManager", - "projectCreator" - ], - "description": "The assignee type." - } - }, - "required": [ - "type" - ] - }, - "task-assign-request": { - "title": "Task Assign Request", - "type": "object", - "description": "Properties of task assignment.\r\n
Total assignee count is limited. See more at [Maximum number of task assignees](https://docs.rws.com/791595/1137562/trados-enterprise---accelerate/maximum-number-of-task-assignees).", - "properties": { - "assignees": { + "description": "The field value name. Either the `id` or the `name` is mandatory to be provided." + }, + "termbaseFieldId": { + "type": "string", + "description": "The termbase field value identifier. Must match with the fieldId from the termbase." + }, + "value": { + "type": "string", + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { "type": "array", "items": { - "$ref": "#/components/schemas/task-assignee-request" + "$ref": "#/components/schemas/termbase-field-value-link-update-request" } } - } + }, + "required": [ + "termbaseFieldId", + "value" + ] }, - "task-complete-request": { - "title": "Task Complete Request", + "termbase-field-value-create-request": { + "title": "Termbase Field Value Create Request", "type": "object", - "description": "Properties of task completion.", + "description": "The termbase field value create request.", "properties": { - "outcome": { + "termbaseFieldId": { "type": "string", - "description": "The outcome should be one of the valid applicable outcomes of the task. If not specified, the default one will be taken." + "description": "The termbase field identifier. It must match the `fieldId` from the termbase." }, - "comment": { + "value": { "type": "string", - "description": "The comment associated with this task completion.", - "maxLength": 1000 + "description": "The value of the field.", + "minLength": 1, + "maxLength": 4096 + }, + "fieldValueLinks": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-link-create-request" + } } }, "required": [ - "outcome" + "termbaseFieldId", + "value" ] }, - "task-input": { - "title": "Task Input", + "termbase-entry-term": { + "title": "Termbase Entry Term", "type": "object", - "description": "Task input. Based on the \"type\", the following fields can be retrieved: \"project\", \"sourceFile\", \"targetFile\".", + "description": "The termbase entry term.", + "required": [ + "id", + "text" + ], "properties": { - "type": { + "id": { "type": "string", - "description": "The input type.", - "enum": [ - "project", - "sourceFile", - "targetFile", - "languageDirection" - ] + "description": "The term identifier." }, - "project": { - "$ref": "#/components/schemas/project", - "description": "
default
Project resource
", - "x-default-field": true + "text": { + "type": "string", + "description": "The term text." }, - "sourceFile": { - "$ref": "#/components/schemas/source-file", - "description": "
default
Source file.
", - "x-default-field": true + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } }, - "targetFile": { - "$ref": "#/components/schemas/target-file", - "description": "
default
Target file.
", - "x-default-field": true + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true }, - "languageDirection": { - "$ref": "#/components/schemas/language-direction", - "description": "
default
A language direction.
", - "x-default-field": true + "createdBy": { + "$ref": "#/components/schemas/user" }, - "vendorOrder": { - "$ref": "#/components/schemas/vendor-order", - "description": "
default
A vendor order resource.
", - "x-default-field": true - } - }, - "required": [ - "type" - ] - }, - "task-input-file": { - "title": "Task Input File", - "type": "object", - "description": "Task input file. Based on the \"type\", only the \"sourceFile\" or \"targetFile\" can be retrieved.", - "properties": { - "type": { + "lastModifiedAt": { "type": "string", - "enum": [ - "sourceFile", - "targetFile" - ], - "nullable": true, - "description": "
default
", - "x-default-field": true + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the term entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true }, - "sourceFile": { - "$ref": "#/components/schemas/source-file", - "description": "
default
Source file.
", - "x-default-field": true + "lastModifiedBy": { + "$ref": "#/components/schemas/user" }, - "targetFile": { - "$ref": "#/components/schemas/target-file", - "description": "
default
Target file.
", - "x-default-field": true + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status", + "x-stoplight": { + "id": "xx4xvu4isws0c" + } } } }, - "task-type": { - "title": "Task Type", + "termbase-entry-term-update-request": { + "title": "Termbase Entry Term Update Request", "type": "object", - "description": "Task type.", + "description": "The termbase entry term update request.", + "required": [ + "text" + ], "properties": { "id": { - "type": "string" - }, - "key": { "type": "string", - "description": "
default
Identifier key for the task.
", - "x-default-field": true + "description": "The term identifier that will be updated. If not supplied, a new term will be created." }, - "name": { + "text": { "type": "string", - "description": "
default
", - "x-default-field": true + "description": "The term text.", + "minLength": 1, + "maxLength": 1024 }, - "apiInternalId": { - "type": "string", + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", "x-stoplight": { - "id": "tavwkrljagcmc" - }, - "description": "
default
Unique identifier of custom task types. Null for default task types." - }, - "description": { - "type": "string" - }, - "automatic": { - "type": "boolean", - "description": "This indicates whether the task is automatic or human.", - "nullable": true + "id": "lpm4ttzn58ku0" + } }, - "scope": { + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } + } + } + }, + "termbase-term-create-request": { + "title": "Termbase Entry Term Create Request", + "type": "object", + "description": "The termbase entry term request.", + "required": [ + "text" + ], + "properties": { + "text": { "type": "string", - "description": "The resource type scope for the task.", - "enum": [ - "file", - "targetLanguage", - "batch", - "vendorOrder", - "task" - ], - "nullable": true + "description": "The term text.", + "maxLength": 1024, + "minLength": 1 }, - "outcomes": { + "systemStatus": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "cvo2q7bu0gkix" + } + }, + "termbaseFieldValues": { "type": "array", "items": { - "$ref": "#/components/schemas/task-type-outcome" + "$ref": "#/components/schemas/termbase-field-value-create-request" } - }, - "location": { - "$ref": "#/components/schemas/folder-v2" } - }, - "required": [ - "id" - ] + } }, - "task-outcome": { - "title": "Task Outcome", + "termbase-entry-language": { + "title": "Termbase Entry Language", "type": "object", - "description": "Outcome a task can be completed with. List will be populated after the task is accepted.", + "description": "The termbase entry language.", "properties": { - "name": { + "id": { "type": "string", - "description": "
default
Outcome to be used with complete endpoint.", - "x-default-field": true + "description": "The termbase language identifier." }, - "description": { - "type": "string", - "description": "A human-friendly form of the outcome." + "language": { + "$ref": "#/components/schemas/language" }, - "default": { - "type": "boolean", - "description": "
default
Specifies if the outcome is the default one for the task.", - "x-default-field": true - } - } - }, - "task-type-outcome": { - "title": "Task Type Outcome", - "type": "object", - "description": "The task type outcome.", - "properties": { - "name": { + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } + }, + "createdAt": { "type": "string", - "description": "
default
", - "x-default-field": true + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true }, - "description": { - "type": "string" + "createdBy": { + "$ref": "#/components/schemas/user" }, - "default": { - "type": "boolean", - "nullable": true, - "description": "
default
", - "x-default-field": true + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the language entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastModifedBy": { + "$ref": "#/components/schemas/user" } - } + }, + "required": [ + "id", + "language" + ] }, - "task-configuration-scope": { - "title": "Workflow Task Configuration Scope", + "termbase-entry-language-update-request": { + "title": "Termbase Entry Language Update Request", "type": "object", + "description": "The termbase entry language update request.", "properties": { - "type": { + "id": { "type": "string", - "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks which are not associated to a target language\n- sourceLanguage: changes affect only the task associated to the source language specified in **sourceLanguage** field\n- targetLanguage: changes affect only the task associated to the target language specified in **targetLanguage** field\n- languageDirection: changes affect only the task associated to the language direction specified in **languageDirection** field", - "enum": [ - "global", - "sourceLanguage", - "targetLanguage", - "languageDirection" - ] + "description": "The termbase language identifier." }, - "sourceLanguage": { - "$ref": "#/components/schemas/language" + "language": { + "$ref": "#/components/schemas/language-request" }, - "targetLanguage": { - "$ref": "#/components/schemas/language" + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-term-update-request" + } }, - "languageDirection": { - "$ref": "#/components/schemas/language-direction-item" + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } } }, "required": [ - "type" + "language", + "terms" ] }, - "task-configuration-scope-request": { - "title": "Workflow Task Configuration Scope Request", + "termbase-entry-language-create-request": { + "title": "Termbase Entry Language Create Request", "type": "object", - "description": "", + "description": "The termbase entry language create request.", "properties": { - "type": { - "type": "string", - "description": "The applicability impact of the workflow configuration:\n- global: used for global tasks, that are not associated to a target language \n- sourceLanguage: changes affect only the task associated to the source language specified in `sourceLanguage` field. For using this type, must include the `sourceLanguage` field.\n- targetLanguage: changes affect only the task associated to the target language specified in `targetLanguage` field. For using this type, must include the `targetLanguage` field.\n- languageDirection: changes affect only the task associated to the language direction specified in `languageDirection` field. For using this type, must include the `languageDirection` field.", - "enum": [ - "global", - "sourceLanguage", - "targetLanguage", - "languageDirection" - ] - }, - "sourceLanguage": { - "$ref": "#/components/schemas/source-language-request" + "language": { + "$ref": "#/components/schemas/language-request" }, - "targetLanguage": { - "$ref": "#/components/schemas/target-language-request" + "terms": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-term-create-request" + } }, - "languageDirection": { - "$ref": "#/components/schemas/language-direction-item" + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-create-request" + } } }, "required": [ - "type" + "language", + "terms" ] }, - "target-file": { - "title": "Target File", + "termbase-entry": { + "title": "Termbase Entry", "type": "object", - "description": "Target File.", + "description": "The termbase entry.", "properties": { "id": { - "type": "string" + "type": "string", + "description": "The termbase entry identifier." }, - "name": { + "humanReadableId": { "type": "string", - "description": "
default
The target file name.
", - "x-default-field": true + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." }, - "languageDirection": { - "$ref": "#/components/schemas/language-direction", - "description": "
default
A basic language direction.
", - "x-default-field": true + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language" + } }, - "sourceFile": { - "$ref": "#/components/schemas/source-file" + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value" + } }, - "latestVersion": { - "$ref": "#/components/schemas/target-file-latest-version" + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true }, - "analysisStatistics": { - "$ref": "#/components/schemas/analysis-statistics" + "createdBy": { + "$ref": "#/components/schemas/user" }, - "status": { + "lastModifiedAt": { "type": "string", - "description": "Shows if the file is still being processed (inProgress) or if it has been fully processed (finished) by the workflow. A target file is automatically marked as finished by the workflow engine, once there are no more tasks to be performed on it.", - "enum": [ - "inProgress", - "finished", - "canceled" - ], + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The date and time when the termbase entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", "nullable": true + }, + "lastModifiedBy": { + "$ref": "#/components/schemas/user" } }, "required": [ - "id" + "id", + "languages" ] }, - "target-file-rename-request": { - "title": "Target File Rename Request", + "termbase-entry-update-request": { + "title": "Termbase Entry Update Request", "type": "object", + "description": "The termbase entry update request.", "properties": { - "name": { + "humanReadableId": { "type": "string", - "description": "The name of the target file.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", - "minLength": 1 + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-update-request" + } + }, + "termbaseFieldValues": { + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-field-value-update-request" + } } }, "required": [ - "name" + "languages" ] }, - "target-files-update-request": { - "title": "Target Files Update Request", + "termbase-entry-create-request": { + "title": "Termbase Entry Create Request", "type": "object", + "description": "The termbase entry create request.", "properties": { - "files": { + "humanReadableId": { + "type": "string", + "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system.\nThe format of the generated value is not guaranteed." + }, + "languages": { + "description": "The termbase entry languages.", + "type": "array", + "items": { + "$ref": "#/components/schemas/termbase-entry-language-create-request" + } + }, + "termbaseFieldValues": { "type": "array", "items": { - "$ref": "#/components/schemas/target-file-update-request" + "$ref": "#/components/schemas/termbase-field-value-create-request" } } }, "required": [ - "files" + "languages" ] }, - "target-file-update-request": { - "title": "Target File Update Request", + "termbase-entry-term-system-status": { + "title": "Termbase Entry Term System Status", + "type": "string", + "nullable": true, + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-entry-term-system-status-request": { + "title": "Termbase Entry Term System Status", + "type": "string", + "x-stoplight": { + "id": "k477x1xb11mvw" + }, + "enum": [ + "preferred", + "draft", + "inReview", + "deprecated", + "recommended", + "admitted", + "forbidden", + "rejected", + "superseded" + ] + }, + "termbase-export-properties-request": { + "title": "Termbase Export Properties Request", "type": "object", "properties": { - "id": { - "type": "string", - "description": "The target file identifier.", - "minLength": 1 - }, - "name": { - "type": "string", - "description": "The target file name.\\\nThe name should not contain the extension.\\\nUnsupported characters in the name: `<`, `>`, `:`, `\"`, `/`, `\\`, `|`, `?`, `*`.", - "minLength": 1 + "downloadCompressed": { + "type": "boolean", + "description": "Download compressed ( zipped ).", + "default": false } - }, - "required": [ - "id", - "name" - ] + } }, - "target-file-version": { - "title": "Target File Version", + "termbase-export-response": { + "title": "Termbase Export Response", "type": "object", - "description": "Target File Version.", "properties": { "id": { "type": "string", - "description": "The target file version identifier." + "description": "The termbase export identifier." }, - "type": { + "status": { "type": "string", + "description": "The status of the export operation.
\n`queued` - The export passed the structural validation and it's waiting to be processed.
\n`processing` - The export is in progress.
\n`done` - The export was successfully processed .
\n`canceled` - The export process was interrupted.
\n`error` - The export was unsuccessful due to an internal error.", "enum": [ - "native", - "bcm" - ], - "description": "
default
The version type.
", - "nullable": true, - "x-default-field": true + "queued", + "processing", + "done", + "cancelled", + "error" + ] }, - "name": { + "errorMessage": { "type": "string", - "description": "
default
The file version name. This is a synthetic value, typically constructed from the version number and the originating task name.
", - "x-default-field": true - }, - "version": { - "type": "integer", - "description": "A numeric value, incremented for each new version." + "description": "When status is 'error', contains the error message explaining what went wrong." }, - "originatingTaskId": { + "downloadUrl": { "type": "string", - "x-stoplight": { - "id": "yxst0hpphv0tq" - }, - "description": "The identifier of the task that generated the file." + "description": "The url where the file can be downloaded." } }, "required": [ "id", - "version" + "status" ] }, - "target-file-latest-version": { - "title": "Target File Latest Version", - "x-stoplight": { - "id": "0zlvlegfodgta" - }, + "termbase-term": { + "title": "Termbase Term Response", "type": "object", - "description": "Target File Latest Version.", + "description": "The termbase term.", "properties": { "id": { "type": "string", - "description": "The target file version identifier." + "description": "The term identifier." }, - "type": { + "entryId": { "type": "string", - "enum": [ - "native", - "bcm" - ], - "description": "
default
The version type.
", - "nullable": true, - "x-default-field": true + "description": "The entry identifier." }, - "version": { - "type": "integer", - "description": "A numeric value, incremented for each new version." + "text": { + "type": "string", + "description": "The term text." } }, "required": [ "id", - "version" + "entryId", + "text" ] }, - "target-language-request": { - "title": "Target Language Request", - "type": "object", - "properties": { - "languageCode": { - "type": "string", - "description": "The language code." - } - }, - "required": [ - "languageCode" - ], - "description": "" - }, - "termbase-template": { - "title": "Termbase Template", + "termbase-import-response": { + "title": "Termbase Import Response", "type": "object", - "description": "The termbase template.", "properties": { "id": { "type": "string", - "description": "The identifier of the termbase template." - }, - "name": { - "type": "string", - "description": "
default
The name of the termbase template.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "The description of the termbase template.", - "nullable": true - }, - "copyright": { - "type": "string", - "description": "The copyright of the termbase template.", - "nullable": true - }, - "location": { - "$ref": "#/components/schemas/folder-v2", - "description": "
default
The resource folder.
", - "x-default-field": true - }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase template was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "format": "date-time" - }, - "lastModifiedAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase template was modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "format": "date-time" + "description": "The unique identifier of the import operation." }, - "type": { + "status": { "type": "string", - "description": "The type of the termbase template.", + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", "enum": [ - "system", - "userDefined" + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" ] - }, - "languages": { - "type": "array", - "description": "The languages of the termbase template.", - "items": { - "$ref": "#/components/schemas/language" - } - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field" - } } }, "required": [ "id", - "type" + "status" ] }, - "termbase-template-update-request": { - "title": "Termbase Template Update Request", + "termbase-poll-import-response": { + "title": "Termbase Poll Import Response", "type": "object", - "description": "The termbase template update request.", + "description": "The termbase poll import response.
\nThe import was successfully processed when the status is `done`.", "properties": { - "name": { - "type": "string", - "description": "The name of the Termbase template.", - "maxLength": 50, - "minLength": 1 - }, - "description": { + "id": { "type": "string", - "description": "The description of the Termbase template.", - "minLength": 0, - "maxLength": 200, - "nullable": true + "description": "The unique identifier of the import operation." }, - "copyright": { + "status": { "type": "string", - "description": "The copyright of the Termbase template.", - "minLength": 0, - "maxLength": 50, - "nullable": true - }, - "languages": { - "type": "array", - "description": "The languages of the termbase template.", - "items": { - "$ref": "#/components/schemas/language-request" - } - }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-update-request" - } + "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] } - } + }, + "required": [ + "id", + "status" + ] }, - "termbase-template-create-request": { - "title": "Termbase Template Create Request", + "termbase-import-history-response": { + "title": "Termbase Import History Response", "type": "object", - "description": "The termbase template create request.", "properties": { - "name": { - "type": "string", - "description": "The name of the termbase template.", - "minLength": 0, - "maxLength": 50 - }, - "description": { + "id": { "type": "string", - "description": "The description of the termbase template.", - "minLength": 0, - "maxLength": 200, - "nullable": true + "description": "The termbase import identifier." }, - "copyright": { + "fileName": { "type": "string", - "description": "The copyright of the termbase template.", - "minLength": 0, - "maxLength": 50, - "nullable": true + "description": "
default
The file name of the imported file.
", + "x-default-field": true }, - "location": { + "fileSize": { + "type": "integer", + "description": "The file size of the imported file.", + "format": "int64" + }, + "status": { "type": "string", - "description": "The folder identifier where the termbase template should be created. If not mentioned, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + "description": "The status of the import operation.
\n`pending` - The import was just created and it's waiting for user input.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", + "enum": [ + "pending", + "queued", + "processing", + "done", + "cancelled", + "failed", + "error" + ] }, - "languages": { - "type": "array", - "description": "The languages of the termbase template.", - "items": { - "$ref": "#/components/schemas/language-request" - } + "createdAt": { + "$ref": "#/components/schemas/date-time" }, - "fields": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-create-request" - } + "elapsedTime": { + "type": "integer", + "description": "The last modified date of the import." } }, "required": [ - "name" + "id", + "status" ] }, - "termbase-structure": { - "title": "Termbase Structure", + "termbase-import-request": { "type": "object", - "description": "The termbase structure.", + "title": "Termbase Import Properties", + "description": "Properties required for system status mapping", "properties": { - "languages": { - "type": "array", - "description": "
default
The languages of the termbase.
", - "items": { - "$ref": "#/components/schemas/language" - }, - "x-default-field": true - }, - "fields": { + "statusMapping": { "type": "array", - "description": "
default
The termbase fields. (Not available for List Termbases endpoint).
", - "items": { - "$ref": "#/components/schemas/termbase-field" + "x-stoplight": { + "id": "jr1v619dgm5k8" }, - "x-default-field": true - } - } - }, - "termbase-structure-create-request": { - "title": "Termbase Structure Create Request", - "type": "object", - "description": "The termbase structure create request.", - "properties": { - "languages": { - "type": "array", - "description": "The languages of the termbase. If not supplied, the termbase will be created using the languages from the specified template. Otherwise it will override the languages from the template.", - "items": { - "$ref": "#/components/schemas/language-request" - } - }, - "fields": { - "type": "array", - "description": "Describes the field structure. If not supplied, the termbase will be created using the fields from the specified template. Otherwise it will override the fields from the template.", "items": { - "$ref": "#/components/schemas/termbase-field-create-request" + "$ref": "#/components/schemas/termbase-system-status-mapping", + "x-stoplight": { + "id": "jjw6bvzbbc0eg" + } } } } }, - "termbase-structure-update-request": { - "title": "Termbase Structure Update Request", + "termbase-system-status-mapping": { + "title": "Termbase System Status Mapping", + "x-stoplight": { + "id": "3o7f2m7gb63yw" + }, "type": "object", - "description": "The termbase structure update request.", + "description": "A mapping between a termbase term system status and termbase statuses.", + "required": [ + "systemStatusValue", + "statuses" + ], "properties": { - "languages": { - "type": "array", - "description": "The languages of the termbase. If not supplied, the termbase will be updated using the languages from the specified template. Otherwise it will override the languages from the template.", - "items": { - "$ref": "#/components/schemas/language-request" + "systemStatusValue": { + "$ref": "#/components/schemas/termbase-entry-term-system-status-request", + "x-stoplight": { + "id": "kznc76h6wxicr" } }, - "fields": { + "statuses": { "type": "array", - "description": "Describes the field structure. If not supplied, the termbase will be updated using the fields from the specified template. Otherwise it will override the fields from the template.", + "x-stoplight": { + "id": "3isyr4742q3jg" + }, + "minItems": 1, "items": { - "$ref": "#/components/schemas/termbase-field-update-request" + "x-stoplight": { + "id": "6lvylhb8t3n96" + }, + "type": "string" } } } }, - "termbase-field": { - "title": "Termbase Field", + "tqa-profile": { + "title": "TQA Profile", "type": "object", - "description": "The termbase field.", - "required": [ - "id" - ], + "description": "As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document.\n\nThe TQA configuration specifies:\n - Categories and subcategories that reviewers will use to classify the translation issues in a document.\n - Severities to define custom metrics you want to use to assess translation quality.\n - Score to measure the importance of each category or subcategory of an issue.\n - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.", "properties": { "id": { "type": "string", - "description": "The identifier of the termbase field." + "description": "The identifier of the TQA profile." }, "name": { "type": "string", - "description": "
default
The name of the termbase field.
", + "description": "
default
The name of the TQA Profile.
", "x-default-field": true }, "description": { "type": "string", - "description": "The description of the termbase field", - "nullable": true - }, - "type": { - "type": "string", - "description": "The type of the termbase field - system or userDefined.", - "enum": [ - "system", - "userDefined" - ] - }, - "level": { - "type": "string", - "enum": [ - "entry", - "language", - "term" - ], - "description": "
default
The level of which this field applies.
", + "description": "
default
The TQA Profile description.
", "x-default-field": true }, - "dataType": { - "type": "string", - "enum": [ - "text", - "double", - "date", - "picklist", - "boolean" - ], - "description": "
default
The data type of the field.
", + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "passFailThreshold": { + "$ref": "#/components/schemas/tqa-profile-passFailThreshold", + "description": "
default
Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.
", "x-default-field": true }, - "pickListValues": { + "categories": { "type": "array", - "uniqueItems": false, - "description": "The pick list options. Only if dataType is \"picklist\".", + "description": "Categories and subcategories are assessment options that reviewers can use to classify any translation-related issue that they find in a file.", "items": { - "type": "string" + "$ref": "#/components/schemas/tqa-profile-category" } }, - "allowCustomValues": { - "type": "boolean", - "description": "Specifies if the field allows custom values." - }, - "allowMultiple": { - "type": "boolean", - "description": "Specifies if the field can be used multiple times." - }, - "isMandatory": { - "type": "boolean", - "description": "Specifies if the field is mandatory." - } - } - }, - "termbase-field-update-request": { - "title": "Termbase Field Update Request", - "type": "object", - "description": "The termbase field update request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", - "properties": { - "id": { - "type": "string", - "description": "The identifier of the termbase field to updated. If missing will add a new field." - }, - "name": { - "type": "string", - "description": "The name of the termbase field. Must be unique.", - "minLength": 1, - "maxLength": 50 - }, - "description": { - "type": "string", - "description": "The description of the termbase field.", - "minLength": 1, - "maxLength": 200, - "nullable": true - }, - "level": { - "type": "string", - "enum": [ - "entry", - "language", - "term" - ], - "description": "The level of which this field applies." - }, - "dataType": { - "type": "string", - "enum": [ - "text", - "double", - "date", - "picklist", - "boolean" - ], - "description": "The data type of the field." - }, - "pickListValues": { + "severities": { "type": "array", - "uniqueItems": true, - "description": "The pick list options. Only if dataType is \"picklist\".", + "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", "items": { - "type": "string", - "minLength": 1, - "maxLength": 1000 + "$ref": "#/components/schemas/tqa-profile-severity" } }, - "allowCustomValues": { - "type": "boolean", - "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", - "default": false - }, - "allowMultiple": { - "type": "boolean", - "description": "Specifies if the field can be used multiple times.", - "default": true + "scores": { + "type": "array", + "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", + "items": { + "$ref": "#/components/schemas/tqa-profile-score" + } }, - "isMandatory": { - "type": "boolean", - "description": "Specifies if the field is mandatory.", - "default": false + "path": { + "type": "array", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/folder" + } } }, "required": [ - "name", - "level", - "dataType" + "id" ] }, - "termbase-field-create-request": { - "title": "Termbase Field Create Request", + "tqa-profile-category": { + "title": "TQA Profile Category", "type": "object", - "description": "The termbase field request.\n\nIf dataType is `picklist` and pickListValues array is empty `allowCustomValues` must be true.", "properties": { - "name": { + "id": { "type": "string", - "description": "The name of the termbase field. Must be unique.", - "minLength": 1, - "maxLength": 50 + "description": "The category identifier." }, - "description": { + "name": { "type": "string", - "description": "The description of the termbase field.", - "minLength": 1, - "maxLength": 200, - "nullable": true + "description": "
default
The category name.
", + "x-default-field": true }, - "level": { + "description": { "type": "string", - "enum": [ - "entry", - "language", - "term" - ], - "description": "The level of which this field applies." + "description": "The category description." }, - "dataType": { + "abbreviation": { "type": "string", - "enum": [ - "text", - "double", - "date", - "picklist", - "boolean" - ], - "description": "The data type of the field." - }, - "pickListValues": { - "type": "array", - "uniqueItems": true, - "description": "The pick list values. Only if dataType is \"picklist\". Values must be unique.", - "items": { - "type": "string", - "minLength": 1, - "maxLength": 1000 - } - }, - "allowCustomValues": { - "type": "boolean", - "description": "Specifies if the field allows custom values. Must be true if pickListValues is empty.", - "default": false - }, - "allowMultiple": { - "type": "boolean", - "description": "Specifies if the field can be used multiple times.", - "default": true - }, - "isMandatory": { - "type": "boolean", - "description": "Specifies if the field is mandatory.", - "default": false + "description": "The category abbreviation." } - }, - "required": [ - "name", - "level", - "dataType" - ] + } }, - "termbase": { - "title": "Termbase", + "tqa-profile-severity": { + "title": "TQA Profile Severity", "type": "object", - "description": "The termbase.", + "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", "properties": { "id": { "type": "string", - "description": "The identifier of the termbase." + "description": "The severity identifier." }, "name": { "type": "string", - "description": "
default
The name of the termbase.
", + "description": "
default
The severity name.
", "x-default-field": true }, - "description": { + "type": { "type": "string", - "description": "The description of the termbase.", - "nullable": true + "description": "The severity type." + } + } + }, + "tqa-profile-passFailThreshold": { + "title": "TQA Profile PassFailThreshold", + "type": "object", + "description": "Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.", + "properties": { + "points": { + "type": "integer", + "description": "
default
The penalty points.
", + "x-default-field": true }, - "copyright": { + "quantity": { + "type": "integer", + "description": "
default
The quantity against which the points are measured.
", + "x-default-field": true + }, + "scope": { "type": "string", - "description": "The copyright of the termbase.", - "nullable": true + "description": "
default
Words or characters.
", + "x-default-field": true + } + } + }, + "tqa-profile-score": { + "title": "TQA Profile Score", + "type": "object", + "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", + "properties": { + "category": { + "$ref": "#/components/schemas/tqa-profile-category", + "description": "
default
The TQA category.
", + "x-default-field": true }, - "location": { - "$ref": "#/components/schemas/folder-v2", - "description": "
default
The resource folder.
", + "severity": { + "$ref": "#/components/schemas/tqa-profile-severity", + "description": "
default
Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
", "x-default-field": true }, - "termbaseStructure": { - "$ref": "#/components/schemas/termbase-structure" + "penalty": { + "type": "integer", + "description": "
default
The associated penalty for this score's category and severity.
", + "x-default-field": true + } + } + }, + "translation-search-request": { + "title": "Translation Search Request", + "x-stoplight": { + "id": "pfa7dyujl86lv" + }, + "type": "object", + "required": [ + "input", + "languageDirection", + "definition" + ], + "properties": { + "input": { + "$ref": "#/components/schemas/translation-lookup-input-request", + "x-stoplight": { + "id": "gj1t64z5swfgk" + } }, - "numberOfEntries": { - "type": "number", - "description": "The number of entries included in the termbase. (Not available for List Termbases endpoint)" + "languageDirection": { + "$ref": "#/components/schemas/language-direction-general-request", + "x-stoplight": { + "id": "h62z5gy3c4otv" + } }, - "status": { - "type": "string", - "enum": [ - "ready", - "processingContent", - "exportingContent", - "deletingContent" - ], - "description": "The status of the termbase. (Not available for List Termbases endpoint)" + "definition": { + "$ref": "#/components/schemas/translation-definition", + "x-stoplight": { + "id": "f9rodrj2q7z6e" + } }, - "createdAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase was created. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "format": "date-time" + "settings": { + "$ref": "#/components/schemas/translation-search-settings", + "x-stoplight": { + "id": "vkle6tvpl4amf" + } + } + } + }, + "translation-search-response": { + "title": "Translation Search Response", + "x-stoplight": { + "id": "6zhfxtway5o0e" + }, + "type": "object", + "required": [ + "translations" + ], + "properties": { + "translations": { + "type": "array", + "x-stoplight": { + "id": "ags6uqvpedq4l" + }, + "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment.", + "items": { + "$ref": "#/components/schemas/translation", + "x-stoplight": { + "id": "5px5mphkbp2rr" + } + } }, - "lastModifiedAt": { - "type": "string", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase was last updated. (Not available for List Termbases endpoint)
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "format": "date-time" + "appliedResourcesStatus": { + "type": "array", + "x-stoplight": { + "id": "3v56u017sssw8" + }, + "items": { + "$ref": "#/components/schemas/translation-applied-resource-status", + "x-stoplight": { + "id": "gexmk4z2gsbyb" + } + } } + } + }, + "translation-concordance-search-response": { + "title": "Translation Concordance Search Response", + "x-stoplight": { + "id": "6zhfxtway5o0e" }, + "type": "object", "required": [ - "id" - ] + "translations" + ], + "properties": { + "translations": { + "type": "array", + "x-stoplight": { + "id": "ags6uqvpedq4l" + }, + "description": "Translations from different resource origins such as `TM`. The origin information is found in the BCM fragment. Only the top 5 matches are displayed", + "items": { + "$ref": "#/components/schemas/translation-concordance", + "x-stoplight": { + "id": "5px5mphkbp2rr" + } + } + }, + "appliedResourcesStatus": { + "type": "array", + "x-stoplight": { + "id": "3v56u017sssw8" + }, + "items": { + "$ref": "#/components/schemas/translation-concordance-search-applied-resource-status", + "x-stoplight": { + "id": "gexmk4z2gsbyb" + } + } + } + } }, - "termbase-create-request": { - "title": "Termbase Create Request", + "translation-unit-add-update-response": { + "title": "Translation Unit Response", + "type": "object", + "required": [ + "success" + ], + "properties": { + "success": { + "type": "boolean", + "description": "A flag indicating whether the overall operation was successful executed" + }, + "insights": { + "type": "array", + "description": "
default
The operation insights.
", + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/translation-unit-insight-model" + } + }, + "errorInsights": { + "type": "array", + "description": "
default
The operation error insights.
", + "x-default-field": true, + "items": { + "$ref": "#/components/schemas/translation-error-detail-response" + } + } + } + }, + "translation-unit-insight-model": { + "title": "Translation Unit Insight Model", + "type": "object", + "description": "Detailed insight information about the processed translation unit.", + "required": [ + "resourceId", + "translationHash", + "action" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "The translation memory identifier." + }, + "translationHash": { + "type": "string", + "description": "The translation unit hash code." + }, + "action": { + "type": "string", + "description": "The action performed", + "enum": [ + "discard", + "add", + "merge", + "overwrite", + "error", + "delete" + ] + } + } + }, + "translation-unit-resource-type": { + "title": "Translation Unit Resource Type", + "type": "string", + "description": "Enumeration of available translation unit resource types.", + "enum": [ + "TM" + ] + }, + "translation-applied-resource-status": { + "title": "Translation Applied Resource Status", + "x-stoplight": { + "id": "l8qfj2wt8ex3q" + }, "type": "object", - "description": "Termbase create request.", "properties": { - "name": { - "type": "string", - "description": "The name of the termbase.", - "minLength": 1, - "maxLength": 50 - }, - "description": { + "resourceId": { "type": "string", - "description": "The description of the termbase.", - "minLength": 0, - "maxLength": 200, - "nullable": true + "x-stoplight": { + "id": "ijitw3244ojkf" + }, + "description": "
default
The resource identifier." }, - "copyright": { - "type": "string", - "description": "The copyright of the termbase.", - "minLength": 0, - "maxLength": 50, - "nullable": true + "resourceType": { + "$ref": "#/components/schemas/translation-resource-type", + "x-stoplight": { + "id": "3y8wplo4peutt" + }, + "description": "
default
The type of resource applied." }, - "location": { + "status": { + "x-stoplight": { + "id": "vacv71ru214af" + }, "type": "string", - "description": "The folder identifier where the termbase should be created. If not specified, it will be created in the Root folder. If the user does not have access in Root, the request will fail with forbidden error." + "enum": [ + "successful", + "unsuccessful" + ], + "description": "
default
The status of the applied resource." }, - "termbaseTemplateId": { + "message": { "type": "string", - "description": "The termbase template identifier." + "x-stoplight": { + "id": "wj0qjf9jfalmv" + }, + "description": "A message describing the applied resource." }, - "termbaseStructure": { - "$ref": "#/components/schemas/termbase-structure-create-request" + "translationErrors": { + "type": "array", + "x-stoplight": { + "id": "o91qwrova4eay" + }, + "description": "Details of possible errors.", + "items": { + "$ref": "#/components/schemas/translation-error-detail-response", + "x-stoplight": { + "id": "rllzog6wfm1te" + } + } } - }, - "required": [ - "name" - ] + } }, - "termbase-update-request": { - "title": "Termbase Update Request", + "translation-concordance-search-applied-resource-status": { + "title": "Translation Concordance Search Applied Resource Status", + "x-stoplight": { + "id": "l8qfj2wt8ex3q" + }, "type": "object", - "description": "Termbase update request.", "properties": { - "name": { + "resourceId": { "type": "string", - "description": "The name of the termbase.", - "minLength": 1, - "maxLength": 50 + "x-stoplight": { + "id": "ijitw3244ojkf" + }, + "description": "
default
The resource identifier." }, - "description": { + "resourceType": { "type": "string", - "description": "The description of the termbase.", - "minLength": 0, - "maxLength": 200, - "nullable": true + "x-stoplight": { + "id": "3y8wplo4peutt" + }, + "description": "
default
The type of resource applied.", + "enum": [ + "TM" + ] }, - "copyright": { + "status": { + "x-stoplight": { + "id": "vacv71ru214af" + }, "type": "string", - "description": "The copyright of the termbase.", - "minLength": 0, - "maxLength": 50, - "nullable": true + "enum": [ + "successful", + "unsuccessful" + ], + "description": "
default
The status of the applied resource." }, - "termbaseTemplateId": { + "message": { "type": "string", - "description": "The termbase template identifier." + "x-stoplight": { + "id": "wj0qjf9jfalmv" + }, + "description": "A message describing the applied resource." }, - "termbaseStructure": { - "$ref": "#/components/schemas/termbase-structure-update-request" + "translationErrors": { + "type": "array", + "x-stoplight": { + "id": "o91qwrova4eay" + }, + "description": "Details of possible errors.", + "items": { + "$ref": "#/components/schemas/translation-error-detail-response", + "x-stoplight": { + "id": "rllzog6wfm1te" + } + } } } }, - "termbase-field-value-link": { - "title": "Termbase Field Value Link", + "translation-definition": { + "title": "Translation Definition", + "x-stoplight": { + "id": "1ajyhlvlclubb" + }, "type": "object", - "description": "The field value link.", + "required": [ + "translationEngineId" + ], "properties": { - "type": { - "type": "string", - "enum": [ - "term", - "entry", - "external" - ], - "description": "The type of the link." - }, - "value": { + "translationEngineId": { "type": "string", - "description": "The value of the link." + "x-stoplight": { + "id": "546wr95sonkhe" + }, + "description": "The translation engine identifier." } - }, - "required": [ - "type", - "value" - ] + } }, - "termbase-field-value-link-update-request": { - "title": "Termbase Field Value Link Update Request", + "translation-concordance-search-definition": { + "title": "Translation Concordance Search Definition", + "x-stoplight": { + "id": "1ajyhlvlclubb" + }, "type": "object", - "description": "The field value link update request.", + "required": [ + "translationEngineId" + ], "properties": { - "type": { + "translationEngineId": { "type": "string", - "enum": [ - "term", - "entry", - "external" - ], - "description": "The type of the link." - }, - "value": { - "type": "string", - "description": "The value of the link." + "x-stoplight": { + "id": "546wr95sonkhe" + }, + "description": "The translation engine identifier." } } }, - "termbase-field-value-link-create-request": { - "title": "Termbase Field Value Link Create Request", + "translation-resource": { + "title": "Translation Resource", + "x-stoplight": { + "id": "vrs494q2buzhy" + }, "type": "object", - "description": "The field value link create request.", + "required": [ + "resourceId", + "type" + ], "properties": { - "type": { + "resourceId": { "type": "string", - "enum": [ - "term", - "entry", - "external" - ], - "description": "The type of link." + "x-stoplight": { + "id": "1wr6q3uu0ow0s" + }, + "description": "The resource identifier." }, - "value": { - "type": "string", - "description": "The value of the link.", - "minLength": 1 + "type": { + "$ref": "#/components/schemas/translation-resource-type", + "x-stoplight": { + "id": "mn8n0t9bwutha" + } } + } + }, + "translation-resource-type": { + "title": "Translation Resource Type", + "type": "string", + "x-stoplight": { + "id": "zr6udmd1g99q4" }, - "required": [ - "type", - "value" + "description": "The translation resource type", + "enum": [ + "TM", + "MT", + "TB" ] }, - "termbase-field-value": { - "title": "Termbase Field Value", + "translation-concordance-resource-type": { + "title": "Translation Resource Type", + "type": "string", + "x-stoplight": { + "id": "zr6udmd1g99q4" + }, + "description": "The translation resource type", + "enum": [ + "TM" + ] + }, + "translation": { + "title": "Translation", + "x-stoplight": { + "id": "a0g18gy80z5p1" + }, "type": "object", - "description": "The termbase field value.", + "required": [ + "translationProposal", + "resourceType" + ], "properties": { - "id": { - "type": "string", - "description": "The field value identifier." - }, - "name": { - "type": "string", - "description": "The field value name." - }, - "termbaseFieldId": { - "type": "string", - "description": "The termbase field identifier." - }, - "value": { + "translationProposal": { "type": "string", - "description": "The value of the field." + "x-stoplight": { + "id": "siqg2y0t0s38m" + }, + "description": "The translation content serialized as JSON. BCM fragment for `TM` and `MT`. BCM term for `TB`." }, - "fieldValueLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-link" + "resourceType": { + "$ref": "#/components/schemas/translation-resource-type", + "x-stoplight": { + "id": "gkon15o12wfc8" } }, - "createdAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase field value was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "createdBy": { - "$ref": "#/components/schemas/user" - }, - "lastModifiedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase field value was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "lastModifiedBy": { - "$ref": "#/components/schemas/user" + "sourceLocation": { + "$ref": "#/components/schemas/translation-source-locations", + "description": "The source location is only available for `TB`." } + } + }, + "translation-concordance": { + "title": "Translation", + "x-stoplight": { + "id": "a0g18gy80z5p1" }, + "type": "object", "required": [ - "id", - "name", - "termbaseFieldId", - "value" - ] + "translationProposal", + "resourceType" + ], + "properties": { + "translationProposal": { + "type": "string", + "x-stoplight": { + "id": "siqg2y0t0s38m" + }, + "description": "The translation content serialized as JSON. BCM fragment for `TM`." + }, + "resourceType": { + "$ref": "#/components/schemas/translation-concordance-resource-type", + "x-stoplight": { + "id": "gkon15o12wfc8" + } + } + } + }, + "translation-source-locations": { + "title": "sourceLocations", + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-source-location" + } + }, + "translation-source-location": { + "title": "sourceLocation", + "type": "object", + "properties": { + "start": { + "type": "integer" + }, + "length": { + "type": "integer" + } + } }, - "termbase-field-value-update-request": { - "title": "Termbase Field Value Update request", + "translation-concordance-search-request": { + "title": "Translation Concordance Search Request", + "x-stoplight": { + "id": "mu51b39komenk" + }, "type": "object", - "description": "The termbase field value update request.", + "required": [ + "input", + "languageDirection", + "definition" + ], "properties": { - "id": { - "type": "string", - "description": "The field value identifier. Either the `id` or the `name` is mandatory to be provided." + "input": { + "$ref": "#/components/schemas/translation-concordance-input-request", + "x-stoplight": { + "id": "15af4h5jkfyvj" + } }, - "name": { - "type": "string", - "description": "The field value name. Either the `id` or the `name` is mandatory to be provided." + "languageDirection": { + "$ref": "#/components/schemas/language-direction-general-request", + "x-stoplight": { + "id": "o84ns9q1ulxkz" + } }, - "termbaseFieldId": { - "type": "string", - "description": "The termbase field value identifier. Must match with the fieldId from the termbase." + "definition": { + "$ref": "#/components/schemas/translation-concordance-search-definition", + "x-stoplight": { + "id": "d6yrwalewio7h" + } }, - "value": { - "type": "string", - "description": "The value of the field.", - "minLength": 1, - "maxLength": 4096 + "targetOnly": { + "type": "boolean", + "x-stoplight": { + "id": "ffjvv0xao6ykz" + }, + "default": false, + "description": "Indicates whether the search should be performed only in the target segments." }, - "fieldValueLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-link-update-request" + "settings": { + "$ref": "#/components/schemas/concordance-search-settings", + "x-stoplight": { + "id": "49cht6969uysn" } } - }, - "required": [ - "termbaseFieldId", - "value" - ] + } }, - "termbase-field-value-create-request": { - "title": "Termbase Field Value Create Request", + "translation-add-request": { + "title": "Translation Add Request", + "x-stoplight": { + "id": "44r5oq5khi1fs" + }, "type": "object", - "description": "The termbase field value create request.", + "required": [ + "input", + "definition" + ], "properties": { - "termbaseFieldId": { - "type": "string", - "description": "The termbase field identifier. It must match the `fieldId` from the termbase." + "input": { + "$ref": "#/components/schemas/translation-tu-update-input-request", + "x-stoplight": { + "id": "4an4r6b9854aq" + } }, - "value": { - "type": "string", - "description": "The value of the field.", - "minLength": 1, - "maxLength": 4096 + "definition": { + "$ref": "#/components/schemas/translation-update-definition", + "x-stoplight": { + "id": "rv8rlalk5d2a7" + } }, - "fieldValueLinks": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-link-create-request" + "settings": { + "$ref": "#/components/schemas/translation-add-settings", + "x-stoplight": { + "id": "uy8l353n2uh3g" } } - }, - "required": [ - "termbaseFieldId", - "value" - ] + } }, - "termbase-entry-term": { - "title": "Termbase Entry Term", + "translation-update-request": { + "title": "Translation Update Request", + "x-stoplight": { + "id": "44r5oq5khi1fs" + }, "type": "object", - "description": "The termbase entry term.", + "required": [ + "input", + "definition" + ], "properties": { - "id": { - "type": "string", - "description": "The term identifier." + "input": { + "$ref": "#/components/schemas/translation-tu-update-input-request", + "x-stoplight": { + "id": "4an4r6b9854aq" + } }, - "text": { - "type": "string", - "description": "The term text." + "definition": { + "$ref": "#/components/schemas/translation-update-definition", + "x-stoplight": { + "id": "rv8rlalk5d2a7" + } }, - "termbaseFieldValues": { + "settings": { + "$ref": "#/components/schemas/translation-update-settings", + "x-stoplight": { + "id": "uy8l353n2uh3g" + } + } + } + }, + "translation-add-settings": { + "title": "Translation Add Settings", + "x-stoplight": { + "id": "4rfs3hgmqnjnl" + }, + "type": "object", + "properties": { + "fields": { + "x-stoplight": { + "id": "q2x1e7tqb6bjj" + }, "type": "array", + "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.", "items": { - "$ref": "#/components/schemas/termbase-field-value" + "$ref": "#/components/schemas/translation-update-field", + "x-stoplight": { + "id": "zrkulmef1pa37" + } } }, - "createdAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the term entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "createdBy": { - "$ref": "#/components/schemas/user" - }, - "lastModifiedAt": { + "ifTargetSegmentsDiffer": { + "x-stoplight": { + "id": "9kr4dv5q5yko5" + }, "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the term entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "lastModifiedBy": { - "$ref": "#/components/schemas/user" + "enum": [ + "addNew", + "overwrite", + "leaveUnchanged", + "keepMostRecent", + "merge" + ], + "description": "Update behavior when the translation unit already exists but target differs." } - }, - "required": [ - "id", - "text" - ] + } }, - "termbase-entry-term-update-request": { - "title": "Termbase Entry Term Update Request", + "translation-update-settings": { + "title": "Translation Update Settings", + "x-stoplight": { + "id": "4rfs3hgmqnjnl" + }, "type": "object", - "description": "The termbase entry term update request.", "properties": { - "id": { - "type": "string", - "description": "The term identifier that will be updated. If not supplied, a new term will be created." - }, - "text": { - "type": "string", - "description": "The term text.", - "minLength": 1, - "maxLength": 1024 - }, - "termbaseFieldValues": { + "fields": { + "x-stoplight": { + "id": "q2x1e7tqb6bjj" + }, "type": "array", + "description": "The Translation Unit fields to update. They are defined in the Field Template associated to your Translation Memory.", "items": { - "$ref": "#/components/schemas/termbase-field-value-update-request" + "$ref": "#/components/schemas/translation-update-field", + "x-stoplight": { + "id": "zrkulmef1pa37" + } } } + } + }, + "translation-update-resource": { + "title": "Translation Update Resource", + "x-stoplight": { + "id": "kk5sxng7r7rcv" }, + "type": "object", "required": [ - "text" - ] + "resourceId", + "type" + ], + "properties": { + "resourceId": { + "type": "string", + "x-stoplight": { + "id": "ht1329zmz3hgp" + }, + "description": "The resource identifier." + }, + "type": { + "x-stoplight": { + "id": "dmov4sqorfrf3" + }, + "type": "string", + "enum": [ + "TM" + ], + "description": "The translation resource type." + } + } }, - "termbase-term-create-request": { - "title": "Termbase Entry Term Create Request", + "translation-cost-item": { + "title": "Translation Cost Item", "type": "object", - "description": "The termbase entry term request.", "properties": { - "text": { - "type": "string", - "description": "The term text.", - "maxLength": 1024, - "minLength": 1 + "count": { + "type": "number", + "description": "
default
The total number of units.
", + "nullable": true, + "x-default-field": true + }, + "rate": { + "type": "number", + "description": "
default
The cost of a unit.
", + "nullable": true, + "x-default-field": true + }, + "total": { + "type": "number", + "description": "
default
The total cost for the current item.
", + "nullable": true, + "x-default-field": true + }, + "runningTotal": { + "type": "number", + "description": "
default
The sum of all the previously computed costs.
", + "nullable": true, + "x-default-field": true + } + } + }, + "translation-cost-fuzzy-item": { + "title": "Translation Cost Fuzzy Item", + "type": "object", + "properties": { + "count": { + "type": "number", + "description": "
default
The total number of units.
", + "nullable": true, + "x-default-field": true + }, + "rate": { + "type": "number", + "description": "
default
The cost of a unit.
", + "nullable": true, + "x-default-field": true + }, + "total": { + "type": "number", + "description": "
default
The total cost for the current item.
", + "nullable": true, + "x-default-field": true + }, + "runningTotal": { + "type": "number", + "description": "
default
The sum of all the previously computed costs.
", + "nullable": true, + "x-default-field": true }, - "termbaseFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-create-request" - } + "fuzzyCategory": { + "$ref": "#/components/schemas/fuzzy-category", + "description": "
default
Fuzzy category range.
", + "x-default-field": true } - }, - "required": [ - "text" - ] + } }, - "termbase-entry-language": { - "title": "Termbase Entry Language", + "translation-engine": { + "title": "Translation Engine", "type": "object", - "description": "The termbase entry language.", + "description": "Translation Engine resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", - "description": "The termbase language identifier." - }, - "language": { - "$ref": "#/components/schemas/language" - }, - "terms": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-entry-term" - } - }, - "termbaseFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value" - } + "description": "The translation engine identifier." }, - "createdAt": { + "name": { "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the language entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true + "description": "
default
The translation engine name.
", + "x-default-field": true }, - "createdBy": { - "$ref": "#/components/schemas/user" + "description": { + "type": "string" }, - "lastModifiedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the language entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true + "location": { + "$ref": "#/components/schemas/folder-v2" }, - "lastModifedBy": { - "$ref": "#/components/schemas/user" + "definition": { + "$ref": "#/components/schemas/translation-engine-definition" } }, "required": [ - "id", - "language" + "id" ] }, - "termbase-entry-language-update-request": { - "title": "Termbase Entry Language Update Request", + "translation-engine-update-request": { + "title": "Translation Engine Update Request", + "x-stoplight": { + "id": "qjks6cvd5ej43" + }, "type": "object", - "description": "The termbase entry language update request.", + "description": "Translation Engine resource update request", "properties": { - "id": { + "name": { "type": "string", - "description": "The termbase language identifier." - }, - "language": { - "$ref": "#/components/schemas/language-request" + "description": "
default
The translation engine name.
", + "x-default-field": true, + "minLength": 1, + "maxLength": 50 }, - "terms": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-entry-term-update-request" - } + "description": { + "type": "string", + "x-stoplight": { + "id": "h2kzvu2xlq1dh" + }, + "maxLength": 1000 }, - "termbaseFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-update-request" + "definition": { + "$ref": "#/components/schemas/translation-engine-definition", + "x-stoplight": { + "id": "gesu0kld6jyxg" } } - }, - "required": [ - "language", - "terms" - ] + } }, - "termbase-entry-language-create-request": { - "title": "Termbase Entry Language Create Request", + "translation-engine-definition": { + "title": "Translation Engine Definition", + "x-stoplight": { + "id": "yb3ai5ltnbu49" + }, "type": "object", - "description": "The termbase entry language create request.", + "description": "The definition of a translation engine.", + "required": [ + "languageProcessingRuleId" + ], "properties": { - "language": { - "$ref": "#/components/schemas/language-request" + "languageProcessingRuleId": { + "type": "string" }, - "terms": { - "type": "array", + "languagePairDefinitions": { + "type": [ + "array" + ], + "x-stoplight": { + "id": "891hvyzbxnaqm" + }, "items": { - "$ref": "#/components/schemas/termbase-term-create-request" + "$ref": "#/components/schemas/translation-engine-definition-language-pair", + "x-stoplight": { + "id": "nbfh6uvky8c4o" + } } }, - "termbaseFieldValues": { - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-field-value-create-request" - } + "sequence": { + "$ref": "#/components/schemas/remote-translation-engine-sequence" } - }, - "required": [ - "language", - "terms" - ] + } }, - "termbase-entry": { - "title": "Termbase Entry", - "type": "object", - "description": "The termbase entry.", + "remote-translation-engine-sequence": { + "title": "Translation Engine Sequence", + "description": "Lists of IDs for Translation Memories, Termbases, Machine Translations and Large Language Models, in order of their use", "properties": { - "id": { - "type": "string", - "description": "The termbase entry identifier." - }, - "humanReadableId": { - "type": "string", - "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." - }, - "languages": { - "description": "The termbase entry languages.", + "tm":{ "type": "array", + "description": "Translation Memories", "items": { - "$ref": "#/components/schemas/termbase-entry-language" + "type": "string" } }, - "termbaseFieldValues": { + "tb":{ "type": "array", + "description": "Termbases", "items": { - "$ref": "#/components/schemas/termbase-field-value" + "type": "string" } }, - "createdAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase entry was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "createdBy": { - "$ref": "#/components/schemas/user" - }, - "lastModifiedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The date and time when the termbase entry was last modified.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true + "mt":{ + "type": "array", + "description": "Machine Translations", + "items":{ + "type": "string" + } }, - "lastModifiedBy": { - "$ref": "#/components/schemas/user" + "llm":{ + "type": "array", + "description": "Large Language Models", + "items": { + "type": "string" + } } - }, - "required": [ - "id", - "languages" - ] + } }, - "termbase-entry-update-request": { - "title": "Termbase Entry Update Request", + "translation-engine-definition-language-pair": { + "title": "Language Pair Definition", + "x-stoplight": { + "id": "isibhifp9qrao" + }, "type": "object", - "description": "The termbase entry update request.", "properties": { - "humanReadableId": { - "type": "string", - "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system. The format of the generated value is not guaranteed." - }, - "languages": { - "description": "The termbase entry languages.", - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-entry-language-update-request" + "languagePair": { + "$ref": "#/components/schemas/language-pair", + "x-stoplight": { + "id": "ixoi0dqka8bkw" } }, - "termbaseFieldValues": { + "resources": { "type": "array", + "x-stoplight": { + "id": "foi4rdwsrevkj" + }, "items": { - "$ref": "#/components/schemas/termbase-field-value-update-request" + "$ref": "#/components/schemas/language-pair-resource", + "x-stoplight": { + "id": "d2b4btupa9mu1" + } } } }, "required": [ - "languages" + "languagePair", + "resources" ] }, - "termbase-entry-create-request": { - "title": "Termbase Entry Create Request", + "translation-memory-field": { + "title": "Translation Memory Field", "type": "object", - "description": "The termbase entry create request.", + "description": "The unique identifier of the field.", "properties": { - "humanReadableId": { + "id": { "type": "string", - "description": "An identifier that can be provided externally, or generated automatically by the Trados Cloud Platform, used for creating cross-references. You can use it to set its value to be correlated to your system.\nThe format of the generated value is not guaranteed." + "description": "The unique identifier of the field." }, - "languages": { - "description": "The termbase entry languages.", - "type": "array", - "items": { - "$ref": "#/components/schemas/termbase-entry-language-create-request" - } + "name": { + "type": "string", + "description": "
default
The name of the field.
", + "x-default-field": true + }, + "type": { + "type": "string", + "enum": [ + "unknown", + "singleString", + "multipleString", + "dateTime", + "singlePicklist", + "multiplePicklist", + "integer" + ], + "description": "The data type of the field." }, - "termbaseFieldValues": { + "values": { "type": "array", + "description": "A collection of values for this field.", "items": { - "$ref": "#/components/schemas/termbase-field-value-create-request" + "$ref": "#/components/schemas/translation-memory-field-value" } } }, "required": [ - "languages" + "id" ] }, - "termbase-export-properties-request": { - "title": "Termbase Export Properties Request", + "translation-memory-fields": { + "title": "Translation Memory Fields", "type": "object", "properties": { - "downloadCompressed": { - "type": "boolean", - "description": "Download compressed ( zipped ).", - "default": false + "settings": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-memory-fields-settings" + }, + "description": "
default
", + "x-default-field": true } } }, - "termbase-export-response": { - "title": "Termbase Export Response", + "translation-memory-field-template": { + "title": "Translation Memory Field Template", "type": "object", "properties": { "id": { "type": "string", - "description": "The termbase export identifier." + "description": "The unique identifier of the translation memory field template." }, - "status": { + "name": { "type": "string", - "description": "The status of the export operation.
\n`queued` - The export passed the structural validation and it's waiting to be processed.
\n`processing` - The export is in progress.
\n`done` - The export was successfully processed .
\n`canceled` - The export process was interrupted.
\n`error` - The export was unsuccessful due to an internal error.", - "enum": [ - "queued", - "processing", - "done", - "cancelled", - "error" - ] + "description": "
default
The name of the field template.
", + "x-default-field": true }, - "errorMessage": { + "description": { "type": "string", - "description": "When status is 'error', contains the error message explaining what went wrong." + "description": "The field template description." }, - "downloadUrl": { - "type": "string", - "description": "The url where the file can be downloaded." + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "fieldDefinitions": { + "type": "array", + "description": "A collection of translation memory fields.", + "items": { + "$ref": "#/components/schemas/translation-memory-field" + } } }, "required": [ - "id", - "status" + "id" ] }, - "termbase-term": { - "title": "Termbase Term Response", + "translation-memory-field-value": { + "title": "Translation Memory Field Value", "type": "object", - "description": "The termbase term.", "properties": { "id": { "type": "string", - "description": "The term identifier." - }, - "entryId": { - "type": "string", - "description": "The entry identifier." + "description": "The unique identifier associated with this value." }, - "text": { + "value": { "type": "string", - "description": "The term text." + "description": "A translation memory field value." } }, "required": [ - "id", - "entryId", - "text" + "id" ] }, - "termbase-import-response": { - "title": "Termbase Import Response", + "translation-memory": { + "title": "Translation Memory", "type": "object", + "description": "", "properties": { "id": { "type": "string", - "description": "The unique identifier of the import operation." + "description": "Unique identifier of the translation memory." }, - "status": { + "name": { "type": "string", - "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", - "enum": [ - "queued", - "processing", - "done", - "cancelled", - "failed", - "error" - ] + "description": "
default
The translation memory name.
", + "x-default-field": true + }, + "description": { + "type": "string", + "description": "The translation memory description." + }, + "copyright": { + "type": "string" + }, + "location": { + "$ref": "#/components/schemas/folder" + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/translation-memory-language-direction" + }, + "description": "
default
A collection of language directions
", + "x-default-field": true + }, + "languageProcessingRule": { + "$ref": "#/components/schemas/language-processing-rule" + }, + "fieldTemplate": { + "$ref": "#/components/schemas/translation-memory-field-template" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" + }, + "lastRecomputedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory statistics were last updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true + }, + "lastReIndexedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The `DateTime` when the translation memory reindexing was performed.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", + "nullable": true } }, "required": [ - "id", - "status" + "id" ] }, - "termbase-poll-import-response": { - "title": "Termbase Poll Import Response", + "translation-memory-fields-update-request": { + "title": "Translation Memory Fields Update Request", + "x-stoplight": { + "id": "lcpur5t4ewvi2" + }, "type": "object", - "description": "The termbase poll import response.
\nThe import was successfully processed when the status is `done`.", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the import operation." - }, - "status": { - "type": "string", - "description": "The status of the import operation.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", - "enum": [ - "queued", - "processing", - "done", - "cancelled", - "failed", - "error" - ] + "settings": { + "type": "array", + "description": "The configuration settings for Translation Memory Fields.", + "items": { + "$ref": "#/components/schemas/translation-memory-fields-settings-request" + } } }, "required": [ - "id", - "status" + "settings" ] }, - "termbase-import-history-response": { - "title": "Termbase Import History Response", + "translation-memory-field-update-type": { + "type": "string", + "title": "Translation Memory Field Update Type", + "x-stoplight": { + "id": "vq3s0tuc4yp5u" + }, + "enum": [ + "dateTime", + "singlePicklist", + "multiplePicklist", + "integer", + "singleString", + "multipleString" + ], + "description": "The data type of the value." + }, + "translation-memory-fields-settings-request": { + "title": "Translation Memory Fields Settings Request", "type": "object", + "description": "", "properties": { - "id": { - "type": "string", - "description": "The termbase import identifier." - }, - "fileName": { + "name": { "type": "string", - "description": "
default
The file name of the imported file.
", - "x-default-field": true + "description": "The name of the translation memory field." }, - "fileSize": { - "type": "integer", - "description": "The file size of the imported file.", - "format": "int64" + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } }, - "status": { - "type": "string", - "description": "The status of the import operation.
\n`pending` - The import was just created and it's waiting for user input.
\n`queued` - The import passed the structural validation and it's waiting to be processed.
\n`processing` - The import is in progress.
\n`done` - The import was successfully processed and at least an entry changed its structure ( either inserted or modified )
\n`cancelled` - The import process was interrupted.
\n`failed` - The import was unsuccessful. Either one of the import files is not compliant with the TBX structure or no entry changed during the import process.
\n`error` - The import was unsuccessful due to an internal error.", - "enum": [ - "pending", - "queued", - "processing", - "done", - "cancelled", - "failed", - "error" - ] + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" + } + }, + "required": [ + "name", + "values", + "type" + ] + }, + "translation-memory-fields-settings": { + "title": "Translation Memory Fields Settings", + "x-stoplight": { + "id": "adnwx8tlwr674" + }, + "type": "object", + "description": "The configuration settings for Translation Memory Fields.", + "properties": { + "name": { + "type": "string", + "description": "The name of the translation memory field." }, - "createdAt": { - "$ref": "#/components/schemas/date-time" + "values": { + "type": "array", + "description": "A collection of values.", + "items": { + "type": "string" + } }, - "elapsedTime": { - "type": "integer", - "description": "The last modified date of the import." + "type": { + "$ref": "#/components/schemas/translation-memory-field-update-type" } }, "required": [ - "id", - "status" + "name", + "values", + "type" ] }, - "tqa-profile": { - "title": "TQA Profile", + "translation-memory-base": { + "title": "Translation Memory", "type": "object", - "description": "As a project manager, you choose a TQA configuration and use it to automatically assess the quality of a translation document.\n\nThe TQA configuration specifies:\n - Categories and subcategories that reviewers will use to classify the translation issues in a document.\n - Severities to define custom metrics you want to use to assess translation quality.\n - Score to measure the importance of each category or subcategory of an issue.\n - Pass/Fail Threshold to define the maximum number of penalty points admitted before failing the translation document.", + "description": "", "properties": { "id": { "type": "string", - "description": "The identifier of the TQA profile." + "description": "The unique translation memory identifier." }, "name": { "type": "string", - "description": "
default
The name of the TQA Profile.
", - "x-default-field": true + "description": "The translation memory name." }, "description": { "type": "string", - "description": "
default
The TQA Profile description.
", - "x-default-field": true + "description": "The translation memory description" }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "copyright": { + "type": "string" }, - "passFailThreshold": { - "$ref": "#/components/schemas/tqa-profile-passFailThreshold", - "description": "
default
Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.
", - "x-default-field": true + "location": { + "$ref": "#/components/schemas/folder" }, - "categories": { + "languageDirections": { "type": "array", - "description": "Categories and subcategories are assessment options that reviewers can use to classify any translation-related issue that they find in a file.", "items": { - "$ref": "#/components/schemas/tqa-profile-category" + "$ref": "#/components/schemas/translation-memory-language-direction" } }, - "severities": { - "type": "array", - "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", - "items": { - "$ref": "#/components/schemas/tqa-profile-severity" - } + "languageProcessingRule": { + "$ref": "#/components/schemas/language-processing-rule" }, - "scores": { - "type": "array", - "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", - "items": { - "$ref": "#/components/schemas/tqa-profile-score" - } + "fieldTemplate": { + "$ref": "#/components/schemas/translation-memory-field-template" }, - "path": { - "type": "array", - "deprecated": true, - "items": { - "$ref": "#/components/schemas/folder" - } + "createdDateTime": { + "type": "string", + "format": "date-time", + "description": "The `DateTime` when the translation memory was created.", + "nullable": true + }, + "createdBy": { + "$ref": "#/components/schemas/user" } }, "required": [ "id" ] }, - "tqa-profile-category": { - "title": "TQA Profile Category", + "translation-memory-create-request": { + "title": "Translation Memory Create Request", "type": "object", + "description": "The model to use when creating a new Translation Memory.", "properties": { - "id": { - "type": "string", - "description": "The category identifier." - }, "name": { "type": "string", - "description": "
default
The category name.
", - "x-default-field": true + "maxLength": 151, + "minLength": 1, + "description": "The Translation Memory name." }, "description": { "type": "string", - "description": "The category description." + "maxLength": 1024, + "description": "The Translation Memory description." }, - "abbreviation": { + "copyright": { "type": "string", - "description": "The category abbreviation." - } - } - }, - "tqa-profile-severity": { - "title": "TQA Profile Severity", - "type": "object", - "description": "Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.", - "properties": { - "id": { + "maxLength": 1024 + }, + "location": { "type": "string", - "description": "The severity identifier." + "description": "The folder identifier where the translation memory should be created." }, - "name": { + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { "type": "string", - "description": "
default
The severity name.
", - "x-default-field": true + "description": "The Language Processing Rule to be associated with the Translation Memory." }, - "type": { + "fieldTemplateId": { "type": "string", - "description": "The severity type." + "description": "A Field Template to be associated with the Translation Memory." } - } + }, + "required": [ + "name", + "languageDirections", + "languageProcessingRuleId", + "fieldTemplateId" + ] }, - "tqa-profile-passFailThreshold": { - "title": "TQA Profile PassFailThreshold", + "translation-memory-update-request": { + "title": "Translation Memory Update Request", "type": "object", - "description": "Pass/Fail Threshold is used to define the maximum number of penalty points admitted before failing the translation document.", + "description": "", "properties": { - "points": { - "type": "integer", - "description": "
default
The penalty points.
", - "x-default-field": true + "name": { + "type": "string", + "description": "The translation memory name", + "minLength": 1, + "maxLength": 151 }, - "quantity": { - "type": "integer", - "description": "
default
The quantity against which the points are measured.
", - "x-default-field": true + "description": { + "type": "string", + "maxLength": 1024, + "description": "The translation memory description" }, - "scope": { + "copyright": { "type": "string", - "description": "
default
Words or characters.
", - "x-default-field": true + "maxLength": 1024 + }, + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-request" + } + }, + "languageProcessingRuleId": { + "type": "string", + "description": "The language processing rule to be associated with the translation memory." + }, + "fieldTemplateId": { + "type": "string", + "description": "A field template to be associated with the translation memory." } } }, - "tqa-profile-score": { - "title": "TQA Profile Score", + "translation-memory-language-direction": { + "title": "Translation Memory Language Direction", + "x-stoplight": { + "id": "lxtdb1sy4fdbi" + }, "type": "object", - "description": "The TQA scoring indicates whether translations pass or fail the acceptance threshold.", + "description": "A language direction representation specific to translation memories.", "properties": { - "category": { - "$ref": "#/components/schemas/tqa-profile-category", - "description": "
default
The TQA category.
", + "languageDirection": { + "$ref": "#/components/schemas/simple-language-direction", + "description": "
default
A basic language direction.
", "x-default-field": true }, - "severity": { - "$ref": "#/components/schemas/tqa-profile-severity", - "description": "
default
Severities are custom metrics that reviewers can use to measure the importance of any translation-related issues that they find in a file.
", - "x-default-field": true + "translationUnits": { + "type": "integer", + "description": "The number of translation units for this language pair. Sum up all language pairs to get the total for the translation memory.", + "nullable": true }, - "penalty": { + "unalignedTranslationUnits": { "type": "integer", - "description": "
default
The associated penalty for this score's category and severity.
", - "x-default-field": true + "description": "The number of translation units that are unaligned for this language pair. Sum up all language pairs to get the total for the translation memory.", + "nullable": true } } }, - "translation-cost-item": { - "title": "Translation Cost Item", + "translation-memory-import-request": { + "title": "Translation Memory Import Properties", "type": "object", + "description": "Translation Memory Import properties sent as a JSON inside a text part.", "properties": { - "count": { - "type": "number", - "description": "
default
The total number of units.
", - "nullable": true, - "x-default-field": true + "sourceLanguageCode": { + "type": "string", + "description": "The code of the source language of the translation memory." }, - "rate": { - "type": "number", - "description": "
default
The cost of a unit.
", - "nullable": true, - "x-default-field": true + "targetLanguageCode": { + "type": "string", + "description": "The code of the target language of the translation memory." + }, + "importAsPlainText": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "exportInvalidTranslationUnits": { + "type": "boolean", + "default": true + }, + "triggerRecomputeStatistics": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "targetSegmentsDifferOption": { + "type": "string", + "description": "Option to specify how to handle translation units in the Translation Memory, if target segments differ.", + "enum": [ + "addNew", + "overwrite", + "leaveUnchanged", + "keepMostRecent" + ], + "default": "addNew" }, - "total": { - "type": "number", - "description": "
default
The total cost for the current item.
", - "nullable": true, - "x-default-field": true + "unknownFieldsOption": { + "type": "string", + "description": "Option to specify how to handle translation units and unknown fields in the Translation Memory.", + "enum": [ + "skipTranslationUnit", + "ignore", + "addToTranslationMemory", + "failTranslationUnitImport" + ], + "default": "addToTranslationMemory" }, - "runningTotal": { - "type": "number", - "description": "
default
The sum of all the previously computed costs.
", - "nullable": true, - "x-default-field": true + "onlyImportSegmentsWithConfirmationLevels": { + "description": "Only segments with the these confirmation levels will be imported. Default if the field is not set or null: [translated, approvedSignOff, approvedTranslation]. Empty array will be treated as not specified.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "translated", + "approvedTranslation", + "approvedSignOff", + "draft", + "rejectedTranslation", + "rejectedSignOff" + ] + } } - } + }, + "required": [ + "sourceLanguageCode", + "targetLanguageCode" + ] }, - "translation-cost-fuzzy-item": { - "title": "Translation Cost Fuzzy Item", + "translation-memory-import-response": { + "title": "Translation Memory Import Response", "type": "object", "properties": { - "count": { - "type": "number", - "description": "
default
The total number of units.
", - "nullable": true, - "x-default-field": true - }, - "rate": { - "type": "number", - "description": "
default
The cost of a unit.
", - "nullable": true, - "x-default-field": true - }, - "total": { - "type": "number", - "description": "
default
The total cost for the current item.
", - "nullable": true, - "x-default-field": true - }, - "runningTotal": { - "type": "number", - "description": "
default
The sum of all the previously computed costs.
", - "nullable": true, - "x-default-field": true + "id": { + "type": "string", + "description": "The unique identifier of the import operation." }, - "fuzzyCategory": { - "$ref": "#/components/schemas/fuzzy-category", - "description": "
default
Fuzzy category range.
", - "x-default-field": true + "status": { + "type": "string", + "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ], + "deprecated": true } - } + }, + "required": [ + "id", + "status" + ] }, - "translation-engine": { - "title": "Translation Engine", + "translation-memory-import-poll-response": { + "title": "Translation Memory Import Response", + "x-stoplight": { + "id": "f31ba8725474f" + }, "type": "object", - "description": "Translation Engine resource. (Not available for List Projects endpoint)", "properties": { "id": { "type": "string", - "description": "The translation engine identifier." + "description": "The unique identifier of the import operation." }, - "name": { + "status": { "type": "string", - "description": "
default
The translation engine name.
", - "x-default-field": true - }, - "description": { - "type": "string" - }, - "location": { - "$ref": "#/components/schemas/folder-v2" - }, - "definition": { - "$ref": "#/components/schemas/translation-engine-definition" + "description": "The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ] } }, "required": [ - "id" + "id", + "status" ] }, - "translation-engine-update-request": { - "title": "Translation Engine Update Request", - "x-stoplight": { - "id": "qjks6cvd5ej43" - }, + "translation-memory-import-history-response": { + "title": "Translation Memory Import History Response", "type": "object", - "description": "Translation Engine resource update request", "properties": { - "name": { + "id": { "type": "string", - "description": "
default
The translation engine name.
", - "x-default-field": true, - "minLength": 1, - "maxLength": 50 + "description": "The unique identifier of the import operation." }, - "description": { + "status": { "type": "string", - "x-stoplight": { - "id": "h2kzvu2xlq1dh" - }, - "maxLength": 1000 + "description": "The status of the import operation.\n* `queued` - the import has been queued\n* `inPorgress` - the import is being processed\n* `failed` - the import has failed\n* `done` - the import has finished successfully\n* `cancelled` - the import has been cancelled", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ] }, - "definition": { - "$ref": "#/components/schemas/translation-engine-definition", - "x-stoplight": { - "id": "gesu0kld6jyxg" - } + "displayName": { + "type": "string", + "description": "The assigned name of the import operation." + }, + "settings": { + "$ref": "#/components/schemas/translation-memory-import-settings" + }, + "createdAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The creation date of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "updatedAt": { + "type": "string", + "format": "date-time", + "example": "2022-01-12T12:00:00.000Z", + "description": "The last update time of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + }, + "ownerId": { + "type": "string", + "description": "Owner of the import operation, corresponds with the tenant identifier." } - } - }, - "translation-engine-definition": { - "title": "Translation Engine Definition", - "x-stoplight": { - "id": "yb3ai5ltnbu49" }, + "required": [ + "id", + "status" + ] + }, + "translation-memory-import-settings": { + "title": "Translation Memory Import Settings", "type": "object", - "description": "The definition of a translation engine.", + "description": "The properties provided by the client, when the Import Operation was triggered.", "properties": { - "languageProcessingRuleId": { + "onlyImportSegmentsWithConfirmationLevels": { + "description": "Only segments with the these confirmation levels were be imported.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "translated", + "approvedTranslation", + "approvedSignOff", + "draft", + "rejectedTranslation", + "rejectedSignOff" + ] + } + }, + "unknownFieldsOption": { + "description": "This option describes how were the translation units handled when there were unknown fields in the request.", + "enum": [ + "skipTranslationUnit", + "ignore", + "addToTranslationMemory", + "failTranslationUnitImport" + ], + "type": "string" + }, + "targetSegmentsDifferOption": { + "description": "This option describes how were the translation units handled when there were differences in target segments.", + "enum": [ + "addNew", + "overwrite", + "leaveUnchanged", + "keepMostRecent" + ], + "type": "string" + }, + "importAsPlainText": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "exportInvalidTranslationUnits": { + "description": "This option describes if the invalid translation units were exported during the original translation memory import operation.", + "type": "boolean" + }, + "triggerRecomputeStatistics": { + "description": "(Deprecated) The default value is set for this field, as this property is set internally.", + "type": "boolean", + "deprecated": true + }, + "fileName": { + "description": "The name of the file attached to the import request.", + "type": "string" + }, + "sourceLanguageCode": { + "description": "The source language code of the import request.", + "type": "string" + }, + "targetLanguageCode": { + "description": "The target language code of the import request.", "type": "string" }, - "languagePairDefinitions": { - "type": [ - "array" - ], - "x-stoplight": { - "id": "891hvyzbxnaqm" - }, - "items": { - "$ref": "#/components/schemas/translation-engine-definition-language-pair", - "x-stoplight": { - "id": "nbfh6uvky8c4o" - } - } + "traceId": { + "description": "(Deprecated) The field will be completly remove in the future. For compatibily, until it will be removed a default value it is set: 0000-0000-0000-0000.", + "type": "string", + "deprecated": true } - } + }, + "required": [ + "onlyImportSegmentsWithConfirmationLevels", + "unknownFieldsOption", + "targetSegmentsDifferOption", + "importAsPlainText", + "exportInvalidTranslationUnits", + "triggerRecomputeStatistics", + "fileName", + "sourceLanguageCode", + "targetLanguageCode", + "traceId" + ] }, - "translation-engine-definition-language-pair": { - "title": "Language Pair Definition", + "translation-memory-export-response": { + "title": "Translation Memory Export Response", "x-stoplight": { - "id": "isibhifp9qrao" + "id": "ol4kmgwlbdr8f" }, "type": "object", "properties": { - "languagePair": { - "$ref": "#/components/schemas/language-pair", - "x-stoplight": { - "id": "ixoi0dqka8bkw" - } + "id": { + "type": "string", + "description": "The translation memory export identifier." }, - "resources": { - "type": "array", - "x-stoplight": { - "id": "foi4rdwsrevkj" - }, - "items": { - "$ref": "#/components/schemas/language-pair-resource", - "x-stoplight": { - "id": "d2b4btupa9mu1" - } - } + "status": { + "type": "string", + "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", + "enum": [ + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ], + "deprecated": true } }, "required": [ - "languagePair", - "resources" + "id", + "status" ] }, - "translation-memory-field": { - "title": "Translation Memory Field", + "translation-memory-poll-export-response": { + "title": "Translation Memory Export Response", + "x-stoplight": { + "id": "h78jfifpf8rpa" + }, "type": "object", - "description": "The unique identifier of the field.", "properties": { "id": { "type": "string", - "description": "The unique identifier of the field." - }, - "name": { - "type": "string", - "description": "
default
The name of the field.
", - "x-default-field": true + "description": "The translation memory export identifier." }, - "type": { + "status": { "type": "string", + "description": "The translation memory export status.\n* `queued` - the export has been queued to be processed\n* `inProgress` - the export is being processed\n* `failed` - the export has failed due to internal errors\n* `done` - the export has finished successfully\n* `cancelled` - the export has been interrupted", "enum": [ - "unknown", - "singleString", - "multipleString", - "dateTime", - "singlePicklist", - "multiplePicklist", - "integer" - ], - "description": "The data type of the field." - }, - "values": { - "type": "array", - "description": "A collection of values for this field.", - "items": { - "$ref": "#/components/schemas/translation-memory-field-value" - } + "queued", + "inProgress", + "failed", + "done", + "cancelled" + ] } }, "required": [ - "id" + "id", + "status" ] }, - "translation-memory-fields": { - "title": "Translation Memory Fields", - "type": "object", - "properties": { - "settings": { - "type": "array", - "items": { - "$ref": "#/components/schemas/translation-memory-fields-settings" - }, - "description": "
default
", - "x-default-field": true - } - } - }, - "translation-memory-field-template": { - "title": "Translation Memory Field Template", + "translation-memory-export-language-direction": { + "title": "Translation Memory Export Language Direction", + "x-stoplight": { + "id": "sgv1fy31ffmba" + }, "type": "object", + "description": "", "properties": { - "id": { - "type": "string", - "description": "The unique identifier of the translation memory field template." - }, - "name": { - "type": "string", - "description": "
default
The name of the field template.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "The field template description." - }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request" }, - "fieldDefinitions": { - "type": "array", - "description": "A collection of translation memory fields.", - "items": { - "$ref": "#/components/schemas/translation-memory-field" - } + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request" } }, "required": [ - "id" + "sourceLanguage", + "targetLanguage" ] }, - "translation-memory-field-value": { - "title": "Translation Memory Field Value", + "translation-memory-export-request": { + "title": "Translation Memory Export Request", + "x-stoplight": { + "id": "ivlpf7ccfd3is" + }, + "description": "", "type": "object", "properties": { - "id": { - "type": "string", - "description": "The unique identifier associated with this value." - }, - "value": { - "type": "string", - "description": "A translation memory field value." + "languageDirection": { + "$ref": "#/components/schemas/translation-memory-export-language-direction" } }, "required": [ - "id" + "languageDirection" ] }, - "translation-memory": { - "title": "Translation Memory", + "translation-service-type": { + "title": "Service Type", + "x-stoplight": { + "id": "qxo8dvfuhtpvn" + }, "type": "object", - "description": "", + "required": [ + "id" + ], "properties": { "id": { "type": "string", - "description": "Unique identifier of the translation memory." + "x-stoplight": { + "id": "y8k58twki2cx2" + }, + "description": "The Service Type identifier." }, "name": { "type": "string", - "description": "
default
The translation memory name.
", - "x-default-field": true - }, - "description": { - "type": "string", - "description": "The translation memory description." - }, - "copyright": { - "type": "string" - }, - "location": { - "$ref": "#/components/schemas/folder" - }, - "languageDirections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/translation-memory-language-direction" + "x-stoplight": { + "id": "at815peslzdx2" }, - "description": "
default
A collection of language directions
", - "x-default-field": true - }, - "languageProcessingRule": { - "$ref": "#/components/schemas/language-processing-rule" - }, - "fieldTemplate": { - "$ref": "#/components/schemas/translation-memory-field-template" - }, - "createdAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The `DateTime` when the translation memory was created.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "createdBy": { - "$ref": "#/components/schemas/user" - }, - "lastRecomputedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The `DateTime` when the translation memory statistics were last updated.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true - }, - "lastReIndexedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The `DateTime` when the translation memory reindexing was performed.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss", - "nullable": true + "description": "
default
The Service Type name.
" } - }, - "required": [ - "id" - ] + } }, - "translation-memory-fields-update-request": { - "title": "Translation Memory Fields Update Request", + "update-translation-memory": { + "title": "Update Translation Memory", "x-stoplight": { - "id": "lcpur5t4ewvi2" + "id": "7imfj2yp6ndh4" }, "type": "object", "properties": { "settings": { - "type": "array", - "description": "The configuration settings for Translation Memory Fields.", - "items": { - "$ref": "#/components/schemas/translation-memory-fields-settings-request" - } + "$ref": "#/components/schemas/update-translation-memory-settings", + "description": "The configuration settings for Update Translation Memory\r\n.", + "x-default-field": true } }, "required": [ "settings" ] }, - "translation-memory-field-update-type": { - "type": "string", - "title": "Translation Memory Field Update Type", + "update-translation-memory-settings": { + "title": "Update Translation Memory Settings", "x-stoplight": { - "id": "vq3s0tuc4yp5u" + "id": "ns9gqapkdazxv" }, - "enum": [ - "dateTime", - "singlePicklist", - "multiplePicklist", - "integer", - "singleString", - "multipleString" - ], - "description": "The data type of the value." - }, - "translation-memory-fields-settings-request": { - "title": "Translation Memory Fields Settings Request", "type": "object", - "description": "", "properties": { - "name": { - "type": "string", - "description": "The name of the translation memory field." - }, - "values": { + "segmentsConfirmationLevels": { "type": "array", - "description": "A collection of values.", + "x-stoplight": { + "id": "1sf7j3cudjzag" + }, "items": { - "type": "string" - } + "x-stoplight": { + "id": "7tg40rat3gilo" + }, + "type": "string", + "enum": [ + "approvedTranslation", + "approvedSignOff", + "draft", + "notTranslated", + "translated", + "rejectedTranslation", + "rejectedSignOff" + ] + }, + "description": "Default values are: \n\r [`translated`, `approvedTranslation`, `approvedSignOff`]." }, - "type": { - "$ref": "#/components/schemas/translation-memory-field-update-type" + "targetSegmentsDifferOption": { + "type": "string", + "x-stoplight": { + "id": "2ndpsnxl5k5qq" + }, + "enum": [ + "addNew", + "overwrite", + "keepMostRecent", + "leaveUnchanged", + "merge" + ], + "description": "Options:\r\n- `merge`: replace (update) only the TU (from which a match was retrieved for the edited TU) with the latest available translation AND keep the other duplicates as they are. Use this option to have multiple translations for the same source together with Multiple Translation Penalty = 0.\r\n- `addNew`: add translations as new TUs to the TM. Specify the status of the TUs (which will be added) under Segment status. This means that the existing TUs in the TM are not overwritten.\r\n- `overwriteExisting`: delete all TUs (which have the same source, all TU duplicates) and keep only the last added TU (the latest available translation). Use this option to prevent inconsistent translations.\r\n- `leaveUnchanged`: keep the existing TUs and do not add any new ones.\r\n- `keepMostRecent`: replace (update) only the most recent TU (from which a match was retrieved for the edited TU) with the latest available translation AND delete all other duplicates.\r\n", + "default": "merge" } }, "required": [ - "name", - "values", - "type" + "segmentsConfirmationLevels", + "targetSegmentsDifferOption" ] }, - "translation-memory-fields-settings": { - "title": "Translation Memory Fields Settings", - "x-stoplight": { - "id": "adnwx8tlwr674" - }, + "user": { + "title": "User", "type": "object", - "description": "The configuration settings for Translation Memory Fields.", + "description": "User in the account.", "properties": { - "name": { + "id": { "type": "string", - "description": "The name of the translation memory field." + "description": "User account identifier." }, - "values": { + "email": { + "type": "string", + "description": "
default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", + "x-default-field": true + }, + "firstName": { + "type": "string", + "description": "
default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", + "x-default-field": true + }, + "lastName": { + "type": "string", + "description": "
default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", + "x-default-field": true + }, + "anonymized": { + "type": "boolean", + "description": "
default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
", + "nullable": true, + "x-default-field": true + }, + "anonymizedUserName": { + "type": "string", + "description": "
default
Retrieved if the authenticated entity does not have access to read the User.
", + "x-default-field": true + }, + "location": { + "$ref": "#/components/schemas/folder-v2" + }, + "groups": { "type": "array", - "description": "A collection of values.", "items": { - "type": "string" + "$ref": "#/components/schemas/group" } - }, - "type": { - "$ref": "#/components/schemas/translation-memory-field-update-type" } }, "required": [ - "name", - "values", - "type" + "id" ] }, - "translation-memory-base": { - "title": "Translation Memory", + "user-request": { + "title": "User Request", "type": "object", - "description": "", + "description": "User in the account.", "properties": { "id": { "type": "string", - "description": "The unique translation memory identifier." + "description": "The user identifier." }, - "name": { + "email": { "type": "string", - "description": "The translation memory name." + "description": "User’s email. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." }, - "description": { + "firstName": { "type": "string", - "description": "The translation memory description" + "description": "User’s first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." }, - "copyright": { - "type": "string" + "lastName": { + "type": "string", + "description": "User’s last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." }, "location": { - "$ref": "#/components/schemas/folder" + "$ref": "#/components/schemas/resource-folder-request" }, - "languageDirections": { + "groups": { "type": "array", + "description": "The groups.", "items": { - "$ref": "#/components/schemas/translation-memory-language-direction" + "$ref": "#/components/schemas/group-request" } }, - "languageProcessingRule": { - "$ref": "#/components/schemas/language-processing-rule" - }, - "fieldTemplate": { - "$ref": "#/components/schemas/translation-memory-field-template" - }, - "createdDateTime": { - "type": "string", - "format": "date-time", - "description": "The `DateTime` when the translation memory was created.", + "anonymized": { + "type": "boolean", + "description": "Shows if the authenticated entity has access to read the details of the user or not. If true then the ‘anonymizedUserName’ should be retrieved.", "nullable": true }, - "createdBy": { - "$ref": "#/components/schemas/user" + "anonymizedUserName": { + "type": "string", + "description": "Retrieved if the authenticated entity does not have access to read the User." } }, "required": [ "id" ] }, - "translation-memory-create-request": { - "title": "Translation Memory Create Request", + "vendor-order": { + "title": "Vendor Order", "type": "object", - "description": "The model to use when creating a new Translation Memory.", "properties": { - "name": { - "type": "string", - "maxLength": 151, - "minLength": 1, - "description": "The Translation Memory name." - }, - "description": { - "type": "string", - "maxLength": 1024, - "description": "The Translation Memory description." - }, - "copyright": { - "type": "string", - "maxLength": 1024 - }, - "location": { - "type": "string", - "description": "The folder identifier where the translation memory should be created." - }, - "languageDirections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/language-direction-request" - } - }, - "languageProcessingRuleId": { - "type": "string", - "description": "The Language Processing Rule to be associated with the Translation Memory." + "id": { + "type": "string" }, - "fieldTemplateId": { - "type": "string", - "description": "A Field Template to be associated with the Translation Memory." + "quote": { + "$ref": "#/components/schemas/quote" } }, "required": [ - "name", - "languageDirections", - "languageProcessingRuleId", - "fieldTemplateId" + "id" + ], + "description": "A vendor order resource." + }, + "vendor-order-template-request": { + "title": "Vendor Order Template Request", + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" ] }, - "translation-memory-update-request": { - "title": "Translation Memory Update Request", + "vendor-order-template": { + "title": "Vendor Order Template", + "description": "The vendor order template.", + "type": "object", + "properties": { + "id": { + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "volume-unit-type": { + "title": "Volume Unit Type", + "x-stoplight": { + "id": "xo217uws14jb2" + }, + "enum": [ + "words", + "characters", + "custom" + ] + }, + "workflow": { + "title": "Workflow", "type": "object", - "description": "", + "description": "The steps a project goes through. (Not available for List Projects endpoint)", "properties": { + "id": { + "type": "string", + "description": "The workflow identifier." + }, "name": { "type": "string", - "description": "The translation memory name", - "minLength": 1, - "maxLength": 151 + "description": "
default
The workflow name.
", + "x-default-field": true }, "description": { "type": "string", - "maxLength": 1024, - "description": "The translation memory description" + "description": "The workflow description." }, - "copyright": { - "type": "string", - "maxLength": 1024 + "location": { + "$ref": "#/components/schemas/folder" }, - "languageDirections": { + "workflowTemplate": { + "$ref": "#/components/schemas/workflow-template" + }, + "taskConfigurations": { "type": "array", "items": { - "$ref": "#/components/schemas/language-direction-request" + "$ref": "#/components/schemas/workflow-task-configuration" } }, - "languageProcessingRuleId": { - "type": "string", - "description": "The language processing rule to be associated with the translation memory." - }, - "fieldTemplateId": { - "type": "string", - "description": "A field template to be associated with the translation memory." + "languageDirections": { + "type": "array", + "items": { + "$ref": "#/components/schemas/language-direction-no-statistics" + } } - } - }, - "translation-memory-language-direction": { - "title": "Translation Memory Language Direction", - "x-stoplight": { - "id": "lxtdb1sy4fdbi" }, + "required": [ + "id" + ] + }, + "workflow-task-assignee": { + "title": "Workflow Task Assignee", "type": "object", - "description": "A language direction representation specific to translation memories.", + "description": "Task assignee. Based on the \"type\", further details can be retrieved.
For ex. for \"type\"=\"user\", \"user\" property is available.
For \"projectCreator\" and \"projectManager\" no other property is available.", "properties": { - "languageDirection": { - "$ref": "#/components/schemas/simple-language-direction", - "description": "
default
A basic language direction.
", + "type": { + "type": "string", + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator", + "projectManager" + ] + }, + "user": { + "$ref": "#/components/schemas/user", + "description": "
default
User in the account
", "x-default-field": true }, - "translationUnits": { - "type": "integer", - "description": "The number of translation units for this language pair. Sum up all language pairs to get the total for the translation memory.", - "nullable": true + "group": { + "$ref": "#/components/schemas/group", + "description": "
default
Group of users.
", + "x-default-field": true }, - "unalignedTranslationUnits": { - "type": "integer", - "description": "The number of translation units that are unaligned for this language pair. Sum up all language pairs to get the total for the translation memory.", - "nullable": true + "vendorOrderTemplate": { + "$ref": "#/components/schemas/vendor-order-template", + "description": "
default
A vendor oder template.
", + "x-default-field": true } - } + }, + "required": [ + "type" + ] }, - "translation-memory-import-request": { - "title": "Translation Memory Import Properties", + "workflow-task-assignee-request": { + "title": "Workflow Task Assignee Request", "type": "object", - "description": "Translation Memory Import properties sent as a JSON inside a text part.", "properties": { - "sourceLanguageCode": { - "type": "string", - "description": "The code of the source language of the translation memory." - }, - "targetLanguageCode": { + "type": { "type": "string", - "description": "The code of the target language of the translation memory." + "enum": [ + "user", + "group", + "vendorOrderTemplate", + "projectCreator", + "projectManager" + ] }, - "importAsPlainText": { - "description": "(Deprecated) The default value is set for this field, as this property is set internally.", - "type": "boolean", - "deprecated": true + "user": { + "$ref": "#/components/schemas/user-request" }, - "exportInvalidTranslationUnits": { - "type": "boolean", - "default": true + "group": { + "$ref": "#/components/schemas/group-request" }, - "triggerRecomputeStatistics": { - "description": "(Deprecated) The default value is set for this field, as this property is set internally.", - "type": "boolean", - "deprecated": true + "vendorOrderTemplate": { + "$ref": "#/components/schemas/vendor-order-template-request" + } + }, + "required": [ + "type" + ] + }, + "workflow-task-configuration": { + "title": "Workflow Task Configuration", + "type": "object", + "description": "Properties of a workflow task.", + "properties": { + "scope": { + "$ref": "#/components/schemas/task-configuration-scope" }, - "targetSegmentsDifferOption": { - "type": "string", - "description": "Option to specify how to handle translation units in the Translation Memory, if target segments differ.", - "enum": [ - "addNew", - "overwrite", - "leaveUnchanged", - "keepMostRecent" - ], - "default": "addNew" + "assignees": { + "$ref": "#/components/schemas/workflow-task-assignee" }, - "unknownFieldsOption": { - "type": "string", - "description": "Option to specify how to handle translation units and unknown fields in the Translation Memory.", - "enum": [ - "skipTranslationUnit", - "ignore", - "addToTranslationMemory", - "failTranslationUnitImport" - ], - "default": "addToTranslationMemory" + "isSkipped": { + "type": "boolean", + "nullable": true, + "description": "
default
", + "x-default-field": true }, - "onlyImportSegmentsWithConfirmationLevels": { - "description": "Only segments with the these confirmation levels will be imported. Default if the field is not set or null: [translated, approvedSignOff, approvedTranslation]. Empty array will be treated as not specified.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "translated", - "approvedTranslation", - "approvedSignOff", - "draft", - "rejectedTranslation", - "rejectedSignOff" - ] - } + "taskTemplate": { + "$ref": "#/components/schemas/workflow-task-template" } }, "required": [ - "sourceLanguageCode", - "targetLanguageCode" + "scope", + "taskTemplate" ] }, - "translation-memory-import-response": { - "title": "Translation Memory Import Response", + "workflow-phase": { + "title": "Workflow Phase", "type": "object", + "description": "A set of workflow steps which work together towards a localization outcome.", "properties": { "id": { "type": "string", - "description": "The unique identifier of the import operation." + "description": "The phase identfier." }, - "status": { + "name": { "type": "string", - "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", - "enum": [ - "queued", - "inProgress", - "failed", - "done", - "cancelled" - ], - "deprecated": true + "description": "
default
The phase name.
", + "x-default-field": true } }, "required": [ - "id", - "status" + "id" ] }, - "translation-memory-import-poll-response": { - "title": "Translation Memory Import Response", - "x-stoplight": { - "id": "f31ba8725474f" + "workflow-task-configuration-request": { + "title": "Workflow Task Configuration Request", + "type": "object", + "description": "A task configuration request.", + "properties": { + "taskTemplate": { + "$ref": "#/components/schemas/object-id" + }, + "isSkipped": { + "type": "boolean" + }, + "assignees": { + "type": "array", + "description": "Specifies the list of assignees for the task template. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", + "items": { + "$ref": "#/components/schemas/workflow-task-assignee-request" + } + }, + "scope": { + "$ref": "#/components/schemas/task-configuration-scope-request" + } }, + "required": [ + "taskTemplate", + "isSkipped", + "assignees", + "scope" + ] + }, + "workflow-task-template": { + "title": "Workflow Task Template", "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the import operation." + "description": "The workflow task template identifier." + }, + "name": { + "type": "string", + "description": "
default
The workflow task template name.
", + "x-default-field": true + }, + "apiInternalId": { + "type": "string", + "x-stoplight": { + "id": "dd6vytpa9vo41" + }, + "description": "
default
Unique identifier of workflow task templates\r\n
" }, - "status": { - "type": "string", - "description": "The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", - "enum": [ - "queued", - "inProgress", - "failed", - "done", - "cancelled" - ] + "description": { + "type": "string" + }, + "canSkip": { + "type": "boolean", + "nullable": true + }, + "requiresAssignment": { + "type": "boolean", + "nullable": true + }, + "taskType": { + "$ref": "#/components/schemas/task-type" + }, + "phase": { + "$ref": "#/components/schemas/workflow-phase" } }, "required": [ - "id", - "status" + "id" ] }, - "translation-memory-import-history-response": { - "title": "Translation Memory Import History Response", + "workflow-template": { + "title": "Workflow Template", "type": "object", "properties": { "id": { "type": "string", - "description": "The unique identifier of the import operation." + "description": "The workflow template identifier." }, - "status": { + "name": { "type": "string", - "description": "The status of the import operation.\n* `queued` - the import has been queued\n* `inPorgress` - the import is being processed\n* `failed` - the import has failed\n* `done` - the import has finished successfully\n* `cancelled` - the import has been cancelled", - "enum": [ - "queued", - "inProgress", - "failed", - "done", - "cancelled" - ] + "description": "
default
The workflow template name.
", + "x-default-field": true }, - "displayName": { + "description": { "type": "string", - "description": "The assigned name of the import operation." - }, - "settings": { - "$ref": "#/components/schemas/translation-memory-import-settings" + "description": "The workflow template description." }, - "createdAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The creation date of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + "taskTemplates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-task-template" + } }, - "updatedAt": { - "type": "string", - "format": "date-time", - "example": "2022-01-12T12:00:00.000Z", - "description": "The last update time of the import operation.
UTC Timezone
Allowed formats:
\"YYYY-MM-DDThh:mmZ\"
\"YYYY-MM-DDThh:mm:ssZ\"
\"YYYY-MM-DDThh:mm:ss.sZ\"
\"YYYY-MM-DDThh:mm:ss.ssZ\"
\"YYYY-MM-DDThh:mm:ss.sss" + "phases": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-phase" + } }, - "ownerId": { - "type": "string", - "description": "Owner of the import operation, corresponds with the tenant identifier." + "transitions": { + "type": "array", + "items": { + "$ref": "#/components/schemas/workflow-template-transition" + } } }, "required": [ - "id", - "status" + "id" ] }, - "translation-memory-import-settings": { - "title": "Translation Memory Import Settings", + "workflow-template-transition": { + "title": "Workflow Template Transition", "type": "object", - "description": "The properties provided by the client, when the Import Operation was triggered.", "properties": { - "onlyImportSegmentsWithConfirmationLevels": { - "description": "Only segments with the these confirmation levels were be imported.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "translated", - "approvedTranslation", - "approvedSignOff", - "draft", - "rejectedTranslation", - "rejectedSignOff" - ] - } + "from": { + "$ref": "#/components/schemas/workflow-template-transition-node", + "description": "
default
", + "x-default-field": true }, - "unknownFieldsOption": { - "description": "This option describes how were the translation units handled when there were unknown fields in the request.", + "to": { + "$ref": "#/components/schemas/workflow-template-transition-node", + "description": "
default
", + "x-default-field": true + }, + "condition": { + "$ref": "#/components/schemas/workflow-template-transition-condition" + } + } + }, + "workflow-template-transition-condition": { + "title": "Workflow Template Transition Condition", + "type": "object", + "properties": { + "type": { + "type": "string", "enum": [ - "skipTranslationUnit", - "ignore", - "addToTranslationMemory", - "failTranslationUnitImport" + "outcome", + "expression" ], - "type": "string" + "nullable": true, + "description": "
default
", + "x-default-field": true }, - "targetSegmentsDifferOption": { - "description": "This option describes how were the translation units handled when there were differences in target segments.", + "value": { + "type": "string", + "description": "
default
", + "x-default-field": true + } + } + }, + "workflow-template-transition-node": { + "title": "Workflow Template Transition Node", + "type": "object", + "properties": { + "type": { + "type": "string", "enum": [ - "addNew", - "overwrite", - "leaveUnchanged", - "keepMostRecent" + "taskTemplate", + "start", + "end" ], - "type": "string" - }, - "importAsPlainText": { - "description": "(Deprecated) The default value is set for this field, as this property is set internally.", - "type": "boolean", - "deprecated": true - }, - "exportInvalidTranslationUnits": { - "description": "This option describes if the invalid translation units were exported during the original translation memory import operation.", - "type": "boolean" - }, - "triggerRecomputeStatistics": { - "description": "(Deprecated) The default value is set for this field, as this property is set internally.", - "type": "boolean", - "deprecated": true - }, - "fileName": { - "description": "The name of the file attached to the import request.", - "type": "string" - }, - "sourceLanguageCode": { - "description": "The source language code of the import request.", - "type": "string" + "description": "
default
", + "x-default-field": true }, - "targetLanguageCode": { - "description": "The target language code of the import request.", - "type": "string" + "taskTemplate": { + "$ref": "#/components/schemas/workflow-task-template", + "description": "
default
", + "x-default-field": true + } + } + }, + "workflow-update-request": { + "title": "Workflow Update Request", + "type": "object", + "description": "A model to update a workflow.", + "properties": { + "name": { + "type": "string", + "description": "The workflow name." }, - "traceId": { - "description": "(Deprecated) The field will be completly remove in the future. For compatibily, until it will be removed a default value it is set: 0000-0000-0000-0000.", + "description": { "type": "string", - "deprecated": true + "description": "The workflow description." + }, + "taskConfigurations": { + "type": "array", + "description": "The task configurations.", + "items": { + "$ref": "#/components/schemas/workflow-task-configuration-request" + } } - }, - "required": [ - "onlyImportSegmentsWithConfirmationLevels", - "unknownFieldsOption", - "targetSegmentsDifferOption", - "importAsPlainText", - "exportInvalidTranslationUnits", - "triggerRecomputeStatistics", - "fileName", - "sourceLanguageCode", - "targetLanguageCode", - "traceId" - ] + } }, - "translation-memory-export-response": { - "title": "Translation Memory Export Response", + "well-known-jwks-response": { + "title": "Well Known Keys Response", "x-stoplight": { - "id": "ol4kmgwlbdr8f" + "id": "1owp0jo4rmrg7" }, "type": "object", "properties": { - "id": { - "type": "string", - "description": "The translation memory export identifier." - }, - "status": { - "type": "string", - "description": "(Deprecated) The status of the import operation.\n* `queued` - the import has been queued and is waiting to be processed\n* `inProgress` - the import is being processed\n* `failed` - the import has failed due to internal errors\n* `done` - the import has finished successfully\n* `cancelled` - the import has been interrupted", - "enum": [ - "queued", - "inProgress", - "failed", - "done", - "cancelled" - ], - "deprecated": true + "keys": { + "$ref": "#/components/schemas/list-jwks", + "x-stoplight": { + "id": "dbkidlpmb0wk4" + }, + "description": "The list of public keys." } + } + }, + "translation-update-definition": { + "title": "Translation Update Definition", + "x-stoplight": { + "id": "9qqwmpya8mbgb" }, + "type": "object", "required": [ - "id", - "status" - ] + "translationEngineId" + ], + "properties": { + "translationEngineId": { + "type": "string", + "x-stoplight": { + "id": "57wk8minjka59" + }, + "description": "The translation engine id. The translation engine must have a `TM` resource." + } + } }, - "translation-memory-poll-export-response": { - "title": "Translation Memory Export Response", + "translation-update-field": { + "title": "Translation Update Field", "x-stoplight": { - "id": "h78jfifpf8rpa" + "id": "ivfrnlswg3n8o" }, "type": "object", + "required": [ + "name", + "values" + ], "properties": { - "id": { + "name": { "type": "string", - "description": "The translation memory export identifier." + "x-stoplight": { + "id": "w0z5ip16a75jo" + }, + "description": "Field name" }, - "status": { - "type": "string", - "description": "The translation memory export status.\n* `queued` - the export has been queued to be processed\n* `inProgress` - the export is being processed\n* `failed` - the export has failed due to internal errors\n* `done` - the export has finished successfully\n* `cancelled` - the export has been interrupted", - "enum": [ - "queued", - "inProgress", - "failed", - "done", - "cancelled" - ] + "values": { + "type": "array", + "x-stoplight": { + "id": "jzd3s8buqkhyh" + }, + "description": "Field values", + "items": { + "x-stoplight": { + "id": "vxkufz4upb8e0" + }, + "type": "string" + } } }, - "required": [ - "id", - "status" - ] + "description": "" }, - "translation-memory-export-language-direction": { - "title": "Translation Memory Export Language Direction", + "translation-search-settings": { + "title": "Translation Search Settings", "x-stoplight": { - "id": "sgv1fy31ffmba" + "id": "k6reff6ihojws" }, "type": "object", - "description": "", "properties": { - "sourceLanguage": { - "$ref": "#/components/schemas/source-language-request" - }, - "targetLanguage": { - "$ref": "#/components/schemas/target-language-request" + "translationMemory": { + "$ref": "#/components/schemas/translation-search-settings-tm", + "x-stoplight": { + "id": "6d8m3xqn7kla8" + } } - }, - "required": [ - "sourceLanguage", - "targetLanguage" - ] + } }, - "translation-memory-export-request": { - "title": "Translation Memory Export Request", + "concordance-search-settings": { + "title": "Concordance Search Settings", "x-stoplight": { - "id": "ivlpf7ccfd3is" + "id": "k6reff6ihojws" }, - "description": "", "type": "object", "properties": { - "languageDirection": { - "$ref": "#/components/schemas/translation-memory-export-language-direction" + "translationMemory": { + "$ref": "#/components/schemas/concordance-search-settings-tm", + "x-stoplight": { + "id": "6d8m3xqn7kla8" + } } - }, - "required": [ - "languageDirection" - ] + } }, - "update-translation-memory": { - "title": "Update Translation Memory", + "translation-search-settings-tm": { + "title": "Translation Memory Search Settings", "x-stoplight": { - "id": "7imfj2yp6ndh4" + "id": "7b6bn72a6ldvj" }, "type": "object", "properties": { - "settings": { - "$ref": "#/components/schemas/update-translation-memory-settings", - "description": "The configuration settings for Update Translation Memory\r\n.", - "x-default-field": true + "minimumMatchValue": { + "type": "integer", + "x-stoplight": { + "id": "br24y2myv21e0" + }, + "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.", + "minimum": 30, + "maximum": 100, + "default": 70 + }, + "penalties": { + "$ref": "#/components/schemas/translation-search-TM-penalties", + "x-stoplight": { + "id": "fkru1d5bfhm2w" + } } - }, - "required": [ - "settings" - ] + } }, - "update-translation-memory-settings": { - "title": "Update Translation Memory Settings", + "concordance-search-settings-tm": { + "title": "Translation Memory Concordance Search Settings", "x-stoplight": { - "id": "ns9gqapkdazxv" + "id": "7b6bn72a6ldvj" }, "type": "object", "properties": { - "segmentsConfirmationLevels": { - "type": "array", + "minimumMatchValue": { + "type": "integer", "x-stoplight": { - "id": "1sf7j3cudjzag" - }, - "items": { - "x-stoplight": { - "id": "7tg40rat3gilo" - }, - "type": "string", - "enum": [ - "approvedTranslation", - "approvedSignOff", - "draft", - "notTranslated", - "translated", - "rejectedTranslation", - "rejectedSignOff" - ] + "id": "br24y2myv21e0" }, - "description": "Default values are: \n\r [`translated`, `approvedTranslation`, `approvedSignOff`]." + "description": "This is the degree of match that must exist between a source document segment and a translation memory segment in order for the segment translation to be offered as a match. The default is 70%, but you can set a value between 30% and 100%.\r\n\r\nThe selected value is inclusive, meaning that matches with your exact selected value are also included in translation results.", + "minimum": 30, + "maximum": 100, + "default": 70 }, - "targetSegmentsDifferOption": { - "type": "string", + "penalties": { + "$ref": "#/components/schemas/concordance-search-TM-penalties", "x-stoplight": { - "id": "2ndpsnxl5k5qq" - }, - "enum": [ - "addNew", - "overwrite", - "keepMostRecent", - "leaveUnchanged", - "merge" - ], - "description": "Options:\r\n- `merge`: replace (update) only the TU (from which a match was retrieved for the edited TU) with the latest available translation AND keep the other duplicates as they are. Use this option to have multiple translations for the same source together with Multiple Translation Penalty = 0.\r\n- `addNew`: add translations as new TUs to the TM. Specify the status of the TUs (which will be added) under Segment status. This means that the existing TUs in the TM are not overwritten.\r\n- `overwriteExisting`: delete all TUs (which have the same source, all TU duplicates) and keep only the last added TU (the latest available translation). Use this option to prevent inconsistent translations.\r\n- `leaveUnchanged`: keep the existing TUs and do not add any new ones.\r\n- `keepMostRecent`: replace (update) only the most recent TU (from which a match was retrieved for the edited TU) with the latest available translation AND delete all other duplicates.\r\n", - "default": "merge" + "id": "fkru1d5bfhm2w" + } } - }, - "required": [ - "segmentsConfirmationLevels", - "targetSegmentsDifferOption" - ] + } }, - "user": { - "title": "User", + "translation-search-standard-penalties": { + "title": "Translation Memory Standard Penalties", + "x-stoplight": { + "id": "9c3abb6urgvqh" + }, "type": "object", - "description": "User in the account.", "properties": { - "id": { - "type": "string", - "description": "User account identifier." - }, - "email": { - "type": "string", - "description": "
default
The user's email address. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", - "x-default-field": true + "missingFormatting": { + "type": "integer", + "x-stoplight": { + "id": "g8mtup7862xdn" + }, + "minimum": 0, + "maximum": 20, + "default": 1 }, - "firstName": { - "type": "string", - "description": "
default
The user's first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", - "x-default-field": true + "differentFormatting": { + "type": "integer", + "x-stoplight": { + "id": "pao1qvu6sbjc9" + }, + "default": 1, + "minimum": 0, + "maximum": 20 }, - "lastName": { - "type": "string", - "description": "
default
The user's last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read.
", - "x-default-field": true + "multipleTranslations": { + "type": "integer", + "x-stoplight": { + "id": "y9awj7oyd87ye" + }, + "default": 1, + "minimum": 0, + "maximum": 20 }, - "anonymized": { - "type": "boolean", - "description": "
default
This shows if the authenticated entity has access to read the details of the user or not. If true, then the 'anonymizedUserName' should be retrieved.
", - "nullable": true, - "x-default-field": true + "autoLocalization": { + "type": "integer", + "x-stoplight": { + "id": "y85nv8a0u4ptr" + }, + "default": 0, + "minimum": 0, + "maximum": 20 }, - "anonymizedUserName": { - "type": "string", - "description": "
default
Retrieved if the authenticated entity does not have access to read the User.
", - "x-default-field": true + "textReplacement": { + "type": "integer", + "x-stoplight": { + "id": "t7hvtgxzazgy0" + }, + "default": 0, + "minimum": 0, + "maximum": 20 }, - "location": { - "$ref": "#/components/schemas/folder-v2" + "alignment": { + "type": "integer", + "x-stoplight": { + "id": "ipk0iaseeokla" + }, + "default": 1, + "minimum": 0, + "maximum": 20 }, - "groups": { - "type": "array", - "items": { - "$ref": "#/components/schemas/group" - } + "characterWidthDifference": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20 } }, - "required": [ - "id" - ] + "description": "" }, - "user-request": { - "title": "User Request", + "translation-search-unit-status-penalties": { + "title": "Translation Unit Status Penalties", + "x-stoplight": { + "id": "x6ufijbtx0mff" + }, "type": "object", - "description": "User in the account.", + "description": "The penalties to apply depending on the status of the translation unit.", "properties": { - "id": { - "type": "string", - "description": "The user identifier." - }, - "email": { - "type": "string", - "description": "User’s email. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." + "translated": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "c2kh1fiux8bl7" + } }, - "firstName": { - "type": "string", - "description": "User’s first name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." + "translationRejected": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "o3ezy93r7i26i" + } }, - "lastName": { - "type": "string", - "description": "User’s last name. Retrieved only for RWS ID (formerly SDL ID) users (not service users) that the authenticated entity is authorized to read." + "translationApproved": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "9380xqwtvbrsl" + } }, - "location": { - "$ref": "#/components/schemas/resource-folder-request" + "signOffRejected": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "ahddzpafpv7mv" + } }, - "groups": { - "type": "array", - "description": "The groups.", - "items": { - "$ref": "#/components/schemas/group-request" + "signOff": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "yijp1eutihsi4" } }, - "anonymized": { - "type": "boolean", - "description": "Shows if the authenticated entity has access to read the details of the user or not. If true then the ‘anonymizedUserName’ should be retrieved.", - "nullable": true + "notTranslated": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "ezuj0yylywjk7" + } }, - "anonymizedUserName": { - "type": "string", - "description": "Retrieved if the authenticated entity does not have access to read the User." + "draft": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "aibykf8ozjqmt" + } } - }, - "required": [ - "id" - ] + } }, - "vendor-order": { - "title": "Vendor Order", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "quote": { - "$ref": "#/components/schemas/quote" - } + "translation-concordance-search-standard-penalties": { + "title": "Translation Memory Concordance Standard Penalties", + "x-stoplight": { + "id": "9c3abb6urgvqh" }, - "required": [ - "id" - ], - "description": "A vendor order resource." - }, - "vendor-order-template-request": { - "title": "Vendor Order Template Request", "type": "object", "properties": { - "id": { - "type": "string" + "alignment": { + "type": "integer", + "x-stoplight": { + "id": "ipk0iaseeokla" + }, + "default": 1, + "minimum": 0, + "maximum": 20 + }, + "characterWidthDifference": { + "type": "integer", + "default": 1, + "minimum": 0, + "maximum": 20 } }, - "required": [ - "id" - ] + "description": "" }, - "vendor-order-template": { - "title": "Vendor Order Template", - "description": "The vendor order template.", - "type": "object", - "properties": { - "id": { - "type": "string" - } + "translation-concordance-search-unit-status-penalties": { + "title": "Translation Unit Status Concordance Penalties", + "x-stoplight": { + "id": "x6ufijbtx0mff" }, - "required": [ - "id" - ] - }, - "workflow": { - "title": "Workflow", "type": "object", - "description": "The steps a project goes through. (Not available for List Projects endpoint)", + "description": "The penalties to apply depending on the status of the translation unit.", "properties": { - "id": { - "type": "string", - "description": "The workflow identifier." + "translated": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "c2kh1fiux8bl7" + } }, - "name": { - "type": "string", - "description": "
default
The workflow name.
", - "x-default-field": true + "translationRejected": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "o3ezy93r7i26i" + } }, - "description": { - "type": "string", - "description": "The workflow description." + "translationApproved": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "9380xqwtvbrsl" + } }, - "location": { - "$ref": "#/components/schemas/folder" + "signOffRejected": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "ahddzpafpv7mv" + } }, - "workflowTemplate": { - "$ref": "#/components/schemas/workflow-template" + "signOff": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "yijp1eutihsi4" + } }, - "taskConfigurations": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow-task-configuration" + "notTranslated": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "ezuj0yylywjk7" } }, - "languageDirections": { - "type": "array", - "items": { - "$ref": "#/components/schemas/language-direction-no-statistics" + "draft": { + "type": "integer", + "minimum": 0, + "maximum": 20, + "default": 0, + "x-stoplight": { + "id": "aibykf8ozjqmt" } } - }, - "required": [ - "id" - ] + } }, - "workflow-task-assignee": { - "title": "Workflow Task Assignee", - "type": "object", - "description": "Task assignee. Based on the \"type\", further details can be retrieved.
For ex. for \"type\"=\"user\", \"user\" property is available.
For \"projectCreator\" and \"projectManager\" no other property is available.", - "properties": { - "type": { - "type": "string", - "enum": [ - "user", - "group", - "vendorOrderTemplate", - "projectCreator", - "projectManager" - ] - }, - "user": { - "$ref": "#/components/schemas/user", - "description": "
default
User in the account
", - "x-default-field": true - }, - "group": { - "$ref": "#/components/schemas/group", - "description": "
default
Group of users.
", - "x-default-field": true - }, - "vendorOrderTemplate": { - "$ref": "#/components/schemas/vendor-order-template", - "description": "
default
A vendor oder template.
", - "x-default-field": true - } + "translation-search-TM-penalties": { + "title": "Translation TM Penalties", + "x-stoplight": { + "id": "6kx5w2gbj2696" }, - "required": [ - "type" - ] - }, - "workflow-task-assignee-request": { - "title": "Workflow Task Assignee Request", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "user", - "group", - "vendorOrderTemplate", - "projectCreator", - "projectManager" - ] - }, - "user": { - "$ref": "#/components/schemas/user-request" - }, - "group": { - "$ref": "#/components/schemas/group-request" + "standardPenalties": { + "$ref": "#/components/schemas/translation-search-standard-penalties", + "x-stoplight": { + "id": "q58i9rha03e0z" + } }, - "vendorOrderTemplate": { - "$ref": "#/components/schemas/vendor-order-template-request" + "translationUnitStatusPenalties": { + "$ref": "#/components/schemas/translation-search-unit-status-penalties", + "x-stoplight": { + "id": "8pzly4obx7tiz" + } } - }, - "required": [ - "type" - ] + } }, - "workflow-task-configuration": { - "title": "Workflow Task Configuration", + "concordance-search-TM-penalties": { + "title": "Concordance Search TM Penalties", + "x-stoplight": { + "id": "6kx5w2gbj2696" + }, "type": "object", - "description": "Properties of a workflow task.", "properties": { - "scope": { - "$ref": "#/components/schemas/task-configuration-scope" - }, - "assignees": { - "$ref": "#/components/schemas/workflow-task-assignee" - }, - "isSkipped": { - "type": "boolean", - "nullable": true, - "description": "
default
", - "x-default-field": true + "standardPenalties": { + "$ref": "#/components/schemas/translation-concordance-search-standard-penalties", + "x-stoplight": { + "id": "q58i9rha03e0z" + } }, - "taskTemplate": { - "$ref": "#/components/schemas/workflow-task-template" + "translationUnitStatusPenalties": { + "$ref": "#/components/schemas/translation-concordance-search-unit-status-penalties", + "x-stoplight": { + "id": "8pzly4obx7tiz" + } } - }, - "required": [ - "scope", - "taskTemplate" - ] + } }, - "workflow-phase": { - "title": "Workflow Phase", + "translation-concordance-search-resource": { + "title": "Translation Concordance Search Resource", + "x-stoplight": { + "id": "20ixo2ym2xerq" + }, "type": "object", - "description": "A set of workflow steps which work together towards a localization outcome.", + "required": [ + "resourceId", + "type" + ], "properties": { - "id": { + "resourceId": { "type": "string", - "description": "The phase identfier." + "x-stoplight": { + "id": "9rewrlat7xg1p" + }, + "description": "The resource identifier." }, - "name": { + "type": { "type": "string", - "description": "
default
The phase name.
", - "x-default-field": true + "x-stoplight": { + "id": "ablx3ujgx5zyg" + }, + "enum": [ + "TM" + ], + "description": "The resource type." } - }, - "required": [ - "id" - ] + } }, - "workflow-task-configuration-request": { - "title": "Workflow Task Configuration Request", + "language-direction-general-request": { + "title": "Language Direction General Request", + "x-stoplight": { + "id": "0pezqwl74njpv" + }, "type": "object", - "description": "A task configuration request.", + "description": "The language directions model used for creating or updating a resource.", "properties": { - "taskTemplate": { - "$ref": "#/components/schemas/object-id" - }, - "isSkipped": { - "type": "boolean" - }, - "assignees": { - "type": "array", - "description": "Specifies the list of assignees for the task template. \n
When the 'isSkipped' field is set to 'true', an empty list of assignees should be specified.\r\n
Total assignee count is limited. See more at [Assigning users and groups to workflow tasks](https://docs.rws.com/791595/743481/trados-enterprise---accelerate/assigning-users-and-groups-to-workflow-tasks) point 5e.", - "items": { - "$ref": "#/components/schemas/workflow-task-assignee-request" + "sourceLanguage": { + "$ref": "#/components/schemas/source-language-request", + "x-stoplight": { + "id": "ik01rev5dxdym" } }, - "scope": { - "$ref": "#/components/schemas/task-configuration-scope-request" + "targetLanguage": { + "$ref": "#/components/schemas/target-language-request", + "x-stoplight": { + "id": "72zo0gp14dpdp" + } } - }, - "required": [ - "taskTemplate", - "isSkipped", - "assignees", - "scope" - ] + } }, - "workflow-task-template": { - "title": "Workflow Task Template", + "translation-lookup-input-request": { + "title": "Translation Lookup Input Request", + "x-stoplight": { + "id": "k91lzmo3d80y4" + }, "type": "object", + "description": "The translation input.", + "required": [ + "content", + "contentType" + ], "properties": { - "id": { - "type": "string", - "description": "The workflow task template identifier." - }, - "name": { - "type": "string", - "description": "
default
The workflow task template name.
", - "x-default-field": true + "content": { + "type": [ + "string" + ], + "x-stoplight": { + "id": "d90k7nxt66cq9" + }, + "description": "A plain text phrase or a BCM fragment with a single segment serialized as JSON string." }, - "apiInternalId": { + "contentType": { "type": "string", "x-stoplight": { - "id": "dd6vytpa9vo41" + "id": "7lkm3ehfoeipb" }, - "description": "
default
Unique identifier of workflow task templates\r\n
" - }, - "description": { - "type": "string" - }, - "canSkip": { - "type": "boolean", - "nullable": true - }, - "requiresAssignment": { - "type": "boolean", - "nullable": true - }, - "taskType": { - "$ref": "#/components/schemas/task-type" - }, - "phase": { - "$ref": "#/components/schemas/workflow-phase" + "enum": [ + "text", + "bcmFragment" + ], + "description": "The content type." } - }, - "required": [ - "id" - ] + } }, - "workflow-template": { - "title": "Workflow Template", + "translation-concordance-input-request": { + "title": "Translation Concordance Input Request", + "x-stoplight": { + "id": "gzgvhcqrx5qjh" + }, "type": "object", + "required": [ + "content" + ], "properties": { - "id": { - "type": "string", - "description": "The workflow template identifier." - }, - "name": { - "type": "string", - "description": "
default
The workflow template name.
", - "x-default-field": true - }, - "description": { + "content": { "type": "string", - "description": "The workflow template description." - }, - "taskTemplates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow-task-template" - } - }, - "phases": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow-phase" - } - }, - "transitions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/workflow-template-transition" - } + "x-stoplight": { + "id": "8t10luex044ia" + }, + "description": "Text to search for." } - }, - "required": [ - "id" - ] + } }, - "workflow-template-transition": { - "title": "Workflow Template Transition", + "translation-tu-update-input-request": { + "title": "Translation TU Input Request", + "x-stoplight": { + "id": "wstvyd816xr0e" + }, "type": "object", + "required": [ + "content" + ], "properties": { - "from": { - "$ref": "#/components/schemas/workflow-template-transition-node", - "description": "
default
", - "x-default-field": true - }, - "to": { - "$ref": "#/components/schemas/workflow-template-transition-node", - "description": "
default
", - "x-default-field": true - }, - "condition": { - "$ref": "#/components/schemas/workflow-template-transition-condition" + "content": { + "type": "string", + "x-stoplight": { + "id": "srf6ctoqfhljn" + }, + "description": "The Translation Unit update content as a BCM fragment serialized in JSON string." } } }, - "workflow-template-transition-condition": { - "title": "Workflow Template Transition Condition", + "zip-file-export-request": { + "title": "Export Project Files Request", "type": "object", "properties": { - "type": { - "type": "string", - "enum": [ - "outcome", - "expression" - ], - "nullable": true, - "description": "
default
", - "x-default-field": true + "referenceFiles": { + "$ref": "#/components/schemas/zip-file-export-reference-files-request" }, - "value": { - "type": "string", - "description": "
default
", - "x-default-field": true + "targetFiles": { + "$ref": "#/components/schemas/zip-file-export-target-files-request" } } }, - "workflow-template-transition-node": { - "title": "Workflow Template Transition Node", + "zip-file-export-reference-files-request": { + "title": "Export Project Reference Files Request", "type": "object", + "description": "Reference files associated with the project.", "properties": { - "type": { - "type": "string", - "enum": [ - "taskTemplate", - "start", - "end" - ], - "description": "
default
", - "x-default-field": true - }, - "taskTemplate": { - "$ref": "#/components/schemas/workflow-task-template", - "description": "
default
", - "x-default-field": true + "include": { + "type": "boolean", + "description": "Add reference files to the export package.", + "default": true } } }, - "workflow-update-request": { - "title": "Workflow Update Request", + "zip-file-export-target-files-request": { + "title": "Export Project Target Files Request", "type": "object", - "description": "A model to update a workflow.", + "description": "Target files associated with the project.", "properties": { - "name": { - "type": "string", - "description": "The workflow name." - }, - "description": { + "includeVersions": { "type": "string", - "description": "The workflow description." + "enum": [ + "currentVersion", + "none", + "nativeVersion" + ], + "description": "Include target files with these versions into the export.", + "default": "currentVersion", + "x-stoplight": { + "id": "7s4voozws4tse" + } }, - "taskConfigurations": { + "targetLanguages": { "type": "array", - "description": "The task configurations.", + "description": "Include target files for the specified languages (e.g., 'en-US', 'de-DE'). Only one target language is supported when `downloadFlat` is set to `true`.", "items": { - "$ref": "#/components/schemas/workflow-task-configuration-request" + "x-stoplight": { + "id": "3pr8zsp16si53" + }, + "type": "string" } + }, + "downloadFlat": { + "type": "boolean", + "x-stoplight": { + "id": "ebjydtoffk5xl" + }, + "description": "If this flag is set to `true`, folder structure will reflect exactly the file paths. If the flag is set to `false`, a ZIP folder will be generated with a structure similar to the one provided by Trados.", + "default": false } } }, - "well-known-jwks-response": { - "title": "Well Known Keys Response", - "x-stoplight": { - "id": "1owp0jo4rmrg7" - }, + "zip-file-export-response": { + "title": "Project Files export poll response", "type": "object", + "required": [ + "exportId", + "state" + ], "properties": { - "keys": { - "$ref": "#/components/schemas/list-jwks", - "x-stoplight": { - "id": "dbkidlpmb0wk4" - }, - "description": "The list of public keys." + "exportId": { + "type": "string", + "description": "The identifier of the export operation" + }, + "state": { + "description": "The status of the export", + "default": "created", + "enum": [ + "created", + "processing", + "done", + "error" + ] } } } diff --git a/articles/LCPublicAPI/docs/API-rate-limits.md b/articles/LCPublicAPI/docs/API-rate-limits.md index 709f4de..6581f67 100644 --- a/articles/LCPublicAPI/docs/API-rate-limits.md +++ b/articles/LCPublicAPI/docs/API-rate-limits.md @@ -32,6 +32,11 @@ each tenant is entitled to: 2. Up to 10 API requests per minute. 3. Up to 1000 API requests per day. +#### Import / Export Translation Memory limits: +1. Up to 2 API requests per second. +2. Up to 10 API requests per minute. +3. Up to 2000 API requests per day. + #### Project Files Rate Limits For each of the API operations listed below: diff --git a/articles/LCPublicAPI/docs/Language-codes.md b/articles/LCPublicAPI/docs/Language-codes.md index 18a84df..5c73090 100644 --- a/articles/LCPublicAPI/docs/Language-codes.md +++ b/articles/LCPublicAPI/docs/Language-codes.md @@ -10,4 +10,4 @@ For example the Trados Cloud Platform API can return the same language code but All 3 variants are equivalent. -When making a request to the Trados Cloud Platform API, you should still ensure the correct casing of language codes, to avoid any unexpected situations. +When making a request to the Trados Cloud Platform API, you should still ensure the correct casing of language codes, to avoid any unexpected situations. \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/Whats-New.md b/articles/LCPublicAPI/docs/Whats-New.md index 8a5fb7d..dc00a91 100644 --- a/articles/LCPublicAPI/docs/Whats-New.md +++ b/articles/LCPublicAPI/docs/Whats-New.md @@ -1,6 +1,52 @@ # What's new -
+
+ +## 10 September 2025 +- With this release we deliver [Lookup](../reference/Public-API.v1.json/paths/~1translations~1lookup/post), [Concordance](../reference/Public-API.v1.json/paths/~1translations~1concordance/post), [Add](../reference/Public-API.v1.json/paths/~1translations~1translation-unit/post) and [Update](../reference/Public-API.v1.json/paths/~1translations~1translation-unit/put) translation units to a translation memory. See [this](./translations/Translations.md) page for more details. +- You can now [obtain](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/get) and [update](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) the resources sequence information for a Translation Engine. +- A new project event `PROJECT.STARTED` has been added. See [this](./webhooks/Webhooks-payload.md) page for more details. + + +## 18 August 2025 + +- The new, modernized Trados Cloud Platform SDK for Java is now available. See the upgrade guide [here](../docs/api-clients/java/Java-Client-Upgrade-Guide.md). + +## 12 August 2025 + +- You can now get word count and cost estimation analysis of files without the need to create a project. The functionality is accessible via the [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) and [Poll File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis~1{operationId}/get) endpoints. +- As previously announced, the `languageProcessingRuleId` parameter is now mandatory for [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint. +- We fixed various bugs. + +## 15 July 2025 +- You can now add the `systemStatus` property on termbase entries. See [Update Termbase Entry](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries~1{entryId}/put). +- We've improved the documentation around zip files on [Add Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) and [Attach Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoints. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint will be mandatory. +- [Import Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports/post) and [Poll Termbase Import](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports~1{importId}/get) endpoints will return `pending` instead of `queued` for the status. This change is scheduled to take effect no sooner than six months from now. + +## 8 May 2025 +- You can now download the target files associated with a project in a ZIP format. This functionality is accessible through three endpoints: [Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports/post), [Poll](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}/get), and [Download](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}~1download/get). +- With this release we deliver the [Create](../reference/Public-API.v1.json/paths/~1pricing-models/post), [Update](../reference/Public-API.v1.json/paths/~1pricing-models~1{pricingModelId}/put) and [Delete](../reference/Public-API.v1.json/paths/~1pricing-models~1{pricingModelId}/delete) pricing model endpoints. Together with these, several changes were required to correct the pricing model response: + - `name` : changed from required to default. + - `additionalCosts.volumeUnitType` changed from required to non required. + - `additionalCosts.conditionalCostType` changed from required to non required. + - `additionalCosts.costOperator` changed from required to non required. + - `additionalCosts.costVariable` changed from required to non required. + - `additionalCosts.operand` changed from required to non required. + - `perTargetLanguage` and `perFile` cost types have been removed from `languageCosts` to clean up the structure. + +- We have expanded the cost types by introducing two new values: **adhoc** and **adhoc volume**. +- Import and Export TM endpoints are now subject to API limits. For more details, please refer to [this page](../docs/API-rate-limits.md). +- We updated the [Java Client samples](../docs/api-clients/java/Java-Samples.md) to reflect the usage of the latest version. +- We fixed various bugs. + +## 1 April 2025 +- As part of the Connected AI feature, we have added the following updates and new endpoints: + - We have introduced a new endpoint for listing [Large Language Models](../reference/Public-API.v1.json/paths/~1connected-ai~1llm-configurations/get) (LLMs). + - We have added the functionality to [update your translation engines](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) with the new LLM resource type. +- We have added the source word count to the [List Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/get) endpoint. +- We fixed various bugs. + ## 10 March 2025 diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md new file mode 100644 index 0000000..e0c2359 --- /dev/null +++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Client-Upgrade-Guide.md @@ -0,0 +1,169 @@ +--- +stoplight-id: b309fcde3938d +--- + + +# Trados Cloud Platform SDK - Migration Guide v25.x.x + +## Executive Summary + +The Trados Cloud Platform API SDK has transitioned from a "fat JAR" to a "light JAR" architecture, delivering faster downloads, improved dependency management, and better build performance. For most users, migration requires only a version update in your build configuration. + + +**What Changed:** +1. **Modernized Dependencies:** JUnit 4 → 5, Apache HttpClient 4 → 5, Commons Lang 2→3 +2. **OpenAPI Generator:** Version 6.5.0 → 7.14.0 with enhanced nullability annotations +3. **Enhanced Features:** New `LCContext.executeInScope()` methods for improved tenant/trace context management +4. **Updated Tooling:** Latest versions of Jackson, Feign, and other core libraries + +## Step-by-Step Migration Guide + +### For Standard API Usage (Most Users): + +If you're using the generated SDK classes like `ProjectApi`, `SourceFileApi`, etc., migration is straightforward: + +1. Update SDK version to 25.x.x in your build configuration. +2. Run your build command to verify everything works. +3. Review and update your code for compatibility with the new OpenAPI Generator output (see the section [OpenAPI Generator & Generated Code Changes](#openapi-generator--generated-code-changes) below for details). +4. Your API calls should work as before, but review and resolve any compilation issues related to the above changes. + +```java +// Your existing code continues to work +ProjectApi projectApi = languageCloudClientProvider.getProjectClient(); +Project project = projectApi.createProject(projectCreateRequest, queryParams); +``` +## Troubleshooting + +**Most Common Issue**: Build fails after version update +**Solution**: Run `mvn dependency:tree` to check for dependency conflicts + +**Issue**: `ClassNotFoundException: feign.Client` +**Solution**: Verify Feign dependencies: `mvn dependency:tree | grep feign` + +**Issue**: `NoClassDefFoundError` for HTTP client classes +**Solution**: Update imports from `org.apache.http` to `org.apache.hc.core5.http` + +**Issue**: Commons Lang methods not found +**Solution**: Update imports from `org.apache.commons.lang` to `org.apache.commons.lang3` + +## Success Validation + +**For Standard Users:** +1. Clean build: `mvn clean install` succeeds +2. API functionality works as before +3. Faster builds and smaller downloads + +**For Advanced Users:** +- Run `mvn dependency:tree` - no conflicts shown +- Test application startup and core functionality + +### Advanced Scenarios + +
+Click here if you use direct dependency imports or custom configurations + +#### Direct Dependency Usage: +- Update HttpClient imports: `org.apache.http` → `org.apache.hc.core5.http` +- Update Commons Lang imports: `org.apache.commons.lang` → `org.apache.commons.lang3` +- Use dependency exclusions if you encounter version conflicts + +#### Custom Classpath Management: +1. Review current JAR collection and identify SDK dependencies +2. Ensure all transitive dependencies are included in classpath +3. Test application startup and core functionality +4. Consider migrating to Maven/Gradle for simplified dependency management + +#### Test Framework Updates: +- **JUnit Migration**: JUnit 4 → JUnit 5 (Jupiter) + - Update test annotations: `@Test` imports change from `org.junit.Test` → `org.junit.jupiter.api.Test` + - Replace `@Before/@After` with `@BeforeEach/@AfterEach` + - Update assertion imports: `org.junit.Assert` → `org.junit.jupiter.api.Assertions` +- **Mockito Updates**: Version 3.x → 5.x + - Update imports if using `mockito-junit-jupiter` directly + - Verify mock behavior with newer Mockito features + +#### OpenAPI Generator & Generated Code Changes: +- **OpenAPI Generator**: Version 6.5.0 → 7.14.0 (major version upgrade) +- **Generated Code Improvements**: Enhanced code generation with: + - **New Nullability Annotations**: `@javax.annotation.Nullable` and `@javax.annotation.Nonnull` annotations for better null safety + - **Bean Validation Support**: Enhanced validation annotations for API parameters + - **Improved Code Quality**: Updated Mustache templates producing cleaner, more maintainable generated code + - **Better Method Naming**: Collection helper methods use improved naming conventions for better readability + - **Enhanced Enum Handling**: Improved enum comparison and naming with configurable case sensitivity support + - **Modernized Templates**: Generated classes follow current Java best practices + +#### Benefits: +- Generated classes are easier to use and understand +- Better IDE support with improved nullability annotations +- More consistent naming conventions across generated code +- Enhanced type safety and validation + +
+ +## Validation & Success Criteria + +**For Standard Users:** +1. **Clean Build**: Your project builds successfully +2. **API Functionality**: SDK operations work as before - no code changes needed +3. **Performance**: Faster builds and smaller downloads + +**Advanced Validation:** +- **Dependency Check**: `mvn dependency:tree` shows no conflicts +- **Custom Configurations**: Test application startup and functionality + +## Reference: Key Dependencies + +### High-Impact Dependencies (Most Likely to Affect You) + +| Library | Previous | New | Notes | +|---------------------|----------|--------|------------------------------| +| Feign (HTTP Client) | 10.11 | 13.6 | Core SDK communication | +| Jackson (JSON) | 2.10.3 | 2.19.1 | API serialization | +| Apache HttpClient | 4.5.8 | 5.5 | HTTP transport | +| JUnit (Tests) | 4.13 | 5.13.2 | Test framework modernization | + +
+View Complete Dependency List + +**All Updated Dependencies:** + +| GroupId | ArtifactId | Previous Version | New Version | Impact | +|-----------------------------------|---------------------------|------------------|-------------|------------| +| io.github.openfeign | feign-core | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-jackson | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-slf4j | 10.11 | 13.6 | **High** | +| io.github.openfeign | feign-form | 3.8.0 | 13.6 | **High** | +| io.github.openfeign | feign-okhttp | 10.11 | 13.6 | **High** | +| com.fasterxml.jackson.core | jackson-core | 2.10.3 | 2.19.1 | **Medium** | +| com.fasterxml.jackson.core | jackson-annotations | 2.10.3 | 2.19.1 | **Medium** | +| com.fasterxml.jackson.core | jackson-databind | 2.10.3 | 2.19.1 | **Medium** | +| org.apache.httpcomponents.client5 | httpclient5 | 4.5.8* | 5.5 | **Medium** | +| com.fasterxml.jackson.datatype | jackson-datatype-jsr310 | 2.10.3 | 2.19.1 | Low | +| com.fasterxml.jackson.datatype | jackson-datatype-joda | 2.0.4 | 2.19.1 | Low | +| org.openapitools | jackson-databind-nullable | 0.2.1 | 0.2.6 | Low | +| org.apache.commons | commons-lang3 | 2.6* | 3.18.0 | Low | +| com.github.spotbugs | spotbugs-annotations | 3.0.2* | 4.9.3 | Low | +| javax.annotation | javax.annotation-api | 1.0* | 1.3.2 | Low | +| org.projectlombok | lombok | RELEASE | 1.18.38 | Low | +| org.slf4j | slf4j-simple | - | 2.0.13 | Low | + +
+ +*Different groupId or artifactId in previous version + +### Test Dependencies + +| GroupId | ArtifactId | Previous Version | New Version | Impact | +|-------------------|-----------------------|------------------|-------------|----------| +| org.junit.jupiter | junit-jupiter-engine | 4.13* | 5.13.2 | **High** | +| org.mockito | mockito-junit-jupiter | 3.12.1* | 5.18.0 | **High** | + +*Different groupId or artifactId in previous version + +### Most Important Changes + +**Critical**: Maven Shade Plugin removed (enables fat→light JAR transition) +**Modernization**: All dependencies updated to current versions +**Code Quality**: OpenAPI Generator 6.5.0 → 7.14.0 with better nullability support + + diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md index 6e4f1d5..3d6d9f2 100644 --- a/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md +++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Client.md @@ -1,6 +1,6 @@ # Java Client -This client library is targeting Java 11 and above and it represents a collection of API clients structured in accordance with the API documentation, meaning each section will have its own client. +This client library targets Java 11 and above. It provides API clients organized by API documentation sections. The generated Java clients are based on [OpenFeign](https://spring.io/projects/spring-cloud-openfeign). @@ -8,7 +8,7 @@ The generated Java clients are based on [OpenFeign](https://spring.io/projects/s > The Java Client library is auto-generated from the current API contracts, so any updates to the contract will reflect as changes in the SDK client. Minor version increases do not guarantee backwards compatibility. ## Installation -You can add this library to your project as a [Maven](https://search.maven.org/artifact/com.rws.lt.lc.public-api/lc-public-api-sdk/1.1.0/jar) dependency. +You can add this library to your project as a [Maven](https://search.maven.org/artifact/com.rws.lt.lc.public-api/lc-public-api-sdk/24.0.9/jar) dependency. Include the client library in the `pom.xml`: @@ -16,19 +16,23 @@ Include the client library in the `pom.xml`: com.rws.lt.lc.public-api lc-public-api-sdk - 1.1.0 + 24.0.9 ``` > Make sure to always reference the latest available version. Check the [Maven Central Repository](https://search.maven.org/artifact/com.rws.lt.lc.public-api/lc-public-api-sdk) for more info. ## Usage -We will take the project creation flow as an example to show how the API clients can be used. +We will use the project creation flow as an example to show how the API clients can be used. -The API client can be initialized as required, based on the endpoints you are targeting. -The authorization parameter is not required when calling client methods, if you previously added authorization when you instantiated the client. +API clients can be initialized individually based on the endpoints you need to target. +If authorization was provided when instantiating the client, it's not required again when calling its methods. -For example, if you need to make use of the Project features, you may instantiate a Project client, as follows: +Trados Cloud Platform operates in multiple regions; ensure you select the correct region for your integration. +*See the [Multi Region](../../../docs/Multi-Region.md) page for more details.* + +The default region for `LanguageCloudClientProvider` is `eu`, but you can override it. +For example, to use Project features, instantiate a Project client like this: ```java @@ -36,7 +40,10 @@ For example, if you need to make use of the Project features, you may instantiat ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID"); // instantiate the LanguageCloudClientProvider -LanguageCloudClientProvider languageCloudClientProvider = new LanguageCloudClientProvider(serviceCredentials); +LanguageCloudClientProvider languageCloudClientProvider = LanguageCloudClientProvider.builder() + .withRegionCode("ca") // default is "eu" + .withServiceCredentials(serviceCredentials) + .build(); // instantiate the client ProjectApi projectApi = languageCloudClientProvider.getProjectClient(); @@ -49,8 +56,11 @@ ProjectCreateRequest projectCreateRequest = new ProjectCreateRequest(); projectCreateRequest.setName("YOUR_PROJECT_NAME"); projectCreateRequest.setDueBy(DateTime.parse("2025-01-01T00:00:00.000Z")); projectCreateRequest.setProjectTemplate(new ObjectIdRequest().id("YOUR_PROJECT_TEMPLATE_ID")); - -Project projectCreateResponse = projectApi.createProject(projectCreateRequest, new HashMap<>()); + +// Set the `fields` query parameter so the response is populated with `projectPlan.taskConfigurations` +ProjectApi.CreateProjectQueryParams queryParams = new ProjectApi.CreateProjectQueryParams(); +queryParams.fields("projectPlan.taskConfigurations"); +Project projectCreateResponse = projectApi.createProject(projectCreateRequest, queryParams); ``` #### 2. Attach a source file to the project: @@ -59,16 +69,15 @@ Projects that do not contain source files cannot be started. ```java SourceFileApi sourceFileApi = languageCloudClientProvider.getSourceFileClient(); - + SourceFileRequest properties = new SourceFileRequest(); -properties.setLanguage("en-US"); +properties.setLanguage(new LanguageRequest("en-US")); properties.setName("YOUR_TEXT_SOURCE_FILE"); properties.setRole(SourceFileRequest.RoleEnum.TRANSLATABLE); properties.setType(SourceFileRequest.TypeEnum.NATIVE); -File file = new File("YOUR_TEXT_SOURCE_FILE_PATH"); - -SourceFile sourceFile = sourceFileApi.addSourceFile("YOUR_PROJECT_ID", file, properties); +File file = new File("YOUR_TEXT_SOURCE_FILE_PATH"); +SourceFile sourceFile = sourceFileApi.addSourceFile("YOUR_PROJECT_ID", properties, file); ``` #### 3. Start the project: diff --git a/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md b/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md index a90f449..f1af7f6 100644 --- a/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md +++ b/articles/LCPublicAPI/docs/api-clients/java/Java-Samples.md @@ -4,35 +4,47 @@ The console application sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/Java/PublicApi.Sample.Console.Java). -The sample contains 3 examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider, or handle the authentication on you own: +The sample contains three examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider or handle the authentication yourself: -#### 1. Instantiating a client using credentials +#### 1. Instantiating a client using service credentials -You can instantiate a client using the supplied `LanguageCloudClientProvider` class. This method requires you provide a `ServiceCredentials` object, which should contain your `clientID`, `clientSecret` and the `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.* +You can instantiate a client using the provided `LanguageCloudClientProvider.builder()` pattern. + +This method requires you to provide a `ServiceCredentials` object containing your `clientID`, `clientSecret`, and `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.* ```java import com.rws.lt.lc.publicapi.sdk.api.GroupApi; import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials; import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider; +import com.rws.lt.lc.publicapi.sdk.model.Group; import com.rws.lt.lc.publicapi.sdk.model.ListGroupsResponse; + +import java.util.stream.Collectors; ... //instantiate the credentials ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID", "YOUR_CLIENT_SECRET", "YOUR_TENANT_ID"); // instantiate the LanguageCloudClientProvider -LanguageCloudClientProvider languageCloudClientProvider_clientIdClientSecret = new LanguageCloudClientProvider(serviceCredentials); +LanguageCloudClientProvider languageCloudClientProvider = LanguageCloudClientProvider + .builder() + .withRegion("eu") // optional (default is "eu") + .withServiceCredentials(serviceCredentials) + .build(); // instantiate the client -GroupApi groupApi = languageCloudClientProvider_clientIdClientSecret.getGroupClient(); +GroupApi groupApi = languageCloudClientProvider.getGroupClient(); // use the client ListGroupsResponse groupsResponse = groupApi.listGroups(new GroupApi.ListGroupsQueryParams()); System.out.println("Groups:"); -System.out.println(groupsResponse.getItems()); +System.out.println( + groupsResponse.getItems().stream() + .map(Group::getName) + .collect(Collectors.joining("\n"))); ``` - *\*Using this method, a unique TraceID will be generated on each request.* +*\*Using this method, a unique TraceID will be generated for each request.* @@ -43,18 +55,20 @@ System.out.println(groupsResponse.getItems()); #### 2. Instantiating a client using context scoping -This method allows you to make an API call with 2 different users, using the same client instance. +This method allows you to make API calls with multiple different service credentials using the same client instance. -We provide an `LCContext` which exposes some scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with 2 different users: +We provide an `LCContext` which exposes scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with two different service credentials: ```java import com.rws.lt.lc.publicapi.sdk.api.UserApi; import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials; import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider; +import com.rws.lt.lc.publicapi.sdk.context.ContextKeys; import com.rws.lt.lc.publicapi.sdk.context.LCContext; import com.rws.lt.lc.publicapi.sdk.model.ListUsersResponse; +import com.rws.lt.lc.publicapi.sdk.model.User; -import java.util.HashMap; +import java.util.stream.Collectors; ... // define credentials for your first user @@ -64,34 +78,79 @@ ServiceCredentials credentials_1 = new ServiceCredentials("YOUR_CLIENT_ID_1", "Y ServiceCredentials credentials_2 = new ServiceCredentials("YOUR_CLIENT_ID_2", "YOUR_CLIENT_SECRET_2", "YOUR_TENANT_ID_2"); // instantiate the LanguageCloudClientProvider -LanguageCloudClientProvider languageCloudClientProvider_contextAuth = new LanguageCloudClientProvider(); +LanguageCloudClientProvider languageCloudClientProvider_contextAuth = LanguageCloudClientProvider + .builder() + .withRegion("eu") // optional (default is "eu") + .build(); // instantiate the client without credentials UserApi userApi = languageCloudClientProvider_contextAuth.getUserClient(); -// create a context scope and use the client.You can also provide your own traceId -try (LCContext lcContext = LCContext.beginScope(credentials_1, "trace-id-1");) { - ListUsersResponse usersResponse = userApi.listUsers(UserApi.ListUsersQueryParams()); - System.out.println("Users:"); - System.out.println(usersResponse.getItems()); - } catch (Exception e) { - System.out.println("Error when retrieving users with credentials saved to context."); - } - -// create a context scope and use the client.You can also provide your own traceId - try (LCContext lcContext = LCContext.beginScope(credentials_2, "trace-id-2");) { - ListUsersResponse usersResponse = userApi.listUsers(UserApi.ListUsersQueryParams()); - System.out.println("Users:"); - System.out.println(usersResponse.getItems()); - } catch (Exception e) { - System.out.println("Error when retrieving users with credentials saved to context."); - e.printStackTrace(); - } + +Runnable listUsersExecutable = () -> { + ListUsersResponse usersResponse = userApi.listUsers(new UserApi.ListUsersQueryParams()); + System.out.println(LCContext.getFromLCContext(ContextKeys.TRACE_ID_KEY) + " >> Users for tenant " + LCContext.getFromLCContext(ContextKeys.TENANT_ID_KEY) + " are:"); + System.out.println(usersResponse.getItems().stream().map(User::getId).collect(Collectors.joining("\n"))); +}; + +// create a context scope and execute inside with tenant 1 +LCContext.executeInScope(listUsersExecutable, serviceCredentials1, "trace-id-1"); + +System.out.println("--------------------------------------------------"); +// create a context scope and execute inside with tenant 2 +LCContext.executeInScope(listUsersExecutable, serviceCredentials2, "trace-id-2"); ``` -#### 3. Instantiating a client using custom authentication +#### 3. Instantiating a client with App service credentials + +This method allows you to make an API call from an App for different tenants using the same client instance. See more at [Extensibility Docs](https://eu.cloud.trados.com/lc/extensibility-docs/937a747af31a0-concepts#apps). + + +We provide an `LCContext` which exposes scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with an App installed in multiple tenants: + +```java +import com.rws.lt.lc.publicapi.sdk.api.UserApi; +import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials; +import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider; +import com.rws.lt.lc.publicapi.sdk.context.ContextKeys; +import com.rws.lt.lc.publicapi.sdk.context.LCContext; +import com.rws.lt.lc.publicapi.sdk.model.ListUsersResponse; +import com.rws.lt.lc.publicapi.sdk.model.User; + +import java.util.stream.Collectors; +... + +//instantiate the credentials +ServiceCredentials serviceCredentials = new ServiceCredentials("YOUR_CLIENT_ID_1", "YOUR_CLIENT_SECRET_1"); + +// instantiate the LanguageCloudClientProvider +LanguageCloudClientProvider languageCloudClientProvider_contextAuth = LanguageCloudClientProvider + .builder() + .withRegion("eu") // optional (default is "eu") + .withServiceCredentials(serviceCredentials) + .build(); + +// instantiate the client without credentials +UserApi userApi = languageCloudClientProvider_contextAuth.getUserClient(); + + +Runnable listUsersExecutable = () -> { + ListUsersResponse usersResponse = userApi.listUsers(new UserApi.ListUsersQueryParams()); + System.out.println(LCContext.getFromLCContext(ContextKeys.TRACE_ID_KEY) + " >> Users for tenant " + LCContext.getFromLCContext(ContextKeys.TENANT_ID_KEY) + " are:"); + System.out.println(usersResponse.getItems().stream().map(User::getId).collect(Collectors.joining("\n"))); +}; + +// create a context scope and execute inside with tenant 1 +LCContext.executeInScope(listUsersExecutable, TENANT_VALUE_1, "trace-id-1"); + +System.out.println("--------------------------------------------------"); +// create a context scope and execute inside with tenant 2 +LCContext.executeInScope(listUsersExecutable, TENANT_VALUE_2, "trace-id-2"); + +``` +#### 4. Instantiating a client using custom authentication -If you would like to have complete control over the client authentication, you can use provide a CustomServiceAuthenticationHandler: +If you want complete control over client authentication, you can provide a `CustomServiceAuthenticationHandler`: ```java import com.rws.lt.lc.publicapi.sdk.api.ProjectApi; @@ -101,24 +160,34 @@ import com.rws.lt.lc.publicapi.sdk.auth.ServiceCredentials; import com.rws.lt.lc.publicapi.sdk.client.LanguageCloudClientProvider; import com.rws.lt.lc.publicapi.sdk.model.ListProjectsResponse; +import java.util.List; import java.util.UUID; ... -AuthenticationService authenticationService = new AuthenticationService("grant_type", "audience", "url"); +AuthenticationService authenticationService = AuthenticationService.getInstance(); CustomServiceAuthenticationHandler customServiceAuthenticationHandler = new CustomServiceAuthenticationHandler(authenticationService) { - @Override - public ServiceCredentials getServiceCredentials() { - return new ServiceCredentials("YOUR_CLIENT_ID_1", "YOUR_CLIENT_SECRET_1", "YOUR_TENANT_ID_1"); - } - - @Override - public String getTraceId() { - return UUID.randomUUID().toString(); - } + @Override + public ServiceCredentials getServiceCredentials() { + return new ServiceCredentials(CLIENT_ID, CLIENT_SECRET); + } + + @Override + public String getTraceId() { + return UUID.randomUUID().toString(); + } + + @Override + public String getTenantId() { + return TENANT_VALUE; + } }; -LanguageCloudClientProvider languageCloudCustomClientProvider = new LanguageCloudClientProvider(customServiceAuthenticationHandler, "baseUrl"); +LanguageCloudClientProvider languageCloudCustomClientProvider = LanguageCloudClientProvider + .builder() + .withRegion("eu") // optional (default is "eu") + .withRequestInterceptors(List.of(customServiceAuthenticationHandler)) + .build(); // instantiate the client ProjectApi projectApi = languageCloudCustomClientProvider.getProjectClient(); @@ -136,41 +205,52 @@ The web API sample is available for download on [GitHub](https://github.com/RWS/ The sample contains two examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK for Java: -- *If you want to use the provided authentication mechanism, a custom handler can be created, which must inherit from `CustomServiceAuthenticationHandler`.* +- *If you want to use the provided authentication mechanism, create a custom handler that inherits from `CustomServiceAuthenticationHandler`.* -- *If you want to handle authentication and tracing on you own, you could implement your own `DelegatingHandler`.* +In our example, we created the `CustomAuthenticationHandler` class, which inherits from `CustomServiceAuthenticationHandler`. The `CustomServiceAuthenticationHandler` class already provides an authentication mechanism. -In our example, we've created the `CustomAuthenticationHandler` class, which inherits from `CustomServiceAuthenticationHandler`. The `CustomServiceAuthenticationHandler` class already provides us with an authentication mechanism. We've overwritten the `getServiceCredentials` and `getTraceId` methods and provided our own implementations, as these will be called by `CustomAuthenticationHandler`: +We have overridden the `getServiceCredentials`, `getTraceId`, and `getTenantId` methods and provided our implementations, as these will be called by `CustomAuthenticationHandler`: ```java -// Provide you own implementation. A possible example can be: +// Provide your implementation. A possible example can be: @Override public ServiceCredentials getServiceCredentials() { - Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); - User user = (User) authentication.getPrincipal(); + return repository.getServiceCredentialsById(getCurrentUser().getUserId()); +} - return repository.getServiceCredentialsById(user.getUserId()); +// serviceCredentials may or may not be bound to a tenant +@Override +public String getTenantId() { + return repository.getServiceCredentialsById(getCurrentUser().getUserId()).getTenantId(); + // or + // return repository.getTenantForUserId(getCurrentUser().getUserId()); } -// Provide you own implementation. A possible example can be: @Override public String getTraceId() { return UUID.randomUUID().toString(); } + +private User getCurrentUser() { + Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); + return (User) authentication.getPrincipal(); +} ``` -We registered an instance of LanguageCloudClientProvider as a bean in `ConfigClass` class and created beans for all API clients exposed: +We registered an instance of `LanguageCloudClientProvider` as a bean in the `ConfigClass` class and created beans for all exposed API clients: ```java // the LanguageCloudClientProvider instance -@Bean +@Bean public LanguageCloudClientProvider getPublicApiClient(CustomAuthenticationHandler customAuthenticationHandler) { - return new LanguageCloudClientProvider(customAuthenticationHandler, BASE_URL); + return LanguageCloudClientProvider.builder() + .withRegion("eu") // optional (default is "eu") + .withRequestInterceptors(List.of(customAuthenticationHandler)).build(); } //the AccountApi bean @Bean public AccountApi getAccountApi(LanguageCloudClientProvider languageCloudClientProvider) { - return languageCloudClientProvider.getAccountClient(); + return languageCloudClientProvider.getAccountClient(); } ``` @@ -179,14 +259,21 @@ We can then use the registered client in the controller (or any other class reso ```java @RestController public class AccountController extends ResponseEntityExceptionHandler { -// inject the client - @Autowired - private AccountApi accountApi; - ... - - // make an API call using the client - ListMyAccountsResponse listMyAccountsResponse = accountApi.listMyAccounts(); - ... + + @Autowired + private AccountApi accountApi; + + @GetMapping("/getAccounts/{userId}") + public List listAccounts(@PathVariable("userId") int userId) { + User user = new User(userId); + Authentication authentication = new UsernamePasswordAuthenticationToken(user, null); + SecurityContext sc = SecurityContextHolder.getContext(); + sc.setAuthentication(authentication); + + ListMyAccountsResponse listMyAccountsResponse = accountApi.listMyAccounts(); + + return listMyAccountsResponse.getItems(); + } } ``` diff --git a/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md b/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md index 8464fb7..92cd0cf 100644 --- a/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md +++ b/articles/LCPublicAPI/docs/api-clients/net/Net-Samples.md @@ -1,15 +1,23 @@ # Trados Cloud Platform SDK Samples for .NET -
+ +This document is designed to help developers get started with the Trados Cloud Platform SDK in .NET applications. You'll find practical sample code and clear guidance for instantiating API clients using credentials, context scoping, or custom handlers. The examples also show how to integrate the SDK into ASP.NET Web API projects, including tips for dependency injection and custom authentication. Use these samples to quickly implement Trados Cloud Platform features in your console or web API projects. + +Here is some guidance to help you decide which sample to follow: + +- If your application targets a single tenant, the quickest way to get started is the [Instantiating a client using credentials (single tenant)](#instantiating-a-client-using-credentials-single-tenant) sample. +- For background processes that must handle multiple tenants, see the [Instantiating a client using context scoping](#instantiating-a-client-using-context-scoping) sample. +- If you're building a multi-tenant web application and need Dependency Injection that depends on the current user, start with the [Web API Dependency Injection Sample](#web-api-dependency-injection-sample). +- If you require a custom authentication flow, the SDK supports supplying your own handler — see [Instantiating a client using a custom handler](#instantiating-a-client-using-a-custom-handler). ## Console Application Sample The console application sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/.Net/PublicApi.Sample.Console). -It contains 3 examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider, or handle the client instantiation on you own: +It contains three examples of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK. You can either use the supplied provider, or handle the client instantiation on your own: -### Instantiating a client using credentials +### Instantiating a client using credentials (single tenant) -You can instantiate a client using the supplied `LanguageCloudClientProvider` class. This method requires you provide a `ServiceCredentials` object, which contains your `clientID`, `clientSecret` and the `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.* +You can instantiate a client using the supplied `LanguageCloudClientProvider` class. This method requires you to provide a `ServiceCredentials` object, which contains your `clientID`, `clientSecret` and the `tenant`. *See the [Authentication](../../../docs/Authentication.md) page for more details.* ```csharp using Rws.LanguageCloud.Sdk; @@ -29,7 +37,7 @@ var projectClient = clientProvider.GetProjectClient(credentials); var projectsResponse = await projectClient.ListProjectsAsync(); ``` - *\*Using this method, a unique TraceId will be generated on each request.* +*Using this method, a unique TraceId will be generated for each request.* @@ -37,12 +45,11 @@ var projectsResponse = await projectClient.ListProjectsAsync(); > > Make sure you always keep your credentials safe. - ### Instantiating a client using context scoping -This method allows you to make an API call with 2 different users, using the same client instance. +This method lets you make API calls as two different users using the same client instance. -We provide an `ApiClientContext` which exposes some scoping options. You can use this to scope your API calls in different contexts. The sample contains an example with 2 different users: +We provide an `ApiClientContext` which exposes scoping options. You can use it to scope API calls for different users; the sample shows an example with two users: ```csharp using Rws.LanguageCloud.Sdk; @@ -59,7 +66,7 @@ ServiceCredentials credentials_2 = new ServiceCredentials("client-id-2", "client var clientProvider = new LanguageCloudClientProvider("eu"); // instantiate the client without credentials -var client = clientProvider.GetProjectClient(); +var projectClient = clientProvider.GetProjectClient(); // create a context scope and use the client. You can also provide your own traceId using (ApiClientContext.BeginScope(new LCContext(credentials_1, "trace-id-1"))) @@ -97,9 +104,9 @@ var client = clientProvider.GetProjectClientNoAuth(handler); var projectsResponse = await projectClient.ListProjectsAsync(); ``` -

## Web API Dependency Injection Sample + The web API sample is available for download on [GitHub](https://github.com/RWS/language-cloud-public-api-samples/tree/main/.Net/PublicApi.WebApiSample). It contains an example of how to instantiate and work with an API client provided by the Trados Cloud Platform SDK for ASP .Net. @@ -108,10 +115,10 @@ It contains an example of how to instantiate and work with an API client provide > If you want to handle authentication and tracing on you own, you could implement your own `DelegatingHandler`. -In our example, we've created the `LcHandler` class, which inherits from `LCCustomAuthenticationHandler`. The `LCCustomAuthenticationHandler` class already provides us with an authentication mechanism. We've overwritten the `GetServiceCredentials` and `GetTraceId` methods and provided our own implementations, as these will be called by `LCCustomAuthenticationHandler`: +In our example, we've created the `LcHandler` class, which inherits from `LCCustomAuthenticationHandler`. The `LCCustomAuthenticationHandler` class already provides an authentication mechanism. We've overridden the `GetServiceCredentials` and `GetTraceId` methods and provided our own implementations; these will be called by `LCCustomAuthenticationHandler`: ```csharp -// Provide you own implementation. A possible example can be: +// Provide your own implementation. A possible example: protected override ServiceCredentials GetServiceCredentials() { int accountId = int.Parse(context.HttpContext.User.Claims.Single(x => x.Type.Equals("aid")).Value); @@ -121,8 +128,8 @@ protected override ServiceCredentials GetServiceCredentials() } ... - -// Provide you own implementation. A possible example can be: + +// Provide your own implementation. A possible example: protected override string GetTraceId() { return DateTimeOffset.UtcNow.ToString(); @@ -130,12 +137,13 @@ protected override string GetTraceId() ``` We'll need a bit of custom magic to make sure dependency injection works correctly for multi-region. We'll create a custom Factory to provide our clients. An example implementation would be a factory class to provide a per region factory. We'll make sure to have all instances initialized only once, to avoid problems: + ```csharp class RegionClientContainerFactory { - LanguageCloudClientProvider _languageCloudClientProvider; - IServiceProvider _serviceProvider; + private readonly LanguageCloudClientProvider _languageCloudClientProvider; + private readonly IServiceProvider _serviceProvider; private IAccountClient _accountClient; @@ -193,11 +201,11 @@ We'll need a bit of custom magic to make sure dependency injection works correct We register our handler `LcHandler` as a transient service and a Factory class with factory, in the `Startup` class: ```csharp -// handlers must always be transient +// Handlers should be registered as transient services.AddTransient(); -// register a client -services.AddSingleton(provider => new LanguageCloudClientFactory(provider.GetService()); +// Register the LanguageCloudClientFactory as a singleton. Resolve the handler from the provider when needed. +services.AddSingleton(provider => new LanguageCloudClientFactory(provider.GetRequiredService())); ``` We can then use the registered client in the controller (or any other class resolved through Dependency Injection): @@ -222,5 +230,3 @@ public class LanguageCloudApiSampleController : ControllerBase ... } ``` - - diff --git a/articles/LCPublicAPI/docs/translations/Translations.md b/articles/LCPublicAPI/docs/translations/Translations.md new file mode 100644 index 0000000..85e7f05 --- /dev/null +++ b/articles/LCPublicAPI/docs/translations/Translations.md @@ -0,0 +1,313 @@ +# Translation API + +The Translation API provides endpoints for performing translation operations using translation engines. These endpoints allow you to lookup translations, perform concordance searches, and manage translation units within your translation memories. + +## Overview + +The Translation API enables you to: +- **Lookup translations** for text or BCM fragments using translation memories and machine translation +- **Perform concordance searches** to find similar segments within translation memories +- **Add new translation units** to translation memories +- **Update existing translation units** in translation memories + +All translation operations require a translation engine that defines which translation memories, machine translation engines, and termbases to use for the translation process. + + +> The BCM fragment format is used for input and output as JSON string, meaning that you will need to serialize and deserialize the BCM fragments when sending requests or processing responses. For .NET you can use the `Sdl.Core.Bcm.API` [nuget package](https://www.nuget.org/packages/Sdl.Core.Bcm.API). + +## Endpoints + +### Translation Lookup + +[`POST /translations/lookup`](../../reference/Public-API.v1.json/paths/~1translations~1lookup/post) + +Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a [BCM fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). + +**Use cases:** +- Get translation suggestions for a source segment +- Retrieve matches from translation memories +- Get machine translation proposals +- Access termbase entries for specific terms + +**Key features:** +- Supports both plain text and BCM fragment input +- Returns translations from multiple resource types (TM, MT, TB) +- Configurable match thresholds and penalties + +**Request body example:** +```json +{ + "input": { + "content": "Hello world", + "contentType": "text" + }, + "languageDirection": { + "sourceLanguage": { + "languageCode": "en-US" + }, + "targetLanguage": { + "languageCode": "fr-FR" + } + }, + "definition": { + "translationEngineId": "your-translation-engine-id" + }, + "settings": { + "translationMemory": { + "minimumMatchValue": 70, + "penalties": { + "standardPenalties": { + "missingFormatting": 1, + "differentFormatting": 1 + } + } + } + } +} +``` + + +> The `translationProposal` field in the response can be either a BCM fragment or a term. You can rely on the `responseType` field to determine the content type and deserialize it accordingly. + +### Concordance Search + +[`POST /translations/concordance`](../../reference/Public-API.v1.json/paths/~1translations~1concordance/post) + +Performs a concordance search for a given text within the translation memories linked to the specified translation engine. This helps you find segments that contain specific words or phrases. + +**Use cases:** +- Research how certain phrases have been translated previously +- Quality assurance and consistency checking +- Translation memory analysis + +**Key features:** +- Search within source or target segments +- Support for exact and fuzzy matching +- Configurable search parameters and penalties +- Returns matching segments with context + + +> The Translation Memory penalty defined in the Translation Engine will be automatically included in the translation score. + +**Request body example:** +```json +{ + "input": { + "content": "user interface" + }, + "languageDirection": { + "sourceLanguage": { + "languageCode": "en-US" + }, + "targetLanguage": { + "languageCode": "fr-FR" + } + }, + "definition": { + "translationEngineId": "your-translation-engine-id" + }, + "targetOnly": false, + "settings": { + "translationMemory": { + "minimumMatchValue": 80 + } + } +} +``` + +### Translation Unit Management + +#### Update Translation Unit + +[`PUT /translations/translation-unit`](../../reference/Public-API.v1.json/paths/~1translations~1translation-unit/put) + +Updates an existing translation unit in the translation memories. The system identifies matching translation units based on the `originalTranslationHash` provided in the BCM fragment. + + +> After each update the `targetContent.translationOrigin.originalTranslationHash` is updated. The new values are returned in the response on the `translationHash` field. +> Subsequent updates can be performed by updating the `targetContent.translationOrigin.originalTranslationHash` in the BCM fragment with the new `translationHash`, otherwise the system will add a new translation unit instead of updating the existing one. + + +> Changing any fields in the `sourceContent` of a BCM fragment will result in a new translation unit being added instead of updating the existing one. + +**Use cases:** +- Correct existing translations +- Update translation metadata +- Modify translation unit fields +- Maintain translation memory quality + +**Key features:** +- Smart matching of existing translation units +- Preserve or update translation metadata +- Configurable update behavior +- Support for custom fields + +**Request body example for both add and update:** +```json +{ + "input": { + "content": "BCM fragment" + }, + "definition": { + "translationEngineId": "your-translation-engine-id" + }, + "settings": { + "fields": [ + { + "name": "field-name", + "values": [ "field-value" ] + } + ] + } +} +``` + +#### Add Translation Unit + +[`POST /translations/translation-unit`](../../reference/Public-API.v1.json/paths/~1translations~1translation-unit/post) + +Adds a new translation unit to the translation memories. + +**Use cases:** +- Add new translations units whose existence in the translation memory is unknown +- If, however, the translation unit with the same source already exists, it will be updated based on the `ifTargetSegmentsDiffer` field +- Populate translation memories with approved content + +**Key features:** +- Automatic duplicate handling +- Field template support for metadata +- Configurable behavior for existing translations +- BCM fragment support for rich content + +## BCM Fragments + +Many Translation API endpoints work with BCM (Binary Content Model) fragments. BCM is RWS's content model that preserves formatting, tags, and metadata within translation content. + +**BCM advantages:** +- Preserves inline formatting and tags +- Maintains content structure during translation +- Supports complex document elements +- Enables accurate translation memory matching + +For more information about BCM fragments, see the [BCM documentation](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). + +Example of a BCM fragment: +```json +{ + "sourceLanguageCode": "en-US", + "targetLanguageCode": "fr-FR", + "sourceContent": { + "id": "166fbfdd-8e0a-46aa-97bf-7b2b62014e5f", + "segmentNumber": "1", + "confirmationLevel": "Translated", + "type": "segment", + "children": [ + { + "id": "c0cff9db-46e4-493d-b578-25e78d578ea7", + "placeholderTagDefinitionId": 1, + "tagNumber": "50", + "type": "placeholderTag", + "metadata": { + "SDL:IsSoftBreak": "True", + "SpecialCharacterPlaceholder": "‌", + "frameworkOriginalTagId": "50", + "SDL:IsWordStop": "False" + } + }, + { + "id": "4b5cbfc4-53b1-462c-86a4-dbc061b5f266", + "text": "This is a sample text", + "type": "text" + } + ] + }, + "targetContent": { + "id": "166fbfdd-8e0a-46aa-97bf-7b2b62014e5f", + "segmentNumber": "1", + "confirmationLevel": "Translated", + "translationOrigin": { + "originType": "tm", + "originSystem": "Example TM", + "matchPercent": 92, + "textContextMatchLevel": "None", + "originalTranslationHash": "-377851791", + "createdBy": "some-user-id", + "createdOn": "2023-09-25T14:24:04.000Z", + "modifiedBy": "some-user-id", + "modifiedOn": "2025-02-12T09:25:57.000Z", + "metadata": { + "used_on": "04/01/2025 13:56:28", + "used_by": "some-user-id", + "use_count": "8" + } + }, + "type": "segment", + "metadata": { + "Contexts": [ + { + "Context1": 0, + "Context2": 0, + "Segment1": null, + "Segment2": null, + "LeftSource": 0, + "LeftTarget": 0 + } + ] + }, + "children": [ + { + "id": "6143602c-5548-43d0-a2fc-1a5a7f2aeb35", + "text": "Ceci est un exemple de texte", + "type": "text" + } + ] + } +} +``` + +## Translation Memory Penalties + +The Translation API supports various penalty types to fine-tune translation matching: + +### Standard Penalties +- **Missing Formatting**: Penalty for matches missing formatting tags +- **Different Formatting**: Penalty for matches with different formatting +- **Multiple Translations**: Penalty for segments with multiple translation options + +### Translation Unit Status Penalties +- **Translated**: Penalty for translated but not reviewed segments +- **Approved Translation**: Penalty for approved translations +- **Rejected Translation**: Penalty for rejected translations + +Learn more about [Translation Memory penalties](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/trados-tm-penalties-1159224) and [Translation Unit status penalties](https://docs.rws.com/en-US/trados-enterprise-accelerate-791595/editing-project-tm-and-verification-settings-800732). + +## Best Practices + +### Performance Optimization +- Set appropriate minimum match values to reduce processing time +- Use reasonable penalty values to balance quality and performance + +### Quality Management +- Configure penalties based on your quality requirements +- Regularly update translation units to maintain accuracy + +### Translation Memory Maintenance +- Add high-quality translations to build reliable TMs +- Update outdated translations to keep content current +- Use appropriate field templates for metadata management + +## Related APIs + +- **[Translation Memory API](../translation-memory/Translation-memory-import-export.md)**: Bulk import/export of translation memories +- **[Translation Engine API](../../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put)**: Manage translation engine configurations +- **[Termbase API](../termbase/Termbase.md)**: Manage terminology resources + +## Examples and Use Cases + +### Building a Translation Workflow + +1. **Setup**: Configure translation engine with TMs, MT, and termbases +2. **Lookup**: Use `/translations/lookup` for translation suggestions +3. **Research**: Use `/translations/concordance` for plain text research +4. **Quality**: Add/update translation units with the updated BCM fragments retrieved from the previous requests to improve TM quality +5. **Maintenance**: Regular TM updates and quality checks \ No newline at end of file diff --git a/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md index 85b9734..8366b4f 100644 --- a/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md +++ b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md @@ -7,7 +7,8 @@ The request body follows the [Webhook Batch](../../reference/Webhooks.v1.json/co * Create the webhook endpoint to handle batched webhooks. The endpoint must be capable of processing multiple events in a single request. * The same [webhook authenticity](Webhooks-setup.md#webhook-authenticity) rules apply to both batched and single webhooks. -* The same **success/failure** rules for webhook notifications apply, as described in [notification responses](Webhooks-setup.md#return-notification-responses). +* The same **success/failure** rules for webhook notifications apply, as described in [notification responses](Webhooks-setup.md#return-notification-responses). + * **Note:** A notification delivery is considered successful if the application responds with a 2xx status code within 20 seconds (compared to 3 seconds for individual webhooks). * The **retry policies** and **circuit breaker** mechanisms for webhook notifications are the same as those described in [notification responses](Webhooks-setup.md#return-notification-responses). * The same **headers** are included in batched webhooks as in single webhooks, as outlined in the [reference](Webhooks-setup.md#reference). diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md index 9111019..50f009b 100644 --- a/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md +++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md @@ -57,7 +57,8 @@ This is the envelope that is common to all events, and only the < Data Payload O | `PROJECT.TASK.UPDATED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | | `PROJECT.TASK.DELETED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Delete project and its tasks | Delete project and its tasks | | `PROJECT.CREATED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Create project | Create project | -| `PROJECT.UPDATED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Start project
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | +| `PROJECT.STARTED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Start project | Start project | +| `PROJECT.UPDATED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | | `PROJECT.DELETED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Delete project | Delete project | | `PROJECT.TEMPLATE.CREATED` | [`project-template-event`](../reference/Webhooks.v1.json/components/schemas/project-template-event) | | Create project template | | `PROJECT.TEMPLATE.UPDATED` | [`project-template-event`](../../reference/Webhooks.v1.json/components/schemas/project-template-event) | | Create project template
Update project template | From 263d3712459064ec8898901d9bb47b5bc2b892b4 Mon Sep 17 00:00:00 2001 From: Radu Pascal Date: Tue, 7 Oct 2025 11:46:38 +0300 Subject: [PATCH 06/19] Update API documentation links and add scripts for link conversion - Updated links in Termbase templates, Termbase, Translation Memory import/export, Translations, and Webhooks documentation to point to the new API structure. - Added a new PowerShell script (convert-reference-links.ps1) to automate the conversion of ../reference links in markdown files to the new ../api structure. - Added a second PowerShell script (convert-contract-links.ps1) to rename markdown links in contract files and adjust their URLs to the new format. - Updated the table of contents to include the Translations section. - Created a Requirements.md file detailing the new scripts and their functionalities. --- articles/LCPublicAPI/docs/API-rate-limits.md | 26 +-- .../docs/Basic-project-creation-flow.md | 50 +++--- articles/LCPublicAPI/docs/Create-projects.md | 44 ++--- articles/LCPublicAPI/docs/Custom-Fields.md | 14 +- .../LCPublicAPI/docs/Export-quote-report.md | 12 +- articles/LCPublicAPI/docs/File-formats.md | 19 +-- .../docs/Headers-considerations.md | 6 +- articles/LCPublicAPI/docs/How-to-multipart.md | 9 +- .../docs/How-to-use-location-and-folders.md | 5 +- .../LCPublicAPI/docs/Interact-with-tasks.md | 15 +- articles/LCPublicAPI/docs/Known-Issues.md | 5 +- articles/LCPublicAPI/docs/Multi-region.md | 4 +- articles/LCPublicAPI/docs/Track-projects.md | 5 +- .../LCPublicAPI/docs/Update-project-quote.md | 6 +- .../docs/Use-fields-in-your-requests.md | 13 +- .../docs/Use-paging-and-sorting-for-lists.md | 9 +- articles/LCPublicAPI/docs/Whats-New.md | 153 +++++++++--------- articles/LCPublicAPI/docs/Whats-deprecated.md | 11 +- .../docs/termbase/Termbase-entries.md | 15 +- .../docs/termbase/Termbase-import-export.md | 16 +- .../docs/termbase/Termbase-templates.md | 14 +- .../LCPublicAPI/docs/termbase/Termbase.md | 14 +- .../Translation-memory-import-export.md | 15 +- .../docs/translations/Translations.md | 16 +- .../docs/webhooks/Batched-webhooks.md | 5 +- .../docs/webhooks/Webhooks-payload.md | 49 +++--- .../docs/webhooks/Webhooks-setup.md | 15 +- articles/LCPublicAPI/toc.yml | 5 + 28 files changed, 295 insertions(+), 275 deletions(-) diff --git a/articles/LCPublicAPI/docs/API-rate-limits.md b/articles/LCPublicAPI/docs/API-rate-limits.md index 6581f67..c38cace 100644 --- a/articles/LCPublicAPI/docs/API-rate-limits.md +++ b/articles/LCPublicAPI/docs/API-rate-limits.md @@ -1,4 +1,4 @@ -# API rate limits +# API rate limits Trados Cloud Platform API enforces rate limits to prevent overuse and spikes of requests that could degrade the platform performance. @@ -17,7 +17,7 @@ Each tenant is entitled to: 3. Up to 200 000 API requests per day. #### Projects Rate Limits -For [Create Project Operation](../reference/Public-API.v1.json/paths/~1projects/post): +For [Create Project Operation](../api/Public-API.v1-fv.html#/operations/CreateProject): each tenant is entitled to: 1. Up to 2 API requests per second. @@ -25,7 +25,7 @@ each tenant is entitled to: 3. Up to 500 API requests per day. #### Export Quote Rate Limits -For [Export Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post): +For [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport): each tenant is entitled to: 1. Up to 2 API requests per second. @@ -40,13 +40,13 @@ each tenant is entitled to: #### Project Files Rate Limits For each of the API operations listed below: -- [Add Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) -- [Download Source File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1{sourceFileId}~1versions~1{fileVersionId}~1download/get) -- [Download Exported Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}~1download/get) -- [Download Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get) -- [Add Source File Version](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}~1versions/post) -- [Add Target File Version](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1target-files~1{targetFileId}~1versions/post) -- [Import Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post) +- [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) +- [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion) +- [Download Exported Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadExportedTargetFileVersion) +- [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) +- [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) +- [Add Target File Version](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) +- [Import Target File Version](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) each tenant is entitled to: 1. Up to 5 API requests per second. @@ -58,7 +58,7 @@ each tenant is entitled to: #### Rate Limit verification endpoint Individual rate limits can be consulted below: -- [List Rate Limits](../reference/Public-API.v1.json/paths/~1rate-limits/get) +- [List Rate Limits](../api/Public-API.v1-fv.html#/operations/ListRateLimits) ## Rejection response @@ -77,7 +77,7 @@ Response headers can provide more details: - `X-RateLimit-Limit`: the limit that was exceeded. For example, the value "2" represents the available quota. It does not provide the type of limit that has been exceeded, for those details the `X-RateLimit-Reset` and `X-RateLimit-Policy` should be used (for deciding when to retry the call). - `X-RateLimit-Reset`: the exact moment in time when the Client can resume activity. This is datetime in RFC-1123 format, for example: "Tue, 3 Jun 2008 11:05:30 GMT". - `X-RateLimit-Remaining`: the value is always "0". This is reserved for future enhancements. -- `X-RateLimit-Policy`: the name of the Rate Limit policy that was violated, made up by the operation and the time interval. Please see also the [List Rate Limits](../reference/Public-API.v1.json/paths/~1rate-limits/get). +- `X-RateLimit-Policy`: the name of the Rate Limit policy that was violated, made up by the operation and the time interval. Please see also the [List Rate Limits](../api/Public-API.v1-fv.html#/operations/ListRateLimits). ## Implementation recommendations @@ -86,4 +86,4 @@ Unless it's a time-critical scenario, don't make requests in parallel. It is bet It's important to handle responses with the HTTP Status 429. There are multiple approaches to handle it and a simple strategy would be: 1. Expect the HTTP code (429) 2. Block all the requests, and wait until `X-RateLimit-Reset` -3. Try again. \ No newline at end of file +3. Try again. diff --git a/articles/LCPublicAPI/docs/Basic-project-creation-flow.md b/articles/LCPublicAPI/docs/Basic-project-creation-flow.md index 518949c..a75aa1b 100644 --- a/articles/LCPublicAPI/docs/Basic-project-creation-flow.md +++ b/articles/LCPublicAPI/docs/Basic-project-creation-flow.md @@ -1,4 +1,4 @@ -# Basic project creation flow +# Basic project creation flow Please read carefully about [authentication and prerequisites](../docs/Authentication.md) , and take into consideration that some steps might be done by Trados engineering. @@ -8,7 +8,7 @@ Additional information regarding file and project size limits can be found [here > This small [Postman collection](https://raw.githubusercontent.com/RWS/language-cloud-public-api-postman/develop/basicProjectCreationFlow.json) can help you get started with the basic project creation flow. For details on Postman setup please see the main [Postman](../docs/Language-Cloud-APIs-for-Postman.md) page. > -> In the [Create Project](../reference/Public-API.v1.json/paths/~1projects/post) endpoint body, the `projectTemplate` value should be replaced with a valid `templateId`. From that point on all the necessary identifiers will be automatically populated throughout Postman. +> In the [Create Project](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint body, the `projectTemplate` value should be replaced with a valid `templateId`. From that point on all the necessary identifiers will be automatically populated throughout Postman. > > Check the [Multi-Region](../docs/Multi-region.md) page for regional API details. @@ -25,7 +25,7 @@ Steps to create a basic translation project: ### 1. Create Project Creates a new project. -Endpoint: [`POST /projects`](../reference/Public-API.v1.json/paths/~1projects/post) +Endpoint: [`POST /projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) For running this endpoint you need to supply the required project details (body tab in Postman): > `POST` https://api.{REGION_CODE}.cloud.trados.com/public-api/v1/projects @@ -50,11 +50,11 @@ For running this endpoint you need to supply the required project details (body } ``` -Source and Target Language Codes can be obtained from [here](../reference/Public-API.v1.json/paths/~1languages/get). +Source and Target Language Codes can be obtained from [here](../api/Public-API.v1-fv.html#/operations/ListLanguages). The API should respond with: - HTTP Status Code: 201 Created. -- Body – your project details consisting of `projectId`, `project name`, `language direction`, `location` and other optional fields. +- Body – your project details consisting of `projectId`, `project name`, `language direction`, `location` and other optional fields. Example: ```json @@ -125,13 +125,13 @@ Detailed information about location and folders can be found on the [How to use ![Create project with location](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/CreateProjectWithLocationPostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects/post). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/CreateProject). ### 2. Add Source File Adds a source file to the project. -Endpoint: [`POST /projects/{projectId}/source-files`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) +Endpoint: [`POST /projects/{projectId}/source-files`](../api/Public-API.v1-fv.html#/operations/AddSourceFile) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response: @@ -150,18 +150,18 @@ Properties field: Responses: - HTTP Code 201 Created. -- Body – a list with the identifier, name and role of the file. +- Body – a list with the identifier, name and role of the file. ![Add source file](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/AddSourceFilePostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/AddSourceFile). ### 3. Start Project Starts a project. -Endpoint: [`PUT /projects/{projectId}/start`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1start/put) +Endpoint: [`PUT /projects/{projectId}/start`](../api/Public-API.v1-fv.html#/operations/StartProject) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response: @@ -173,13 +173,13 @@ Responses: ![Start project](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/StartProjectPostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1start/put). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/StartProject). ### 4. List Project's Tasks List the tasks of a specific project. If all the tasks have the status `completed`, all the files are translated. -Endpoint: [`GET /projects/{projectId}/tasks`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1tasks/get) +Endpoint: [`GET /projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response: @@ -189,7 +189,7 @@ Use `?fields=taskType` if you want to observe the task name. Responses: - HTTP Code 200 Ok. -- Body – a list with task identifier and status. +- Body – a list with task identifier and status. Example: ```json @@ -223,13 +223,13 @@ Example: ![List project's task](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/ListProjectTasks.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1tasks/get). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/ListProjectTasks). ### 5. List Project Target Files Retrieves the target `fileId` for a project and the latest version for the translated file. -Endpoint: [`GET /projects/{projectId}/target-files`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files/get) +Endpoint: [`GET /projects/{projectId}/target-files`](../api/Public-API.v1-fv.html#/operations/ListTargetFiles) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response: @@ -237,7 +237,7 @@ For running this endpoint you need to: Responses: - HTTP Code 200 Ok. -- Body – a list with objects that contain: +- Body – a list with objects that contain: - source file and target file identifiers - source and target languages @@ -268,13 +268,13 @@ Example: ![List project target files](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/ListProjectTargetFilesPostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files/get). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/ListTargetFiles). ### 6. Download File Downloads the translated file. -Endpoint: [`GET /projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get) +Endpoint: [`GET /projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response @@ -285,19 +285,19 @@ For running this endpoint you need to: Responses: - HTTP Code 200 OK. -- Body – the translated file. The file can be also saved from Save Response option. +- Body – the translated file. The file can be also saved from Save Response option. ![Download file](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/DownloadFilePostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion). ### 7. Complete Project Marks a project as `completed`. -Endpoint: [`PUT /projects/{projectId}/complete`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1complete/put) +Endpoint: [`PUT /projects/{projectId}/complete`](../api/Public-API.v1-fv.html#/operations/CompleteProject) For running this endpoint you need to: - Replace `{projectId}` from the URL with the identifier received from the Create Project endpoint response @@ -309,20 +309,20 @@ Responses: ![Complete project](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/CompleteProjectPostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1complete/put). +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/CompleteProject). ### 8. List Projects Retrieves a list of all the projects in the account. -Endpoint: [`GET /projects`](../reference/Public-API.v1.json/paths/~1projects/get) +Endpoint: [`GET /projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) For running this endpoint make a request to: > `GET` https://api.{REGION_CODE}.cloud.trados.com/public-api/v1/projects Responses: - HTTP Code 200 OK. -- Body – a list of projects with details consisting of project identifier, project name, language direction, location and other optional fields +- Body – a list of projects with details consisting of project identifier, project name, language direction, location and other optional fields Example: ```json @@ -378,4 +378,4 @@ Example: ![List projects](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/ListProjectsPostman.gif?raw=true) -More details about this endpoint can be found [here](../reference/Public-API.v1.json/paths/~1projects/get). \ No newline at end of file +More details about this endpoint can be found [here](../api/Public-API.v1-fv.html#/operations/ListProjects). diff --git a/articles/LCPublicAPI/docs/Create-projects.md b/articles/LCPublicAPI/docs/Create-projects.md index 4d01691..2ef44cd 100644 --- a/articles/LCPublicAPI/docs/Create-projects.md +++ b/articles/LCPublicAPI/docs/Create-projects.md @@ -1,4 +1,4 @@ -# Create projects +# Create projects To create a project, you need to specify the following resources: - A translation engine: determines which translation memories, MT engines and termbases should be used in the project - A file processing configuration: determines which translatable file types this project should support, and the specific configuration of those file types @@ -17,24 +17,24 @@ You cannot specify custom fields and project settings directly via the Trados Cl ### 1. Decide which project resources you want to use. Make a `GET` request to the following resource endpoints and identify the identifiers of the resources you want to include in your project: -- [`/translation-engine`](../reference/Public-API.v1.json/paths/~1translation-engines/get) *required* -- [`/file-processing-configuration`](../reference/Public-API.v1.json/paths/~1file-processing-configurations/get) *required* -- [`/workflow`](../reference/Public-API.v1.json/paths/~1workflows/get) *required* -- [`/pricing-model`](../reference/Public-API.v1.json/paths/~1pricing-models/get) *optional* -- [`/custom-field-definitions`](../reference/Public-API.v1.json/paths/~1custom-field-definitions/get) *optional* +- [`/translation-engine`](../api/Public-API.v1-fv.html#/operations/ListTranslationEngines) *required* +- [`/file-processing-configuration`](../api/Public-API.v1-fv.html#/operations/ListFileProcessingConfigurations) *required* +- [`/workflow`](../api/Public-API.v1-fv.html#/operations/ListWorkflows) *required* +- [`/pricing-model`](../api/Public-API.v1-fv.html#/operations/ListPricingModels) *optional* +- [`/custom-field-definitions`](../api/Public-API.v1-fv.html#/operations/ListCustomFields) *optional* -### 2. Decide which language pairs (source – target) you want to use. +### 2. Decide which language pairs (source – target) you want to use. -Make a `GET` request to the [`/languages`](../reference/Public-API.v1.json/paths/~1languages/get) endpoint and identify the `languageCode` parameter values. +Make a `GET` request to the [`/languages`](../api/Public-API.v1-fv.html#/operations/ListLanguages) endpoint and identify the `languageCode` parameter values. ### 3. Decide where you want to save your project. -When you create your project, you must save it in a location (or customer folder). You will need the `locationId` of that customer folder. To retrieve the `locationId` of a given customer folder, make a `GET` request to the [`/customers/{customerId}`](../reference/Public-API.v1.json/paths/~1customers~1{customerId}/get) endpoint and check the `locationId` value in the response. If you do not specify a location, the project will be created in the Root folder. +When you create your project, you must save it in a location (or customer folder). You will need the `locationId` of that customer folder. To retrieve the `locationId` of a given customer folder, make a `GET` request to the [`/customers/{customerId}`](../api/Public-API.v1-fv.html#/operations/GetCustomer) endpoint and check the `locationId` value in the response. If you do not specify a location, the project will be created in the Root folder. ### 4. Create your project. -Make a `POST` request to the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/post) endpoint. You must provide identifiers for all the **required** resources: translation engine, file processing configuration and workflow. +Make a `POST` request to the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint. You must provide identifiers for all the **required** resources: translation engine, file processing configuration and workflow. Each resource object has a `strategy` parameter you must specify in the request body. The strategy parameter has 2 available values: `copy` and `use`. Trados recommends that you choose the `copy` value, which means that you include a copy (clone) of your resource in the project. If you choose the `use` value, then the actual resource is included in your project. @@ -44,14 +44,14 @@ Make sure that you remember the value of the project `id` parameter in the respo ### 5. Add your project files. -Make a `POST` request to the [`/projects/{projectId}/source-files`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) endpoint. You can add both translatable files and reference files (by specifying the `role` property), and various file formats (by specifying the `type` property – native/bcm/sdxliff). You must provide the language of your source file, and, optionally, the values of the `targetLanguages` and `path` elements. +Make a `POST` request to the [`/projects/{projectId}/source-files`](../api/Public-API.v1-fv.html#/operations/AddSourceFile) endpoint. You can add both translatable files and reference files (by specifying the `role` property), and various file formats (by specifying the `type` property – native/bcm/sdxliff). You must provide the language of your source file, and, optionally, the values of the `targetLanguages` and `path` elements. ### 5.1 Perfect Match (optional) -At this point you can make use of the [PerfectMatch](../reference/Public-API.v1.json/paths/~1perfect-match-mappings/post) feature. You can read more about it [here](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information). +At this point you can make use of the [PerfectMatch](../api/Public-API.v1-fv.html#/operations/CreatePerfectMatchMapping) feature. You can read more about it [here](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information). ### 6. Start your project. -Make a `PUT` request to the [`/projects/{projectId}/start`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1start/put) endpoint. +Make a `PUT` request to the [`/projects/{projectId}/start`](../api/Public-API.v1-fv.html#/operations/StartProject) endpoint. ## Create projects based on a template @@ -59,32 +59,32 @@ You can create projects based on a project template already configured from the ### 1. Decide which project template you want to use. -Make a `GET` request to the [`/project-templates`](../reference/Public-API.v1.json/paths/~1project-templates/get) endpoint. Remember the project template `id` parameter in the response. +Make a `GET` request to the [`/project-templates`](../api/Public-API.v1-fv.html#/operations/ListProjectTemplates) endpoint. Remember the project template `id` parameter in the response. -### 2. Decide which language pairs (source – target) you want to use. +### 2. Decide which language pairs (source – target) you want to use. -A project template may include more languages than you need. If this is the case, you can keep only the languages of interest. Make a `GET` request to the [`/languages`](../reference/Public-API.v1.json/paths/~1languages/get) endpoint and identify the `languageCode` parameter values. +A project template may include more languages than you need. If this is the case, you can keep only the languages of interest. Make a `GET` request to the [`/languages`](../api/Public-API.v1-fv.html#/operations/ListLanguages) endpoint and identify the `languageCode` parameter values. ### 3. Decide where you want to save your project. -A project template is saved in a location or a customer folder. Most of the times, when you create your project, you want to save it in the same location (customer folder) as the project template it is based on. You will need the `locationId` of that customer folder. To retrieve the `locationId` of a given customer folder, make a `GET` request to the [`/customers/{customerId}`](../reference/Public-API.v1.json/paths/~1customers~1{customerId}/get) endpoint and check the `locationId` value in the response. +A project template is saved in a location or a customer folder. Most of the times, when you create your project, you want to save it in the same location (customer folder) as the project template it is based on. You will need the `locationId` of that customer folder. To retrieve the `locationId` of a given customer folder, make a `GET` request to the [`/customers/{customerId}`](../api/Public-API.v1-fv.html#/operations/GetCustomer) endpoint and check the `locationId` value in the response. ### 4. Create your project. -Make a `POST` request to the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/post) endpoint. Provide the project template `id` and the location `id`. +Make a `POST` request to the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint. Provide the project template `id` and the location `id`. Make sure that you remember the value of the project `id` parameter in the response. You will need it for tracking your project, interacting with tasks, and completing projects. ### 5. Add your project files -Make a `POST` request to the [`/projects/{projectId}/source-files`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) endpoint. You can add both translatable files and reference files (by specifying the `role` property), and various file formats (by specifying the `type` property – native/bcm/sdxliff). You must provide the language of your source file, and, optionally, the values of the `targetLanguages` and `path` elements. +Make a `POST` request to the [`/projects/{projectId}/source-files`](../api/Public-API.v1-fv.html#/operations/AddSourceFile) endpoint. You can add both translatable files and reference files (by specifying the `role` property), and various file formats (by specifying the `type` property – native/bcm/sdxliff). You must provide the language of your source file, and, optionally, the values of the `targetLanguages` and `path` elements. ### 5.1 Perfect Match (optional) -At this point you can make use of the [PerfectMatch](../reference/Public-API.v1.json/paths/~1perfect-match-mappings/post) feature. You can read more about it [here](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information). +At this point you can make use of the [PerfectMatch](../api/Public-API.v1-fv.html#/operations/CreatePerfectMatchMapping) feature. You can read more about it [here](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information). ### 6. Start your project. -Make a `PUT` request to the [`/projects/{projectId}/start`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1start/put) endpoint. +Make a `PUT` request to the [`/projects/{projectId}/start`](../api/Public-API.v1-fv.html#/operations/StartProject) endpoint. ## Restrict file downloads for a project To restrict file downloads for certain roles, you may create a project as usual and choose to: @@ -100,4 +100,4 @@ Create the project as usual, but specify an additional boolean field named `forc ..., "forceOnline": true } -``` \ No newline at end of file +``` diff --git a/articles/LCPublicAPI/docs/Custom-Fields.md b/articles/LCPublicAPI/docs/Custom-Fields.md index c111841..354eade 100644 --- a/articles/LCPublicAPI/docs/Custom-Fields.md +++ b/articles/LCPublicAPI/docs/Custom-Fields.md @@ -1,14 +1,14 @@ -# Custom fields +# Custom fields Custom Fields allow associating custom data with a project. Custom Fields can be defined in the UI, and then listed and accessed using the List and Get endpoints. The Custom Field values are retrieved through the Project endpoints. ## Custom Field Definitions -To list the available Custom Field Definitions make a `GET` request to the [`/custom-field-definitions`](../reference/Public-API.v1.json/paths/~1custom-field-definitions/get) endpoint. The response contains: the Custom Fields total count, and by default, the `id` and the `name` for each Custom Field. By specifying the `fields` query parameter, the other properties of these entities can be retrieved. +To list the available Custom Field Definitions make a `GET` request to the [`/custom-field-definitions`](../api/Public-API.v1-fv.html#/operations/ListCustomFields) endpoint. The response contains: the Custom Fields total count, and by default, the `id` and the `name` for each Custom Field. By specifying the `fields` query parameter, the other properties of these entities can be retrieved. ![List custom fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/ListCustomFieldsPostman.gif?raw=true) -To get a particular Custom Field Definition make a `GET` request to the [`/custom-field-definitions/{customFieldDefinitionId}`](../reference/Public-API.v1.json/paths/~1custom-field-definitions~1{customFieldDefinitionId}/get) endpoint, and specify the `customFieldDefinitionId` path parameter. +To get a particular Custom Field Definition make a `GET` request to the [`/custom-field-definitions/{customFieldDefinitionId}`](../api/Public-API.v1-fv.html#/operations/GetCustomField) endpoint, and specify the `customFieldDefinitionId` path parameter. The default fields for custom field are `id` and `name`, but the other fields can be seen by specifying them into `fields` query param. For example: `id,key,description,type,defaultValue` ![Get custom field](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetCustomFieldPostman.gif?raw=true) @@ -153,13 +153,13 @@ This will have an HTTP code 400 Bad Request **Updating projects with Custom Fields** -To update the Custom Fields of a project make a `PUT` request to the [`/projects/{projectId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) endpoint. Specify new values for the Custom Fields that need updating. +To update the Custom Fields of a project make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint. Specify new values for the Custom Fields that need updating. ![Update project with custom fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/UpdateProjectWithCustomFieldsPostman.gif?raw=true) **Getting Custom Fields for projects** -To get the Custom Fields for a project, make a `GET` request to the [`/projects/{projectId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint and request the desired fields in the `fields` query parameters: `customFields.id,customFields.key,customFields.value`. Similarly, this can be done when making a `GET` request to the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/get) endpoint. +To get the Custom Fields for a project, make a `GET` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint and request the desired fields in the `fields` query parameters: `customFields.id,customFields.key,customFields.value`. Similarly, this can be done when making a `GET` request to the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. ![Get project with custom fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetProjectWithCustomFieldsPostman.gif?raw=true) @@ -167,6 +167,6 @@ To get the Custom Fields for a project, make a `GET` request to the [`/projects/ Custom Fields can be defined in Project Templates. `isMandatory` on a Custom Field indicates that it must be populated when a project is created with that template. -To get the Custom Fields for a project template, make a `GET` request to the [`/project-templates/{projectTemplateId}`](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/get) endpoint or a `GET` request to the [`/project-templates`](../reference/Public-API.v1.json/paths/~1project-templates/get) endpoint and specify the desired fields in the `fields` query parameters: `customFields.id,customFields.key,customFields.value`. +To get the Custom Fields for a project template, make a `GET` request to the [`/project-templates/{projectTemplateId}`](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint or a `GET` request to the [`/project-templates`](../api/Public-API.v1-fv.html#/operations/ListProjectTemplates) endpoint and specify the desired fields in the `fields` query parameters: `customFields.id,customFields.key,customFields.value`. -![Get project template with custom fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetProjectTemplateWithCustomFieldsPostman.gif?raw=true) \ No newline at end of file +![Get project template with custom fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetProjectTemplateWithCustomFieldsPostman.gif?raw=true) diff --git a/articles/LCPublicAPI/docs/Export-quote-report.md b/articles/LCPublicAPI/docs/Export-quote-report.md index b7c1080..00f9c16 100644 --- a/articles/LCPublicAPI/docs/Export-quote-report.md +++ b/articles/LCPublicAPI/docs/Export-quote-report.md @@ -1,15 +1,15 @@ -# Export quote report +# Export quote report The export quote mechanism has been updated and it is now composed of three relevant endpoints. The old export quote endpoint is deprecated, you can read about it in this section [`What's new`](https://languagecloud.sdl.com/lc/api-docs/16d216d6237ee-what-s-new#12-august-2022). The next endpoints would need to be executed in this specific order: -1. To trigger a quote report generation for a given project, make a `POST` request to the [`/projects/{projectId}/quote-report/export`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post) endpoint. If successful, the response will contain an "Accepted" status, and you can proceed to the next step. +1. To trigger a quote report generation for a given project, make a `POST` request to the [`/projects/{projectId}/quote-report/export`](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint. If successful, the response will contain an "Accepted" status, and you can proceed to the next step. -2. To verify the status of the quote report generation, make a `GET` request to the [`/projects/{projectId}/quote-report/export`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get) endpoint. As soon as the response body contains a "completed" status, then you can proceed to the next step. +2. To verify the status of the quote report generation, make a `GET` request to the [`/projects/{projectId}/quote-report/export`](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) endpoint. As soon as the response body contains a "completed" status, then you can proceed to the next step. -3. To download the generated project quote, make a `GET` request to the [`/projects/{projectId}/quote-report/download`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) endpoint. +3. To download the generated project quote, make a `GET` request to the [`/projects/{projectId}/quote-report/download`](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) endpoint. ## Report format @@ -41,7 +41,7 @@ The next screenshot illustrates a sample of an exported PDF quote.
# Update project quote -To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) endpoint, and specify the `quote` field. +To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint, and specify the `quote` field. ## Cost types @@ -465,4 +465,4 @@ When the `costOrder` field is switched, the `total` percentage cost value will b ... } ... -``` \ No newline at end of file +``` diff --git a/articles/LCPublicAPI/docs/File-formats.md b/articles/LCPublicAPI/docs/File-formats.md index 322a69c..a7bc483 100644 --- a/articles/LCPublicAPI/docs/File-formats.md +++ b/articles/LCPublicAPI/docs/File-formats.md @@ -1,4 +1,4 @@ -# File formats +# File formats A file used in the Trados Cloud Platform API can have one of the three supported formats: native, SDLXLIFF or [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html): - Native represents the format of the file that is attached to a project by the user. The project's associated File Type Configuration specifies if the native file extensions can be attached to that project. @@ -24,11 +24,11 @@ Using the Trados Cloud Platform API, the source and target files in different fo ### Handling Source Files #### Upload Source Files -Source files can be added to a project using the [Add Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) endpoint or the [Attach Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoint (for multiple files). If the file's extension is supported by the File Type Configuration, the project will follow the workflow and a new version of the source file in BCM format will be automatically created in the *File Format Conversion* task. +Source files can be added to a project using the [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) endpoint or the [Attach Source Files](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoint (for multiple files). If the file's extension is supported by the File Type Configuration, the project will follow the workflow and a new version of the source file in BCM format will be automatically created in the *File Format Conversion* task. #### Upload Source File Versions -New source file versions can be added in native or BCM format using the [Add Source File Version](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}~1versions/post) endpoint. You can add source file versions: +New source file versions can be added in native or BCM format using the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. You can add source file versions: * in the *Engineering* task * in custom tasks created by users having the task type set to *Engineering* * in extension tasks that handle source files. @@ -39,7 +39,7 @@ If a project having attached a native source file with an unsupported extension #### Download Source File Versions -Any of the source file versions (in native or BCM format) can be downloaded using the [Download Source File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1{sourceFileId}~1versions~1{fileVersionId}~1download/get) endpoint. The *Engineering* task, for instance, is an example of a task where download can be performed. +Any of the source file versions (in native or BCM format) can be downloaded using the [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion) endpoint. The *Engineering* task, for instance, is an example of a task where download can be performed. @@ -47,22 +47,23 @@ Any of the source file versions (in native or BCM format) can be downloaded usin The *Copy source to target* task converts the native file to a new target file version in BCM format. #### Upload Target File Versions -Adding a new version for a target file in native or BCM format can be executed with the [Add Target File Version](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1target-files~1{targetFileId}~1versions/post) endpoint. +Adding a new version for a target file in native or BCM format can be executed with the [Add Target File Version](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) endpoint. >Note: For adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as "file". #### Download Target File Versions -The BCM and native target file versions can be downloaded by using [Download Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get) endpoint, while the project is, for example, in the *Translation* task. +The BCM and native target file versions can be downloaded by using [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, while the project is, for example, in the *Translation* task. #### Export Target File Versions -The BCM target file versions can be exported in native or SDLXLIFF format by calling the [Export Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports/post) endpoint. This operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format based on the value of the `format` query parameter used. The endpoint starts an export operation which can be monitored using the [polling endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}/get). After the export is done, the files can be downloaded using the [Download Exported Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}~1download/get) endpoint. +The BCM target file versions can be exported in native or SDLXLIFF format by calling the [Export Target File Version](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint. This operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format based on the value of the `format` query parameter used. The endpoint starts an export operation which can be monitored using the [polling endpoint](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionExport). After the export is done, the files can be downloaded using the [Download Exported Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadExportedTargetFileVersion) endpoint. > Note: The export endpoint is dedicated to file versions of BCM format and cannot be used on files in native or SDLXLIFF format. The export operation can only be executed on tasks where the supported output file is a bilingual target file. You can consult the output file types for tasks on the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center. > ->In order to download file versions of BCM or native type, please use the [Download Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get) endpoint. +>In order to download file versions of BCM or native type, please use the [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint. #### Import Target File Versions -Target file versions downloaded in SDLXLIFF format can be processed and afterwards replaced by using [Import Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post) endpoint. The import operation triggers internally the update of the BCM file associated with the imported SDLXLIFF file. This endpoint should mostly be used for offline work. +Target file versions downloaded in SDLXLIFF format can be processed and afterwards replaced by using [Import Target File Version](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint. The import operation triggers internally the update of the BCM file associated with the imported SDLXLIFF file. This endpoint should mostly be used for offline work. + diff --git a/articles/LCPublicAPI/docs/Headers-considerations.md b/articles/LCPublicAPI/docs/Headers-considerations.md index 3483eac..ecaf4ff 100644 --- a/articles/LCPublicAPI/docs/Headers-considerations.md +++ b/articles/LCPublicAPI/docs/Headers-considerations.md @@ -1,4 +1,4 @@ -# Headers considerations +# Headers considerations The purpose of this page is to showcase the header types that could capture your interest. @@ -23,7 +23,7 @@ in a file, read more in the [RFC2046](https://www.rfc-editor.org/rfc/rfc2046#sec For operations expected to return content that can be handled as a file, the `Content-Disposition` header can be sent in the response headers to provide more information about the response payload. The Trados Cloud Platform API will provide this header in certain situations, and its primary goal is to supply a file name for the content being downloaded or exported. You can read more about the `Content-Disposition` header on the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition) website or in the [RFC6266](https://www.rfc-editor.org/rfc/rfc6266) space. -The `Content-Disposition` response header can be usually found on various download API endpoints like [Download Source File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1{sourceFileId}~1versions~1{fileVersionId}~1download/get), [Download Target File Version](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get), [Download Exported Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) and others. +The `Content-Disposition` response header can be usually found on various download API endpoints like [Download Source File Version](../api/Public-API.v1-fv.html#/operations/DownloadSourceFileVersion), [Download Target File Version](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion), [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) and others. > Please note that both `Content-Type` and `Content-Disposition` are **not required** and APIs might not include them in the response. There are no guarantees that an endpoint that used to return a `Content-Type` or `Content-Disposition` header will still do so, under any circumstance. Please treat these headers as **optional** for all APIs. @@ -49,4 +49,4 @@ If the `Content-Disposition` header is missing or you simply want to have a diff ## Deprecation and sunset headers -These types of headers are used in our endpoint retirement process and are covered broadly in the [Public API Management Process](../docs/Public-API-Management-Process.md#endpoint-retirement-process) page. \ No newline at end of file +These types of headers are used in our endpoint retirement process and are covered broadly in the [Public API Management Process](../docs/Public-API-Management-Process.md#endpoint-retirement-process) page. diff --git a/articles/LCPublicAPI/docs/How-to-multipart.md b/articles/LCPublicAPI/docs/How-to-multipart.md index 7065e86..34ce72d 100644 --- a/articles/LCPublicAPI/docs/How-to-multipart.md +++ b/articles/LCPublicAPI/docs/How-to-multipart.md @@ -1,4 +1,4 @@ ---- +--- stoplight-id: 1hfz3c15wpkbf --- @@ -12,7 +12,7 @@ This page goes into deeper details for uploading files. Generally you might be i Whenever you make use of endpoints that do file uploads using `multipart/form-data`, some additional details may be required to be sent alongside the file, for example a `properties` part. -Let's take as an example the [Add Source File Version](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}~1versions/post) endpoint. The API specifies that the request content is `multipart/form-data` and has a `properties` part that should be serialized as a JSON (this might not be mentioned explicitly in the documentation, but any structures in multiparts should be serialized as JSON). The second property is `file` and though it is of type `string`, that means that the raw content of the file should be sent in that part. +Let's take as an example the [Add Source File Version](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) endpoint. The API specifies that the request content is `multipart/form-data` and has a `properties` part that should be serialized as a JSON (this might not be mentioned explicitly in the documentation, but any structures in multiparts should be serialized as JSON). The second property is `file` and though it is of type `string`, that means that the raw content of the file should be sent in that part. > The order of parts is important! Please send the parts in the order these are specified in the API contract. @@ -30,8 +30,8 @@ Content-Disposition: form-data; name="properties" Content-Type: application/json { -  "type":"native", -  "fileTypeSettingsId": "" +  "type":"native", +  "fileTypeSettingsId": "" } ----------------------------818668410602542750275539 Content-Disposition: form-data; name="file"; filename="" @@ -45,3 +45,4 @@ Content-Type: For the file, there is usually the filename that needs to be sent, along with file `Content-type` and finally the content. + diff --git a/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md b/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md index c6152bc..60be9c8 100644 --- a/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md +++ b/articles/LCPublicAPI/docs/How-to-use-location-and-folders.md @@ -1,4 +1,4 @@ -# How to use location and folders +# How to use location and folders The Trados Cloud Platform API supports [folder-based](https://docs.rws.com/791595/984983/trados-enterprise/how-do-folder-structure-and-inheritance-help-you-get-organized-) access management to all resources. The users have access to resources based on the permissions associated with the group (role) they belong to. For information about creating a user you can check the [Service credentials](../docs/Service-credentials.md) page. @@ -18,7 +18,7 @@ The folders structure in Trados Cloud Platform API is hierarchical. For more inf Depending on how the account was provisioned, configured and on the groups which the user belongs to, the rights for a user can be more restrictive or permissive. -Users can learn where they were created, the exact folder, and what groups they belong to, by executing a [Get My User](../reference/Public-API.v1.json/paths/~1users~1me/get) call with the `fields` query parameters set to *"location.name,location.path,groups"*. +Users can learn where they were created, the exact folder, and what groups they belong to, by executing a [Get My User](../api/Public-API.v1-fv.html#/operations/GetMyUser) call with the `fields` query parameters set to *"location.name,location.path,groups"*. For example, let's assume that an account has the following hierarchy of folders (with associated unique identifiers simplified for readability): @@ -161,3 +161,4 @@ If the list project endpoint is used with: Project2, Project3 (only once) and Project4 are returned. + diff --git a/articles/LCPublicAPI/docs/Interact-with-tasks.md b/articles/LCPublicAPI/docs/Interact-with-tasks.md index 315b439..9d72927 100644 --- a/articles/LCPublicAPI/docs/Interact-with-tasks.md +++ b/articles/LCPublicAPI/docs/Interact-with-tasks.md @@ -1,30 +1,31 @@ -# Interact with tasks +# Interact with tasks Once the project is started, you can interact with tasks in several ways: ### Find the task identifier -Make a `GET` request to the [`/tasks/assigned`](../reference/Public-API.v1.json/paths/~1tasks~1assigned/get) endpoint and identify the `id` of the task you want to interact with. +Make a `GET` request to the [`/tasks/assigned`](../api/Public-API.v1-fv.html#/operations/ListTasksAssignedToMe) endpoint and identify the `id` of the task you want to interact with. ### Reclaim tasks -If you make a `PUT` request to the [`/tasks/{taskId}/reclaim`](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1reclaim/put) endpoint, the owner of task is removed and another user from the assignee's list can accept it. The task is not reassigned automatically. +If you make a `PUT` request to the [`/tasks/{taskId}/reclaim`](../api/Public-API.v1-fv.html#/operations/ReclaimTask) endpoint, the owner of task is removed and another user from the assignee's list can accept it. The task is not reassigned automatically. ### Complete tasks -To complete a task, make a `PUT` request to the [`/tasks/{taskId}/complete`](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1complete/put) endpoint. +To complete a task, make a `PUT` request to the [`/tasks/{taskId}/complete`](../api/Public-API.v1-fv.html#/operations/CompleteTask) endpoint. ### Assign tasks -If the tasks is rejected by all its assignees, you can update the list of assignees. Make a `GET` request to the [`/users`](../reference/Public-API.v1.json/paths/~1users/get) or [`/groups`](../reference/Public-API.v1.json/paths/~1groups/get) endpoints and remember their identifiers. Then, make a `PUT` request to the [`/tasks/{taskId}/assign`](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1assign/put) endpoint and provide the identifiers. +If the tasks is rejected by all its assignees, you can update the list of assignees. Make a `GET` request to the [`/users`](../api/Public-API.v1-fv.html#/operations/ListUsers) or [`/groups`](../api/Public-API.v1-fv.html#/operations/ListGroups) endpoints and remember their identifiers. Then, make a `PUT` request to the [`/tasks/{taskId}/assign`](../api/Public-API.v1-fv.html#/operations/AssignTask) endpoint and provide the identifiers. ### List all the tasks in a project -Make a `GET` call to the [`/projects/{projectId}/tasks`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1tasks/get) endpoint to list all the tasks in a project by projectId. The response returns a total count of the tasks, and several details for each task: `taskId`, the input and outcome per task, the owner and assignees, the creation and due dates. +Make a `GET` call to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint to list all the tasks in a project by projectId. The response returns a total count of the tasks, and several details for each task: `taskId`, the input and outcome per task, the owner and assignees, the creation and due dates. ### Upload/Import a target file version -Make a `POST` call to the [`/projects/{projectId/target-files/{targetFileId}/versions/imports`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post) endpoint to upload (import) a new file version that can be used as part of a task. The response returns the `importId` which you can further use to check the import result by making a `GET` call to the [`/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports~1{importId}/get) endpoint. The `projectId` can be retrieved by making a `POST` call to the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/post) endpoint, while the `targetFileId` can be retrieved by making a `GET` call to the [`/projects/{projectId}/target-files`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files/get) endpoint. +Make a `POST` call to the [`/projects/{projectId/target-files/{targetFileId}/versions/imports`](../api/Public-API.v1-fv.html#/operations/ImportTargetFileVersion) endpoint to upload (import) a new file version that can be used as part of a task. The response returns the `importId` which you can further use to check the import result by making a `GET` call to the [`/projects/{projectId}/target-files/{targetFileId}/versions/imports/{importId}`](../api/Public-API.v1-fv.html#/operations/PollTargetFileVersionImport) endpoint. The `projectId` can be retrieved by making a `POST` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint, while the `targetFileId` can be retrieved by making a `GET` call to the [`/projects/{projectId}/target-files`](../api/Public-API.v1-fv.html#/operations/ListTargetFiles) endpoint. + diff --git a/articles/LCPublicAPI/docs/Known-Issues.md b/articles/LCPublicAPI/docs/Known-Issues.md index 4e0aace..2304413 100644 --- a/articles/LCPublicAPI/docs/Known-Issues.md +++ b/articles/LCPublicAPI/docs/Known-Issues.md @@ -1,4 +1,4 @@ -# Known issues +# Known issues This page lists the known bugs and issues for Trados Cloud Platform API. @@ -6,7 +6,8 @@ This page lists the known bugs and issues for Trados Cloud Platform API. ### Download Exported Quote Report -The [Download Exported Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) endpoint is designed to be a one-time operation. After a download attempt, the file is deleted and it's no longer available for download. If the file needs to be downloaded again, the user needs to request a new export of the quote report by using the [Export Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post) and [Poll Quote Report Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get) endpoints. +The [Download Exported Quote Report](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport) endpoint is designed to be a one-time operation. After a download attempt, the file is deleted and it's no longer available for download. If the file needs to be downloaded again, the user needs to request a new export of the quote report by using the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Poll Quote Report Export](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport) endpoints. ### Export Quote report When the export is not using a Quote Template, the response for this call will be empty. + diff --git a/articles/LCPublicAPI/docs/Multi-region.md b/articles/LCPublicAPI/docs/Multi-region.md index 7fb1bef..4977dd5 100644 --- a/articles/LCPublicAPI/docs/Multi-region.md +++ b/articles/LCPublicAPI/docs/Multi-region.md @@ -1,4 +1,4 @@ ---- +--- stoplight-id: nfdrob1smwn00 --- @@ -20,4 +20,4 @@ This information is especially relevant if you are building multi-tenant integra The provided .NET and Java SDKs already support multiple regions. For details on using these SDKs, refer to their documentation. -> If you're building your own client, avoid hard-coding Trados Cloud Platform API hosts, as new regions may be added in the future, requiring updates to hard-coded hosts. You can discover all available regions and their corresponding Public API hosts using the [List Regions](../reference/Global-Public-API.v1.json/paths/~1regions/get) endpoint from the new Global Public API, which is accessible on a new global host `api.cloud.trados.com`. \ No newline at end of file +> If you're building your own client, avoid hard-coding Trados Cloud Platform API hosts, as new regions may be added in the future, requiring updates to hard-coded hosts. You can discover all available regions and their corresponding Public API hosts using the [List Regions](../api/Global-Public-API.v1-fv.html#/operations/ListRegions) endpoint from the new Global Public API, which is accessible on a new global host `api.cloud.trados.com`. diff --git a/articles/LCPublicAPI/docs/Track-projects.md b/articles/LCPublicAPI/docs/Track-projects.md index b12dca8..0d36e1c 100644 --- a/articles/LCPublicAPI/docs/Track-projects.md +++ b/articles/LCPublicAPI/docs/Track-projects.md @@ -1,5 +1,6 @@ -# Track projects +# Track projects -After you create a project, you can track it by making a `GET` request to the [`/projects/{projectId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint to obtain information such as: creation date, due date, status, and resources used. +After you create a project, you can track it by making a `GET` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint to obtain information such as: creation date, due date, status, and resources used. When requesting a list of projects, you can filter out projects that have a file download restriction by sending the `excludeOnline` query parameter. + diff --git a/articles/LCPublicAPI/docs/Update-project-quote.md b/articles/LCPublicAPI/docs/Update-project-quote.md index c64a819..93983e6 100644 --- a/articles/LCPublicAPI/docs/Update-project-quote.md +++ b/articles/LCPublicAPI/docs/Update-project-quote.md @@ -1,5 +1,5 @@ -# Update project quote -To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) end point, and specify the `quote` field. +# Update project quote +To update a quote, make a `PUT` request to the [`/projects/{projectId}`](../api/Public-API.v1-fv.html#/operations/UpdateProject) end point, and specify the `quote` field. ## Cost types @@ -423,4 +423,4 @@ When the `costOrder` field is switched, the `total` percentage cost value will b ... } ... -``` \ No newline at end of file +``` diff --git a/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md index 32c2019..c0951e4 100644 --- a/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md +++ b/articles/LCPublicAPI/docs/Use-fields-in-your-requests.md @@ -1,4 +1,4 @@ -# Use fields in your requests +# Use fields in your requests All the endpoints that return a resource representation allow the `fields` query parameter. Fields are used to specify the property values you want returned for your entities. @@ -6,13 +6,13 @@ When you make a call using the `fields` query parameter, make sure that you: - Separate the fields by commas. - Query by `properties` and/or `subproperties`. Write `subproperties` in the following format: `propertyname.subpropertyname`. - Familiarize yourself with the elements that get returned: - - The fields marked as “**required**” are always returned. + - The fields marked as “**required**” are always returned. - If fields are not customized for a given level and the requested field is non null then the default fields will be returned. - If fields are customized for a given level and the requested field is non null, the fields you requested will be returned. - The rules above are applied at nested level as well. -Let’s look at an example to understand how the `fields` parameter can be used. -We will perform a `GET` request to the [`/projects/projectId`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint and we will consider that in our example the `projectId`= 101. +Let’s look at an example to understand how the `fields` parameter can be used. +We will perform a `GET` request to the [`/projects/projectId`](../api/Public-API.v1-fv.html#/operations/GetProject) endpoint and we will consider that in our example the `projectId`= 101. #### 1. Fields consist of properties and subproperties. Here are some examples: - `Properties`: `id`; `name`; `customer`; `createdBy` and so on @@ -34,7 +34,7 @@ focus: false Request: `GET/projects/101?fields=customer` -Response: the project **identifier**; the customer **identifier**; the customer **name**; the customer’s **key contact**; the customer **location** +Response: the project **identifier**; the customer **identifier**; the customer **name**; the customer’s **key contact**; the customer **location** ![Nested Fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetProjectNestedFields.gif?raw=true) + diff --git a/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md index ea75cd2..4ed1872 100644 --- a/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md +++ b/articles/LCPublicAPI/docs/Use-paging-and-sorting-for-lists.md @@ -1,4 +1,4 @@ -# Use paging and sorting for lists +# Use paging and sorting for lists When the outcome of a `GET` call is a list of items (item properties and total count), you can control the number of results displayed on a page as well as sort the results. @@ -6,15 +6,15 @@ To control the number of results displayed on a page, do the following: - To retrieve the full size of an entity, make a `GET` call to its corresponding endpoint. -For example, make a `GET` call to the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/get) endpoint. The result consists in a list of all the projects (and their details) as well as a project count. The project count field returns the same value even if you further apply the `top` or `skip` query parameters. +For example, make a `GET` call to the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. The result consists in a list of all the projects (and their details) as well as a project count. The project count field returns the same value even if you further apply the `top` or `skip` query parameters. - To display only the first 10, 20, 30 (and so on) results in your list, use the `top` query parameter. -For example, for the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/get) endpoint, your query may look like this if you are interested in the first 10 projects: `/projects?top=10` +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, your query may look like this if you are interested in the first 10 projects: `/projects?top=10` - To get to a particular set of retrieved results in your list, use the `skip` query parameter. -For example, for the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/get) endpoint, if you want to skip the first 100 results, your query will look like this: `/projects?skip=100`. +For example, for the [`/projects`](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint, if you want to skip the first 100 results, your query will look like this: `/projects?skip=100`. - To sort your list by certain properties, use the `sort` query parameter. @@ -23,3 +23,4 @@ The default sorting strategy is ascending. Add unary operators for ascending (+) For example, if you want to sort results by due date (-) and name (+), your query will look like this: `/projects?sort=-dueBy,name`. Note that sorting can be performed only on first-level fields (not nested fields), for naturally comparable types like strings, numbers, and dates. + diff --git a/articles/LCPublicAPI/docs/Whats-New.md b/articles/LCPublicAPI/docs/Whats-New.md index dc00a91..8f7da76 100644 --- a/articles/LCPublicAPI/docs/Whats-New.md +++ b/articles/LCPublicAPI/docs/Whats-New.md @@ -1,10 +1,10 @@ -# What's new +# What's new
## 10 September 2025 -- With this release we deliver [Lookup](../reference/Public-API.v1.json/paths/~1translations~1lookup/post), [Concordance](../reference/Public-API.v1.json/paths/~1translations~1concordance/post), [Add](../reference/Public-API.v1.json/paths/~1translations~1translation-unit/post) and [Update](../reference/Public-API.v1.json/paths/~1translations~1translation-unit/put) translation units to a translation memory. See [this](./translations/Translations.md) page for more details. -- You can now [obtain](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/get) and [update](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) the resources sequence information for a Translation Engine. +- With this release we deliver [Lookup](../api/Public-API.v1-fv.html#/operations/TranslationsLookup), [Concordance](../api/Public-API.v1-fv.html#/operations/TranslationsConcordanceSearch), [Add](../api/Public-API.v1-fv.html#/operations/TranslationsAdd) and [Update](../api/Public-API.v1-fv.html#/operations/TranslationsUpdate) translation units to a translation memory. See [this](./translations/Translations.md) page for more details. +- You can now [obtain](../api/Public-API.v1-fv.html#/operations/GetTranslationEngine) and [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) the resources sequence information for a Translation Engine. - A new project event `PROJECT.STARTED` has been added. See [this](./webhooks/Webhooks-payload.md) page for more details. @@ -14,19 +14,19 @@ ## 12 August 2025 -- You can now get word count and cost estimation analysis of files without the need to create a project. The functionality is accessible via the [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) and [Poll File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis~1{operationId}/get) endpoints. -- As previously announced, the `languageProcessingRuleId` parameter is now mandatory for [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint. +- You can now get word count and cost estimation analysis of files without the need to create a project. The functionality is accessible via the [Request File Analysis](../api/Public-API.v1-fv.html#/operations/RequestFileAnalysis) and [Poll File Analysis](../api/Public-API.v1-fv.html#/operations/PollFileAnalysis) endpoints. +- As previously announced, the `languageProcessingRuleId` parameter is now mandatory for [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint. - We fixed various bugs. ## 15 July 2025 -- You can now add the `systemStatus` property on termbase entries. See [Update Termbase Entry](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries~1{entryId}/put). -- We've improved the documentation around zip files on [Add Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/post) and [Attach Source File](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoints. -- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint will be mandatory. -- [Import Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports/post) and [Poll Termbase Import](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports~1{importId}/get) endpoints will return `pending` instead of `queued` for the status. This change is scheduled to take effect no sooner than six months from now. +- You can now add the `systemStatus` property on termbase entries. See [Update Termbase Entry](../api/Public-API.v1-fv.html#/operations/UpdateTermbaseEntry). +- We've improved the documentation around zip files on [Add Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFile) and [Attach Source File](../api/Public-API.v1-fv.html#/operations/AddSourceFiles) endpoints. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will be mandatory. +- [Import Termbase](../api/Public-API.v1-fv.html#/operations/ImportTermbase) and [Poll Termbase Import](../api/Public-API.v1-fv.html#/operations/PollTermbaseImport) endpoints will return `pending` instead of `queued` for the status. This change is scheduled to take effect no sooner than six months from now. ## 8 May 2025 -- You can now download the target files associated with a project in a ZIP format. This functionality is accessible through three endpoints: [Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports/post), [Poll](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}/get), and [Download](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}~1download/get). -- With this release we deliver the [Create](../reference/Public-API.v1.json/paths/~1pricing-models/post), [Update](../reference/Public-API.v1.json/paths/~1pricing-models~1{pricingModelId}/put) and [Delete](../reference/Public-API.v1.json/paths/~1pricing-models~1{pricingModelId}/delete) pricing model endpoints. Together with these, several changes were required to correct the pricing model response: +- You can now download the target files associated with a project in a ZIP format. This functionality is accessible through three endpoints: [Export](../api/Public-API.v1-fv.html#/operations/ExportProjectFiles), [Poll](../api/Public-API.v1-fv.html#/operations/ExportProjectFilesStatus), and [Download](../api/Public-API.v1-fv.html#/operations/DownloadFile). +- With this release we deliver the [Create](../api/Public-API.v1-fv.html#/operations/CreatePricingModel), [Update](../api/Public-API.v1-fv.html#/operations/UpdatePricingModel) and [Delete](../api/Public-API.v1-fv.html#/operations/DeletePricingModel) pricing model endpoints. Together with these, several changes were required to correct the pricing model response: - `name` : changed from required to default. - `additionalCosts.volumeUnitType` changed from required to non required. - `additionalCosts.conditionalCostType` changed from required to non required. @@ -42,18 +42,18 @@ ## 1 April 2025 - As part of the Connected AI feature, we have added the following updates and new endpoints: - - We have introduced a new endpoint for listing [Large Language Models](../reference/Public-API.v1.json/paths/~1connected-ai~1llm-configurations/get) (LLMs). - - We have added the functionality to [update your translation engines](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) with the new LLM resource type. -- We have added the source word count to the [List Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files/get) endpoint. + - We have introduced a new endpoint for listing [Large Language Models](../api/Public-API.v1-fv.html#/operations/ListLlmConfigurations) (LLMs). + - We have added the functionality to [update your translation engines](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) with the new LLM resource type. +- We have added the source word count to the [List Source Files](../api/Public-API.v1-fv.html#/operations/ListSourceFiles) endpoint. - We fixed various bugs. ## 10 March 2025 - We've introduced the concept of [Batched Webhooks](../docs/webhooks/Batched-webhooks.md). -- We've updated the models for [Import Translation Memory](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/post), [Export Translation Memory](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1exports/post) and [Get Translation Memory Import History](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/get). - - As part of this, the existing `status` field is now marked as deprecated in the response model of [Import Translation Memory](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/post) and [Export Translation Memory](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1exports/post). - - Additionally, the fields `importAsPlainText` and `triggerRecomputeStatistics` are marked as deprecated in the request model of [Import Translation Memory](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/post) and in the response model of [Get Translation Memory Import History](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/get), alongside the `traceId` field. +- We've updated the models for [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory), [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) and [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory). + - As part of this, the existing `status` field is now marked as deprecated in the response model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [Export Translation Memory](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory). + - Additionally, the fields `importAsPlainText` and `triggerRecomputeStatistics` are marked as deprecated in the request model of [Import Translation Memory](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and in the response model of [Get Translation Memory Import History](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory), alongside the `traceId` field. - Their decommissioning is scheduled at a minimum of six months from now. @@ -66,7 +66,7 @@ - As part of our multi-region support, we have added global endpoints to facilitate the discovery of available regions and hosts. For more details, see the [Multi-region](../docs/Multi-region.md) page. - We have updated the documentation on how to use the new SDK with multi-region features. - Additionally, we made various minor contract corrections. -- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint will become mandatory. +- As a reminder, we want to let our users know that the field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. ## 6 November 2024 - We are planning to transition the hosting of our API from **lc-api.sdl.com** to **api.eu.cloud.trados.com** on November 9th: @@ -79,91 +79,91 @@ - You now have the ability to add notes to customer quotes. - - We have updated the deprecated types for the `language` and `targetLanguages` fields in the [Add Source File Request](../reference/Public-API.v1.json/components/schemas/source-file-request) model, which now reference [Language Request](../reference/Public-API.v1.json/components/schemas/language-request) model. In the updated API contract, these fields have been changed from simple strings to structured objects containing a `languageCode` property, enhancing clarity and consistency in language handling. + - We have updated the deprecated types for the `language` and `targetLanguages` fields in the [Add Source File Request](../api/Public-API.v1-fv.html#/schemas/source-file-request) model, which now reference [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. In the updated API contract, these fields have been changed from simple strings to structured objects containing a `languageCode` property, enhancing clarity and consistency in language handling. - > We will provide backwards compatibility until May 2025. However, starting with this release, SDKs will be updated to use the new types. Please ensure your integration is updated to use the new [Language Request](../reference/Public-API.v1.json/components/schemas/language-request) model. + > We will provide backwards compatibility until May 2025. However, starting with this release, SDKs will be updated to use the new types. Please ensure your integration is updated to use the new [Language Request](../api/Public-API.v1-fv.html#/schemas/language-request) model. - We fixed various bugs. ## 11 September 2024 -- With this release we deliver the [PerfectMatch](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information) functionality. You can apply PerfectMatch either at the start of a project or midway through the translation process. These capabilities are accessible via the [PerfectMatch Mapping](../reference/Public-API.v1.json/paths/~1perfect-match-mappings/post) menu. -- We've improved filtering for projects lists. See the [List Projects](../reference/Public-API.v1.json/paths/~1projects/get) endpoint. +- With this release we deliver the [PerfectMatch](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information) functionality. You can apply PerfectMatch either at the start of a project or midway through the translation process. These capabilities are accessible via the [PerfectMatch Mapping](../api/Public-API.v1-fv.html#/operations/CreatePerfectMatchMapping) menu. +- We've improved filtering for projects lists. See the [List Projects](../api/Public-API.v1-fv.html#/operations/ListProjects) endpoint. - A recent update has been made to the [Webhooks Setup](../docs/webhooks/Webhooks-setup.md) page, informing the customers that the order of webhook event deliveries cannot be guaranteed. Please take this into consideration using the `timestamp` field to determine the event generation time. - You can now set due dates for tasks during project creation. - We fixed various bugs. ## 28 August 2024 -- We have introduced a new option which allows users to switch to a different pricing model at the Customer Quote Review task using the dedicated endpoint [Update Project Pricing Model](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1pricing-model/put). -- You now have the ability to view the locking color options for MTQE segments by utilizing the [Get Project Template](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/get) endpoint. -- The parameter `termbaseStructure.fields.type` in the [Get Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}/get) endpoint is no longer marked as mandatory. +- We have introduced a new option which allows users to switch to a different pricing model at the Customer Quote Review task using the dedicated endpoint [Update Project Pricing Model](../api/Public-API.v1-fv.html#/operations/UpdateProjectPricingModel). +- You now have the ability to view the locking color options for MTQE segments by utilizing the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint. +- The parameter `termbaseStructure.fields.type` in the [Get Termbase](../api/Public-API.v1-fv.html#/operations/GetTermbase) endpoint is no longer marked as mandatory. - We fixed various bugs. ## 1 July 2024 -- We updated the folder/resource locations to the new format, which now includes the [path](../reference/Public-API.v1.json/components/schemas/folder). +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder). - We fixed various bugs. ## 9 May 2024 -- You can configure the number of days after which projects are given the Completed or Archived status automatically using the `completionConfiguration` option under the following endpoints: [Create](../reference/Public-API.v1.json/paths/~1projects/post) and [Update](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) Project, [Create](../reference/Public-API.v1.json/paths/~1project-templates/post) and [Update](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/put) Project Template. -- The field `languageProcessingRuleId` under [Update Translation Engine](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) endpoint will become mandatory. The enforcement is scheduled at a minimum of six months from now. -- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../reference/Public-API.v1.json/components/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- You can configure the number of days after which projects are given the Completed or Archived status automatically using the `completionConfiguration` option under the following endpoints: [Create](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProject) Project, [Create](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) and [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) Project Template. +- The field `languageProcessingRuleId` under [Update Translation Engine](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) endpoint will become mandatory. The enforcement is scheduled at a minimum of six months from now. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. - We fixed various bugs. ## 8 April 2024 - We extended the information available on the webhooks setup page, [Circuit Breaker](../docs/webhooks/Webhooks-setup.md#circuit-breaker) section. -- We removed the `languageId` allowed values for the [Export Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post) endpoint. -- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../reference/Public-API.v1.json/components/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- We removed the `languageId` allowed values for the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint. +- As a reminder, we want to let our users know that we updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is planned for near future. Please ensure you update the implementation if you are using fields that are marked as deprecated. - We fixed various bugs. ## 27 February 2024 -- With this release we deliver the [Update](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/put) and [Delete Project Template](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/delete) endpoints. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template update. +- With this release we deliver the [Update](../api/Public-API.v1-fv.html#/operations/UpdateProjectTemplate) and [Delete Project Template](../api/Public-API.v1-fv.html#/operations/DeleteProjectTemplate) endpoints. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template update. - We published a new page about [multipart considerations](../docs/How-to-multipart.md) - We fixed various bugs. ## 13 December 2023 -- With this release we deliver the [Create Project Template](../reference/Public-API.v1.json/paths/~1project-templates/post) endpoint. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template creation. -- We enhanced the response model for the [Get Project Template](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/get) endpoint, which now includes settings for verification and batch tasks. The existing `forceOnline` and `quoteTemplate` fields from root level are now marked as deprecated, as they have been moved to the `settings` section. Their decommissioning is scheduled at a minimum of six months from now. +- With this release we deliver the [Create Project Template](../api/Public-API.v1-fv.html#/operations/CreateProjectTemplate) endpoint. Subsequent iterations with new implementations will follow, ensuring continuous enhancement for project template creation. +- We enhanced the response model for the [Get Project Template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) endpoint, which now includes settings for verification and batch tasks. The existing `forceOnline` and `quoteTemplate` fields from root level are now marked as deprecated, as they have been moved to the `settings` section. Their decommissioning is scheduled at a minimum of six months from now. - Webhooks will stop trying to send on urls that cause timeouts, retrying later. Read more [here](../docs/webhooks/Webhooks-setup.md#circuit-breaker). - We fixed various bugs. ## 16 November 2023 -- We introduced the `applicableOutcomes` field under the [get task](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}/get) endpoint to be used when completing the tasks. +- We introduced the `applicableOutcomes` field under the [get task](../api/Public-API.v1-fv.html#/operations/GetTask) endpoint to be used when completing the tasks. - You can now change the folder visibility when updating a customer. - We fixed various bugs. ## 17 October 2023 -- This release delivers more integrations for the customer resource type. You can now [create](../reference/Public-API.v1.json/paths/~1customers/post), [update](../reference/Public-API.v1.json/paths/~1customers~1{customerId}/put) and [delete](../reference/Public-API.v1.json/paths//~1customers~1{customerId}/delete) customers. -- We enhanced the response model for [pricing](../reference/Public-API.v1.json/paths/~1pricing-models/get) endpoints. -- As previously announced, we made the `dueBy`, the `location` and the `languageDirections` fields mandatory for [creating a project](../reference/Public-API.v1.json/paths/~1projects/post). -- We added `deliveredBy` as a new field for the [update project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) capabilities. +- This release delivers more integrations for the customer resource type. You can now [create](../api/Public-API.v1-fv.html#/operations/CreateCustomer), [update](../api/Public-API.v1-fv.html#/operations/UpdateCustomer) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteCustomer) customers. +- We enhanced the response model for [pricing](../api/Public-API.v1-fv.html#/operations/ListPricingModels) endpoints. +- As previously announced, we made the `dueBy`, the `location` and the `languageDirections` fields mandatory for [creating a project](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We added `deliveredBy` as a new field for the [update project](../api/Public-API.v1-fv.html#/operations/UpdateProject) capabilities. - We extended the information available on the [webhooks setup](../docs/webhooks/Webhooks-setup.md) page. - We fixed various bugs. ## 06 September 2023 -- With this release we deliver the [create](../reference/Public-API.v1.json/paths/~1schedule-templates/post), [read](../reference/Public-API.v1.json/paths/~1schedule-templates~1{scheduleTemplateId}/get), [update](../reference/Public-API.v1.json/paths/~1schedule-templates~1{scheduleTemplateId}/put) and [delete](../reference/Public-API.v1.json/paths/~1schedule-templates~1{scheduleTemplateId}/delete) endpoints of the new schedule template resource. You will find the endpoints under the [schedule templates](../reference/Public-API.v1.json/paths/~1schedule-templates/get) menu. You can also retrieve the schedule template attached to a [project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) or to a [project template](../reference/Public-API.v1.json/paths/~1project-templates~1{projectTemplateId}/get) using the relevant fields. -- Additionally, the [create project](../reference/Public-API.v1.json/paths/~1projects/post) now supports the schedule template resource, either individually or from the project template. -- We added the `apiInternalId` to [task type](../reference/Public-API.v1.json/components/schemas/task-type) and [workflow task template](../reference/Public-API.v1.json/components/schemas/workflow-task-template) to easily identify custom tasks. +- With this release we deliver the [create](../api/Public-API.v1-fv.html#/operations/CreateScheduleTemplate), [read](../api/Public-API.v1-fv.html#/operations/GetScheduleTemplate), [update](../api/Public-API.v1-fv.html#/operations/UpdateScheduleTemplate) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteScheduleTemplate) endpoints of the new schedule template resource. You will find the endpoints under the [schedule templates](../api/Public-API.v1-fv.html#/operations/ListScheduleTemplates) menu. You can also retrieve the schedule template attached to a [project](../api/Public-API.v1-fv.html#/operations/GetProject) or to a [project template](../api/Public-API.v1-fv.html#/operations/GetProjectTemplate) using the relevant fields. +- Additionally, the [create project](../api/Public-API.v1-fv.html#/operations/CreateProject) now supports the schedule template resource, either individually or from the project template. +- We added the `apiInternalId` to [task type](../api/Public-API.v1-fv.html#/schemas/task-type) and [workflow task template](../api/Public-API.v1-fv.html#/schemas/workflow-task-template) to easily identify custom tasks. - We fixed various bugs. ## 17 August 2023 -- We updated the folder/resource locations to the new format, which now includes the [path](../reference/Public-API.v1.json/components/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. Please ensure you update the implementation if you are using fields that are marked as deprecated. -- Enhanced [project configuration](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1configuration/put) now includes new choices for updating translation memory settings. +- We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. Please ensure you update the implementation if you are using fields that are marked as deprecated. +- Enhanced [project configuration](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) now includes new choices for updating translation memory settings. - We fixed various bugs. - As a reminder, we want to let our users know that validations related to the following fields used at project creation: `dueBy`, `location` and `languageDirections` will become **required** in near future. ## 02 August 2023 -- With this release we provide a new endpoint to allow integrators to update only one [custom field](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1custom-fields~1{customFieldKey}/put) of a project +- With this release we provide a new endpoint to allow integrators to update only one [custom field](../api/Public-API.v1-fv.html#/operations/UpdateCustomField) of a project - We extended the information available on the [webhooks](../docs/webhooks/Webhooks-payload.md) page -- You can now update a translation engine as a stand alone resource or one that is linked to a live project. Read this [page](../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put) for more details. +- You can now update a translation engine as a stand alone resource or one that is linked to a live project. Read this [page](../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine) for more details. - We fixed various bugs. ## 15 June 2023 -- We extended the information provided for both [source](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1{sourceFileId}~1versions/get) and [target](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions/get) files in a task with the `name`, the `version` and `originatingTaskId` details -- We made available a new [rate-limits](../reference/Public-API.v1.json/paths/~1rate-limits/get) endpoint and a new header which includes the relevant policy name, namely, the `X-RateLimit-Policy` header. Read the [API-rate-limits](../docs/API-rate-limits.md) page for more details. +- We extended the information provided for both [source](../api/Public-API.v1-fv.html#/operations/ListSourceFileVersions) and [target](../api/Public-API.v1-fv.html#/operations/ListTargetFileVersions) files in a task with the `name`, the `version` and `originatingTaskId` details +- We made available a new [rate-limits](../api/Public-API.v1-fv.html#/operations/ListRateLimits) endpoint and a new header which includes the relevant policy name, namely, the `X-RateLimit-Policy` header. Read the [API-rate-limits](../docs/API-rate-limits.md) page for more details. - We improved descriptions for the `default` and `required` fields [here](../docs/Use-fields-in-your-requests.md). - We updated the JAVA samples to reflect changes in the SDK. - We fixed various bugs. @@ -172,7 +172,7 @@ ## 19 May 2023 - We replaced the `friendlyId` on all Project Group endpoints with `shortId` and we've exposed it on all Project endpoints too. - As a security enhancement, we will restrict some characters in naming projects and project files. The unsupported characters are: `<`, `>`, `:`, `"`, `/`, `\`, `|`, `?`, `*`. -- In 6 months we will introduce the following breaking change: on the [Export Quote Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post) endpoint, if the quote is not generated using a Quote Template, the response will be an empty object. +- In 6 months we will introduce the following breaking change: on the [Export Quote Report](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) endpoint, if the quote is not generated using a Quote Template, the response will be an empty object. - We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 3 months. - As a reminder, we want to let our users know that for security issues or bugs we may introduce breaking changes at any time. @@ -197,32 +197,32 @@ ## 15 February 2023 - We enabled support for the Trados Enterprise Quote Template functionality -- We introduced the `projectManagers` field to enable the selection of individuals or of users groups at [project creation](../reference/Public-API.v1.json/paths/~1projects/post). -- We removed unnecessary outcome values for the [Task Completed Request](../reference/Public-API.v1.json/components/schemas/task-complete-request) model on the [Complete Task](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1complete/put) operation. This impacts the SDKs, so update your integration accordingly. -- You can now specify the `projectCreator` as an assignee type for a task when [updating a project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put). +- We introduced the `projectManagers` field to enable the selection of individuals or of users groups at [project creation](../api/Public-API.v1-fv.html#/operations/CreateProject). +- We removed unnecessary outcome values for the [Task Completed Request](../api/Public-API.v1-fv.html#/schemas/task-complete-request) model on the [Complete Task](../api/Public-API.v1-fv.html#/operations/CompleteTask) operation. This impacts the SDKs, so update your integration accordingly. +- You can now specify the `projectCreator` as an assignee type for a task when [updating a project](../api/Public-API.v1-fv.html#/operations/UpdateProject). - We will enforce validations related to the following fields at project creation: `dueBy`, `location` and `languageDirections`. These fields will become **required** in 6 months. ## 11 January 2023 -- You can now [create](../reference/Public-API.v1.json/paths/~1project-groups/post), [read](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get), [update](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/put) and [delete](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/delete) Project Groups +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateProjectGroup), [read](../api/Public-API.v1-fv.html#/operations/GetProjectGroup), [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectGroup) and [delete](../api/Public-API.v1-fv.html#/operations/DeleteProjectGroup) Project Groups - We've improved filtering for projects lists, namely by status and by creation date - We've introduced fields displaying more details for error tasks - We fixed various bugs ## 22 November 2022 -- To enable support for the Trados Enterprise multi-source resources functionality, we're introducing an important breaking change: when creating workflows with multi-source languages from the TE UI, please use the new `languageDirection` scope value. As the new feature may limit previously working functionality, inconsistencies within applications or certain products may appear. For integrations that are impacted, please contact their developers to update the integrations. -- We've made 3 new endpoints available for [TM export](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1exports/post) +- To enable support for the Trados Enterprise multi-source resources functionality, we're introducing an important breaking change: when creating workflows with multi-source languages from the TE UI, please use the new `languageDirection` scope value. As the new feature may limit previously working functionality, inconsistencies within applications or certain products may appear. For integrations that are impacted, please contact their developers to update the integrations. +- We've made 3 new endpoints available for [TM export](../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) - We removed the old 10 MB size limitations for files, termbases and translation memories. We now support [these values](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) for files and [these values](https://docs.rws.com/791595/741139/trados-enterprise---accelerate/importing-tm-content) for importing translation memory content. - Users can now retrieve task comments. -- We've added the [TM Import history](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/get) endpoint. +- We've added the [TM Import history](../api/Public-API.v1-fv.html#/operations/GetTMImportHistory) endpoint. - We are postponing the breaking change in the `LanguageDirectionRequest` model, previously announced for November, and consequently the model can be used until the end of 2022. - 4 new endpoints are subject to [API limits](https://languagecloud.sdl.com/lc/api-docs/d2266fabaa1bf-api-rate-limits#project-files-rate-limits) - We fixed various bugs. ## 28 October 2022 -- You can [import translation memories](../docs/translation-memory/Translation-memory-import-export.md) using the [import](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/post) and [poll](../reference/Public-API.v1.json/paths/~1translation-memory~1imports~1{importId}/get) endpoints. Note that the maximum size for an imported translation memory is 10 MB. +- You can [import translation memories](../docs/translation-memory/Translation-memory-import-export.md) using the [import](../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) and [poll](../api/Public-API.v1-fv.html#/operations/PollTMImport) endpoints. Note that the maximum size for an imported translation memory is 10 MB. - We added traceability fields for terminology entries: createdAt, createdBy, lastModifiedAt, lastModifiedBy - We added recommendations for [HTTP headers](../docs/Headers-considerations.md) - We updated the recommendations for [Authentication](../docs/Authentication.md) and the [API rate limits](../docs/API-rate-limits.md) with token values and other details @@ -230,19 +230,19 @@ ## 15 September 2022 - We introduced a new [Export Quote Report](../docs/Export-quote-report.md) mechanism and deprecated the older endpoint -- We updated the constrains for the 'name' and 'description' fields for the [Create Project](../reference/Public-API.v1.json/paths/~1projects/post) and [Update Project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) endpoints that will be enforced starting December 2022 +- We updated the constrains for the 'name' and 'description' fields for the [Create Project](../api/Public-API.v1-fv.html#/operations/CreateProject) and [Update Project](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoints that will be enforced starting December 2022 - We introduced a new page for the currently [Known issues](../docs/Known-Issues.md) - We fixed various bugs ## 22 August 2022 -- You can now read [language processing rules](../reference/Public-API.v1.json/paths/~1language-processing-rules/get) and [translation memory field templates](../reference/Public-API.v1.json/paths/~1translation-memory~1field-templates/get) -- You can now [create](../reference/Public-API.v1.json/paths/~1translation-memory/post), [read](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}/get), [update](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}/put), [delete](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}/delete) and [copy](../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1copy/post) translation memories +- You can now read [language processing rules](../api/Public-API.v1-fv.html#/operations/ListLanguageProcessingRules) and [translation memory field templates](../api/Public-API.v1-fv.html#/operations/ListFieldTemplates) +- You can now [create](../api/Public-API.v1-fv.html#/operations/CreateTranslationMemory), [read](../api/Public-API.v1-fv.html#/operations/GetTranslationMemory), [update](../api/Public-API.v1-fv.html#/operations/UpdateTranslationMemory), [delete](../api/Public-API.v1-fv.html#/operations/DeleteTranslationMemory) and [copy](../api/Public-API.v1-fv.html#/operations/CopyTranslationMemory) translation memories ## 12 August 2022 - Retiring of the Export Quote endpoint will happen in 6 months. You can read more about it [here](../docs/Public-API-Management-Process.md#endpoint-retirement-process). -- We now support the Export Quote Report functionality with 3 new endpoints: [Poll Quote Export Report](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get), [Export Quote](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post) and [Download Exported Quote](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get). -- You can now upload [source](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}~1versions/post) and [target](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1target-files~1{targetFileId}~1versions/post) file versions +- We now support the Export Quote Report functionality with 3 new endpoints: [Poll Quote Export Report](../api/Public-API.v1-fv.html#/operations/PollQuoteReportExport), [Export Quote](../api/Public-API.v1-fv.html#/operations/ExportQuoteReport) and [Download Exported Quote](../api/Public-API.v1-fv.html#/operations/DownloadQuoteReport). +- You can now upload [source](../api/Public-API.v1-fv.html#/operations/AddSourceFileVersion) and [target](../api/Public-API.v1-fv.html#/operations/AddTargetFileVersion) file versions - We published a new page about [File formats](../docs/File-formats.md) - We fixed various bugs @@ -253,12 +253,12 @@ ## 19 July 2022 -- You can now update [source](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1{sourceFileId}/put) and [target](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}/put) file names +- You can now update [source](../api/Public-API.v1-fv.html#/operations/UpdateSourceFile) and [target](../api/Public-API.v1-fv.html#/operations/UpdateTargetFile) file names - We fixed various bugs ## 28 June 2022 -- You can now [read](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1configuration/get) and [update](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1configuration/put) translation memory settings for a project's configuration +- You can now [read](../api/Public-API.v1-fv.html#/operations/GetProjectConfiguration) and [update](../api/Public-API.v1-fv.html#/operations/UpdateProjectConfiguration) translation memory settings for a project's configuration - We updated the user guide page for [using fields](../docs/Use-fields-in-your-requests.md) with new animated gifs - We fixed various bugs @@ -272,7 +272,7 @@ - To address potentially infected files, we've updated our API contracts to support In-Product Antivirus scanning ## 04 May 2022 -- You can now upload a .zip archive using [this](../reference/Public-API.v1.json/paths/~1files/post) endpoint and then [poll](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) for the extracted files. After extraction, you can upload multiple source files to a project using a [single call](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post). The maximum size for an imported .zip file is 10 MB. +- You can now upload a .zip archive using [this](../api/Public-API.v1-fv.html#/operations/UploadZipFile) endpoint and then [poll](../api/Public-API.v1-fv.html#/operations/PollUploadZipFile) for the extracted files. After extraction, you can upload multiple source files to a project using a [single call](../api/Public-API.v1-fv.html#/operations/AddSourceFiles). The maximum size for an imported .zip file is 10 MB. - Our Java SDK client is now available in **public beta**. [Here](../docs/api-clients/java/Java-Client.md) are more details on how to start integrating it into your solution - We published the API limits [here](../docs/API-rate-limits.md) - We updated the Custom fields [page](../docs/Custom-Fields.md) with useful gifs @@ -285,7 +285,7 @@ - We fixed various bugs ## 22 February 2022 -- You can now convert an xdt file into a termbase structure using [this](../reference/Public-API.v1.json/paths/~1termbase-templates~1convert-xdt/post) dedicated endpoint +- You can now convert an xdt file into a termbase structure using [this](../api/Public-API.v1-fv.html#/operations/ConvertTermbaseTemplate) dedicated endpoint - When updating a termbase entry you will have to provide either the name or the identifier for the `termbaseFieldValues` - We fixed various bugs @@ -301,7 +301,7 @@ - We fixed various bugs ## 18 November 2021 -- You can now update the configurations of future tasks using the `projectPlan` field, in the [`update project`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/put) endpoint +- You can now update the configurations of future tasks using the `projectPlan` field, in the [`update project`](../api/Public-API.v1-fv.html#/operations/UpdateProject) endpoint - Fixed various bugs ## 20 October 2021 @@ -310,7 +310,7 @@ ## 04 October 2021 - Added multiple date formats -- Added pagination for [`List File Processing Configurations`](../reference/Public-API.v1.json/paths/~1file-processing-configurations/get) endpoint +- Added pagination for [`List File Processing Configurations`](../api/Public-API.v1-fv.html#/operations/ListFileProcessingConfigurations) endpoint - Fixed various bugs ## 08 September 2021 @@ -326,13 +326,13 @@ - When creating/updating projects using a project template which has mandatory custom fields, you must supply those custom fields - Fixed various bugs -**We will remove deprecated fields from the [`ErrorResponse`](../reference/Public-API.v1.json/components/schemas/error-response) model in an upcoming release. Please ensure you are not using fields marked as deprecated!** +**We will remove deprecated fields from the [`ErrorResponse`](../api/Public-API.v1-fv.html#/schemas/error-response) model in an upcoming release. Please ensure you are not using fields marked as deprecated!** ## 29 July 2021 - Added endpoints for custom field definitions. - Added support for custom fields on projects and project templates. -- The `translationEngine`, `fileProcessingConfiguration`, `workflow` fields are now required on the [`/projects`](../reference/Public-API.v1.json/paths/~1projects/post) endpoint. -- The `isSkipped` field is now marked as required on the [`/workflow/updateworkflow`](../reference/Public-API.v1.json/paths/~1workflows~1{workflowId}/put) endpoint. +- The `translationEngine`, `fileProcessingConfiguration`, `workflow` fields are now required on the [`/projects`](../api/Public-API.v1-fv.html#/operations/CreateProject) endpoint. +- The `isSkipped` field is now marked as required on the [`/workflow/updateworkflow`](../api/Public-API.v1-fv.html#/operations/UpdateWorkflow) endpoint. - Added new assignee type `projectCreator` when retrieving workflows. - Improved contract documentation on TQA endpoints. - Fixed various bugs. @@ -352,17 +352,17 @@ A Postman Collection is now available for integrators. Check out [this](../docs/ * **Target File** > **Download File Version** endpoint -When you make a `GET` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1download/get) endpoint, you can now perform a direct download of the native file as well as of the `BCM` file version. +When you make a `GET` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/download`](../api/Public-API.v1-fv.html#/operations/DownloadFileVersion) endpoint, you can now perform a direct download of the native file as well as of the `BCM` file version. * **Target File** > **Export Target File Version** endpoint -When you make a `POST` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports/post) endpoint, you now have a query parameter where you can specify whether the file version export should be a native file or an `sdlxliff` file. The default value is `native`. +When you make a `POST` request to the [`/projects/{projectId}/target-files/{targetFileId}/versions/{fileVersionId}/exports`](../api/Public-API.v1-fv.html#/operations/ExportTargetFileVersion) endpoint, you now have a query parameter where you can specify whether the file version export should be a native file or an `sdlxliff` file. The default value is `native`. ## 28 January 2021 -* **Project** > **List Project’s Tasks** endpoint +* **Project** > **List Project’s Tasks** endpoint -When you make a `GET` request to the [`/projects/{projectId}/tasks`](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1tasks/get) endpoint, you can now retrieve the available project tasks and their details. +When you make a `GET` request to the [`/projects/{projectId}/tasks`](../api/Public-API.v1-fv.html#/operations/ListProjectTasks) endpoint, you can now retrieve the available project tasks and their details. * **Retrieving tasks** @@ -379,4 +379,5 @@ When adding source files to a project, you can specify their target languages vi -₍^. .^₎⟆ \ No newline at end of file +â‚Ť^. .^₎⟆ + diff --git a/articles/LCPublicAPI/docs/Whats-deprecated.md b/articles/LCPublicAPI/docs/Whats-deprecated.md index 773f4b2..22584fe 100644 --- a/articles/LCPublicAPI/docs/Whats-deprecated.md +++ b/articles/LCPublicAPI/docs/Whats-deprecated.md @@ -1,19 +1,19 @@ -# What's Deprecated +# What's Deprecated
## 1 July 2024 -We have removed the old fields in the folder/resource structure and are no longer available. Use the [path](../reference/Public-API.v1.json/components/schemas/folder-v2) field going forward. +We have removed the old fields in the folder/resource structure and are no longer available. Use the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2) field going forward. ## 13 December 2023 - The `Export Quote` endpoint has been removed. - In the Get Project Template model we deprecated: - - `forceOnline` field from root level and we added `forceOnline` to the settings → general - - `quoteTemplate` field from root level and we added `quoteTemplate` to the settings → general + - `forceOnline` field from root level and we added `forceOnline` to the settings → general + - `quoteTemplate` field from root level and we added `quoteTemplate` to the settings → general They will only be available for use until July 2024. ## 17 August 2023 -We updated the folder/resource locations to the new format, which now includes the [path](../reference/Public-API.v1.json/components/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. +We updated the folder/resource locations to the new format, which now includes the [path](../api/Public-API.v1-fv.html#/schemas/folder-v2). The old fields are marked as deprecated and their decommissioning is scheduled at a minimum of six months from now. ## 12 August 2022 In the `Quote` code, we deprecated the `Export Quote` endpoint. It will only be available for use until December 2022. @@ -30,3 +30,4 @@ They will no longer be available to use starting with November 2022. ## 8 September 2021 We removed deprecated fields from the ErrorResponse model. + diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-entries.md b/articles/LCPublicAPI/docs/termbase/Termbase-entries.md index 06afc3c..7f40137 100644 --- a/articles/LCPublicAPI/docs/termbase/Termbase-entries.md +++ b/articles/LCPublicAPI/docs/termbase/Termbase-entries.md @@ -1,9 +1,9 @@ -# Termbase entries +# Termbase entries
## Creating a termbase entry -A termbase entry can be created by making a `POST` request to the [`/termbases/{termbaseId}/entries`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries/post) endpoint. +A termbase entry can be created by making a `POST` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/CreateTermbaseEntry) endpoint. Request example for an entry using language code `en`: `POST /termbases/61b70c0775ed5f14d8190fab/entries` ```json @@ -96,7 +96,7 @@ Postman example: ## Updating a termbase entry -A termbase entry can be updated by making a `PUT` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries~1{entryId}/put) endpoint. +A termbase entry can be updated by making a `PUT` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbaseEntry) endpoint. The update action changes the entire structure of an entry, it doesn't only update the terms specified in the request body. The terms that are not specified, are deleted. If some terms should not be updated, their structure must be send in the request as it currently is. @@ -142,7 +142,7 @@ Request example: `PUT /termbases/61b70c0775ed5f14d8190fab/entries/61b73e4475ed5f ## Retrieving a termbase entry -A termbase entry can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries~1{entryId}/get) endpoint. Postman example: +A termbase entry can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbaseEntry) endpoint. Postman example: ![Get termbase entry with fields](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/PublicAPI/GetTermbaseEntryPostman.gif?raw=true) @@ -183,7 +183,7 @@ Response example: ## Retrieving the list of termbase entries -You can retrieve the list of termbase entries by making a `GET` request to the [`/termbases/{termbaseId}/entries`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries/get) endpoint. +You can retrieve the list of termbase entries by making a `GET` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/ListTermbaseEntries) endpoint. Request example: `GET /termbases/61b70c0775ed5f14d8190fab/entries?fields=humanReadableId,languages.terms,languages.terms.termbaseFieldValues` @@ -273,13 +273,14 @@ Response example: ## Deleting a termbase entry -A termbase entry can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries~1{entryId}/delete) endpoint. +A termbase entry can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries/{entryId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseEntry) endpoint. Request example: `DELETE /termbases/61b70c0775ed5f14d8190fab/entries/61b73e4475ed5f14d81ae5e7` ## Deleting all termbase entries -All termbase entries can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1entries/delete) endpoint. +All termbase entries can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}/entries`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseEntries) endpoint. Request example: `DELETE /termbases/61b70c0775ed5f14d8190fab/entries` + diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md b/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md index 559113b..d324065 100644 --- a/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md +++ b/articles/LCPublicAPI/docs/termbase/Termbase-import-export.md @@ -1,13 +1,13 @@ -# Termbase import and export +# Termbase import and export
## Importing a termbase The following termbase formats are supported: `tbx` and `xml`. -> Before importing a termbase, make sure you already created one using the [Create Termbase](../../reference/Public-API.v1.json/paths/~1termbases/post) endpoint. Only empty termbases support importing content. +> Before importing a termbase, make sure you already created one using the [Create Termbase](../../api/Public-API.v1-fv.html#/operations/CreateTermbase) endpoint. Only empty termbases support importing content. -To import a `tbx` or an `xml` termbase, perform a `POST` request to the [Import Termbase](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports/post) endpoint and provide the `termbaseId` and the termbase file. Optionally, you can specify two import settings via query parameters: +To import a `tbx` or an `xml` termbase, perform a `POST` request to the [Import Termbase](../../api/Public-API.v1-fv.html#/operations/ImportTermbase) endpoint and provide the `termbaseId` and the termbase file. Optionally, you can specify two import settings via query parameters: 1. `duplicateEntriesStrategy` - It determines how the duplicate entries will be handled and it can have one of the following values: @@ -38,14 +38,14 @@ If the import is successful, you will get back an `importId` and the import `sta ## Polling a termbase import Some imports may take longer, depending on the size of the termbase. -To check if the import finished, you can perform a `GET` request to the [Poll Termbase Import](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1imports~1{importId}/get) endpoint and supply the `importId` and the `termbaseId`. The import is complete when the status is `done`. +To check if the import finished, you can perform a `GET` request to the [Poll Termbase Import](../../api/Public-API.v1-fv.html#/operations/PollTermbaseImport) endpoint and supply the `importId` and the `termbaseId`. The import is complete when the status is `done`.
## Exporting a termbase The following termbase formats are supported: `tbx` and `xml`. -To export a `tbx` or an `xml` termbase, perform a `POST` request to the [Export Termbase](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports/post) endpoint and provide the `termbaseId`. +To export a `tbx` or an `xml` termbase, perform a `POST` request to the [Export Termbase](../../api/Public-API.v1-fv.html#/operations/ExportTermbase) endpoint and provide the `termbaseId`. Optionally, you can specify in body, one of the two allowed formats. If none is specified, the default format will be `tbx`. Also, in the body, it can be specified if the download should be compressed (zipped) or not. By default, this property is set to `false`. If the export is successful, you will get back an `exportId`, the export `status` and the `downloadUrl` for this. If the export did not succeed, the response will contain an `errorMessage`. @@ -57,10 +57,10 @@ If the export is successful, you will get back an `exportId`, the export `status ## Polling a termbase export Some exports may take longer, depending on the size of the termbase. -To check if the export finished, you can perform a `GET` request to the [Poll Termbase Export](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports~1{exportId}/get) endpoint and supply the `exportId` and the `termbaseId`. The export is complete when the status is `done`. +To check if the export finished, you can perform a `GET` request to the [Poll Termbase Export](../../api/Public-API.v1-fv.html#/operations/PollExportTermbase) endpoint and supply the `exportId` and the `termbaseId`. The export is complete when the status is `done`.
## Downloading a termbase export -If an export is completed (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Termbase](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports~1{exportId}~1download/get) endpoint. Supply as path parameters the `exportId` and the `termbaseId` and the response will contain the exported termbase file. -
\ No newline at end of file +If an export is completed (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Termbase](../../api/Public-API.v1-fv.html#/operations/DownloadExportedTermbase) endpoint. Supply as path parameters the `exportId` and the `termbaseId` and the response will contain the exported termbase file. +
diff --git a/articles/LCPublicAPI/docs/termbase/Termbase-templates.md b/articles/LCPublicAPI/docs/termbase/Termbase-templates.md index 83aa94a..05d4441 100644 --- a/articles/LCPublicAPI/docs/termbase/Termbase-templates.md +++ b/articles/LCPublicAPI/docs/termbase/Termbase-templates.md @@ -1,9 +1,9 @@ -# Termbase templates +# Termbase templates
## Creating a termbase template -A termbase template can be created by making a `POST` request to the [`/termbase-templates`](../../reference/Public-API.v1.json/paths/~1termbase-templates/post) endpoint. +A termbase template can be created by making a `POST` request to the [`/termbase-templates`](../../api/Public-API.v1-fv.html#/operations/CreateTermbaseTemplate) endpoint. > Note: If the `location` is not specified, the template will be created in the root folder. @@ -75,7 +75,7 @@ Response example: ## Updating a termbase template -A termbase template can be updated by making a `PUT` request to the [`/termbase-templates/{termbaseTemplateId}`](../../reference/Public-API.v1.json/paths/~1termbase-templates~1{termbaseTemplateId}/put) endpoint. Postman example: +A termbase template can be updated by making a `PUT` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbaseTemplate) endpoint. Postman example: ![Update Termbase Template](https://raw.githubusercontent.com/RWS/language-cloud-public-api-doc-resources/main/PublicAPI/UpdateTermbaseTemplate.gif?raw=true) @@ -105,7 +105,7 @@ Request example: `PUT /termbase-templates/6156bbc7a638696c7686db7f` ## Retrieving a termbase template -A termbase template can be retrieved by making a `GET` request to the [`/termbase-templates/{termbaseTemplateId}`](../../reference/Public-API.v1.json/paths/~1termbase-templates~1{termbaseTemplateId}/get) endpoint. +A termbase template can be retrieved by making a `GET` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbaseTemplate) endpoint. Request example: `GET /termbase-templates/6156bbc7a638696c7686db7f?fields=name,location,description,languages,fields` @@ -140,7 +140,7 @@ Response example: ## Retrieving termbase templates -You can retrieve the list of termbase templates by making a `GET` request to the [`/termbase-templates`](../../reference/Public-API.v1.json/paths/~1termbase-templates/get) endpoint. +You can retrieve the list of termbase templates by making a `GET` request to the [`/termbase-templates`](../../api/Public-API.v1-fv.html#/operations/ListTermbaseTemplates) endpoint. Request example: `GET /termbase-templates?fields=name,description` @@ -171,8 +171,8 @@ Response example: ## Deleting termbase templates -A termbase template can be deleted by making a `DELETE` request to the [`/termbase-templates/{termbaseTemplateId}`](../../reference/Public-API.v1.json/paths/~1termbase-templates~1{termbaseTemplateId}/delete) endpoint. +A termbase template can be deleted by making a `DELETE` request to the [`/termbase-templates/{termbaseTemplateId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbaseTemplate) endpoint. > Note: You can only delete the `userDefined` termbases. -Request example: `DELETE /termbase-templates/6156bbc7a638696c7686db7f` \ No newline at end of file +Request example: `DELETE /termbase-templates/6156bbc7a638696c7686db7f` diff --git a/articles/LCPublicAPI/docs/termbase/Termbase.md b/articles/LCPublicAPI/docs/termbase/Termbase.md index 633bade..9544536 100644 --- a/articles/LCPublicAPI/docs/termbase/Termbase.md +++ b/articles/LCPublicAPI/docs/termbase/Termbase.md @@ -1,9 +1,9 @@ -# Termbases +# Termbases
## Creating a termbase -A termbase can be created by making a `POST` request to the [`/termbases`](../../reference/Public-API.v1.json/paths/~1termbases/post) endpoint. +A termbase can be created by making a `POST` request to the [`/termbases`](../../api/Public-API.v1-fv.html#/operations/CreateTermbase) endpoint. You can create a termbase based on an existing termbase template by providing the `termbaseTemplateId`. This will create the termbase using the structure described by the template. For details about termbase templates, see [`Termbase Template`](../../docs/termbase/Termbase-templates.md). Postman example: @@ -78,7 +78,7 @@ Response example: ## Updating a termbase > You can update the fields for a termbase only if the termbase you want to update was not created using a termbase template or if it does not already have fields defined. -A termbase can be updated by making a `PUT` request to the [`/termbases/{termbaseId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}/put) endpoint and providing the `termbaseTemplateId`. +A termbase can be updated by making a `PUT` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/UpdateTermbase) endpoint and providing the `termbaseTemplateId`. Request example: `PUT /termbases/616d0efa7a11677d6085b0be` ```json @@ -127,7 +127,7 @@ Request example: `PUT /termbases/616d0efa7a11677d6085b0be` ## Retrieving a termbase -A termbase can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}/get) endpoint. +A termbase can be retrieved by making a `GET` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/GetTermbase) endpoint. Request example: `GET /termbases/616d0efa7a11677d6085b0be` @@ -147,7 +147,7 @@ Response example: ## Retrieving the list of termbases -You can retrieve the list of termbases by making a `GET` request to the [`/termbases`](../../reference/Public-API.v1.json/paths/~1termbases/get) endpoint. +You can retrieve the list of termbases by making a `GET` request to the [`/termbases`](../../api/Public-API.v1-fv.html#/operations/ListTermbase) endpoint. Request example: `GET /termbases` @@ -180,6 +180,6 @@ Response example: ## Deleting termbases -A termbase can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}`](../../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}/delete) endpoint. +A termbase can be deleted by making a `DELETE` request to the [`/termbases/{termbaseId}`](../../api/Public-API.v1-fv.html#/operations/DeleteTermbase) endpoint. -Request example: `DELETE /termbases/616d0efa7a11677d6085b0be` \ No newline at end of file +Request example: `DELETE /termbases/616d0efa7a11677d6085b0be` diff --git a/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md b/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md index 6c0f931..afca740 100644 --- a/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md +++ b/articles/LCPublicAPI/docs/translation-memory/Translation-memory-import-export.md @@ -1,4 +1,4 @@ -# Translation Memory import and export +# Translation Memory import and export ## Concepts @@ -12,9 +12,9 @@ Concept | Explanation | The translation memory that you want to import must have one of the following formats: `tmx`, `sdltm`, `zip`, `tmx.gz` or `sdlxliff`. -> Before the import action, make sure you have already created a translation memory using the [Create Translation Memory](../../reference/Public-API.v1.json/paths/~1translation-memory/post) endpoint. +> Before the import action, make sure you have already created a translation memory using the [Create Translation Memory](../../api/Public-API.v1-fv.html#/operations/CreateTranslationMemory) endpoint. -To import a translation memory, perform a `POST` request to the [Import Translation Memory](../../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1imports/post) endpoint and provide these details: `translationMemoryId`, the translation memory file and a couple of properties. +To import a translation memory, perform a `POST` request to the [Import Translation Memory](../../api/Public-API.v1-fv.html#/operations/ImportTranslationMemory) endpoint and provide these details: `translationMemoryId`, the translation memory file and a couple of properties. > Pay special attention to the order of `properties` and `file`. It must be exactly as described in the contract (properties first). @@ -54,12 +54,12 @@ For more details about translation memory imports you can also check out the [Im ## Polling a translation memory import Some imports may take longer, depending on the size of the Translation Memory. -To check if the import finished, you can perform a `GET` request to the [Poll Translation Memory Import](../../reference/Public-API.v1.json/paths/~1translation-memory~1imports~1{importId}/get) endpoint and supply the `importId` and the `translationMemoryId`. The import is complete when the status is `done`. +To check if the import finished, you can perform a `GET` request to the [Poll Translation Memory Import](../../api/Public-API.v1-fv.html#/operations/PollTMImport) endpoint and supply the `importId` and the `translationMemoryId`. The import is complete when the status is `done`. ## Exporting a translation memory -To export a translation memory, perform a `POST` request to the [Export Translation Memory](../../reference/Public-API.v1.json/paths/~1translation-memory~1{translationMemoryId}~1exports/post) endpoint and provide the `translationMemoryId` and a valid `languageDirection` of your translation memory. +To export a translation memory, perform a `POST` request to the [Export Translation Memory](../../api/Public-API.v1-fv.html#/operations/ExportTranslationMemory) endpoint and provide the `translationMemoryId` and a valid `languageDirection` of your translation memory. If the export is successful, you will get back an `exportId` and the export `status`. If the export did not succeed, the response will contain an error message. @@ -69,8 +69,9 @@ If the export is successful, you will get back an `exportId` and the export `sta Some exports may take longer, depending on the size of the Translation Memory. -To check if the export finished, you can perform a `GET` request to the [Poll Translation Memory Export](../../reference/Public-API.v1.json/paths/~1translation-memory~1exports~1{exportId}/get) endpoint and supply the `exportId`. The export is complete when the status is `done`. +To check if the export finished, you can perform a `GET` request to the [Poll Translation Memory Export](../../api/Public-API.v1-fv.html#/operations/PollTranslationMemoryExport) endpoint and supply the `exportId`. The export is complete when the status is `done`. ## Downloading a translation memory export -If an export is completed successfully (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Translation Memory](../../reference/Public-API.v1.json/paths/~1translation-memory~1exports~1{exportId}~1download/get) endpoint. Just supply as `path` parameter the `exportId` and the response will contain the exported translation memory file in `tmx.gz` format. +If an export is completed successfully (the status received at the polling is `done`), it can be downloaded by performing a `GET` request to the [Download Exported Translation Memory](../../api/Public-API.v1-fv.html#/operations/DownloadExportedTranslationMemory) endpoint. Just supply as `path` parameter the `exportId` and the response will contain the exported translation memory file in `tmx.gz` format. + diff --git a/articles/LCPublicAPI/docs/translations/Translations.md b/articles/LCPublicAPI/docs/translations/Translations.md index 85e7f05..30e3e12 100644 --- a/articles/LCPublicAPI/docs/translations/Translations.md +++ b/articles/LCPublicAPI/docs/translations/Translations.md @@ -1,4 +1,4 @@ -# Translation API +# Translation API The Translation API provides endpoints for performing translation operations using translation engines. These endpoints allow you to lookup translations, perform concordance searches, and manage translation units within your translation memories. @@ -19,7 +19,7 @@ All translation operations require a translation engine that defines which trans ### Translation Lookup -[`POST /translations/lookup`](../../reference/Public-API.v1.json/paths/~1translations~1lookup/post) +[`POST /translations/lookup`](../../api/Public-API.v1-fv.html#/operations/TranslationsLookup) Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a [BCM fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). @@ -71,7 +71,7 @@ Translates a phrase in plain text or a BCM fragment containing a single segment. ### Concordance Search -[`POST /translations/concordance`](../../reference/Public-API.v1.json/paths/~1translations~1concordance/post) +[`POST /translations/concordance`](../../api/Public-API.v1-fv.html#/operations/TranslationsConcordanceSearch) Performs a concordance search for a given text within the translation memories linked to the specified translation engine. This helps you find segments that contain specific words or phrases. @@ -119,7 +119,7 @@ Performs a concordance search for a given text within the translation memories l #### Update Translation Unit -[`PUT /translations/translation-unit`](../../reference/Public-API.v1.json/paths/~1translations~1translation-unit/put) +[`PUT /translations/translation-unit`](../../api/Public-API.v1-fv.html#/operations/TranslationsUpdate) Updates an existing translation unit in the translation memories. The system identifies matching translation units based on the `originalTranslationHash` provided in the BCM fragment. @@ -164,7 +164,7 @@ Updates an existing translation unit in the translation memories. The system ide #### Add Translation Unit -[`POST /translations/translation-unit`](../../reference/Public-API.v1.json/paths/~1translations~1translation-unit/post) +[`POST /translations/translation-unit`](../../api/Public-API.v1-fv.html#/operations/TranslationsAdd) Adds a new translation unit to the translation memories. @@ -209,7 +209,7 @@ Example of a BCM fragment: "type": "placeholderTag", "metadata": { "SDL:IsSoftBreak": "True", - "SpecialCharacterPlaceholder": "‌", + "SpecialCharacterPlaceholder": "‌", "frameworkOriginalTagId": "50", "SDL:IsWordStop": "False" } @@ -299,7 +299,7 @@ Learn more about [Translation Memory penalties](https://docs.rws.com/en-US/trado ## Related APIs - **[Translation Memory API](../translation-memory/Translation-memory-import-export.md)**: Bulk import/export of translation memories -- **[Translation Engine API](../../reference/Public-API.v1.json/paths/~1translation-engines~1{translationEngineId}/put)**: Manage translation engine configurations +- **[Translation Engine API](../../api/Public-API.v1-fv.html#/operations/UpdateTranslationEngine)**: Manage translation engine configurations - **[Termbase API](../termbase/Termbase.md)**: Manage terminology resources ## Examples and Use Cases @@ -310,4 +310,4 @@ Learn more about [Translation Memory penalties](https://docs.rws.com/en-US/trado 2. **Lookup**: Use `/translations/lookup` for translation suggestions 3. **Research**: Use `/translations/concordance` for plain text research 4. **Quality**: Add/update translation units with the updated BCM fragments retrieved from the previous requests to improve TM quality -5. **Maintenance**: Regular TM updates and quality checks \ No newline at end of file +5. **Maintenance**: Regular TM updates and quality checks diff --git a/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md index 8366b4f..0a970f2 100644 --- a/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md +++ b/articles/LCPublicAPI/docs/webhooks/Batched-webhooks.md @@ -1,7 +1,7 @@ -# Batched Webhooks +# Batched Webhooks Webhooks can be batched to reduce the number of HTTP requests. Batched webhooks are sent as a single HTTP request to the configured webhook URL. -The request body follows the [Webhook Batch](../../reference/Webhooks.v1.json/components/schemas/webhook-batch) structure and contains a set of [Trados Cloud Platform events](../../reference/Webhooks.v1.json/components/schemas/webhook). +The request body follows the [Webhook Batch](../../api/Webhooks.v1-fv.html#/schemas/webhook-batch) structure and contains a set of [Trados Cloud Platform events](../../api/Webhooks.v1-fv.html#/schemas/webhook). ## Considerations for Consuming Batched Webhooks @@ -53,3 +53,4 @@ The current configuration for the Trados Cloud Platform is: * Ensure that a single URL is set for receiving batched webhooks in the Trados Cloud Platform. * Create a single webhook under [Webhooks Setup](Webhooks-setup.md#subscribe-to-webhook-events) that subscribes to multiple event types. + diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md index 50f009b..946bec3 100644 --- a/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md +++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-payload.md @@ -1,6 +1,6 @@ -# Webhooks payload +# Webhooks payload -**The request body** has the same standard JSON format for all [Trados Cloud Platform events](../../reference/Webhooks.v1.json/components/schemas/webhook). +**The request body** has the same standard JSON format for all [Trados Cloud Platform events](../../api/Webhooks.v1-fv.html#/schemas/webhook). An example of request for a `PROJECT_CREATED` event: @@ -51,26 +51,27 @@ This is the envelope that is common to all events, and only the < Data Payload O | Event | Data payload object model | Trigger operations in Trados Cloud Platform API | Trigger operations in Trados UI | |---|---|---|---| -| `PROJECT.TASK.ACCEPTED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Accept task
Accept error task | Accept task
Accept error task | -| `PROJECT.TASK.CREATED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Generate task | Generate task | -| `PROJECT.TASK.COMPLETED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Complete task | Complete task | -| `PROJECT.TASK.UPDATED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | -| `PROJECT.TASK.DELETED` | [`task-event`](../../reference/Webhooks.v1.json/components/schemas/task-event) | Delete project and its tasks | Delete project and its tasks | -| `PROJECT.CREATED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Create project | Create project | -| `PROJECT.STARTED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Start project | Start project | -| `PROJECT.UPDATED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | -| `PROJECT.DELETED` | [`project-event`](../../reference/Webhooks.v1.json/components/schemas/project-event) | Delete project | Delete project | -| `PROJECT.TEMPLATE.CREATED` | [`project-template-event`](../reference/Webhooks.v1.json/components/schemas/project-template-event) | | Create project template | -| `PROJECT.TEMPLATE.UPDATED` | [`project-template-event`](../../reference/Webhooks.v1.json/components/schemas/project-template-event) | | Create project template
Update project template | -| `PROJECT.TEMPLATE.DELETED` | [`project-template-event`](../../reference/Webhooks.v1.json/components/schemas/project-template-event) | | Delete project template | -| `PROJECT.SOURCE.FILE.CREATED` | [`source-file-event`](../reference/Webhooks.v1.json/components/schemas/source-file-event) | Add source file to project
Attach source files to project | Add reference file to project
Add translatable file to project | -| `PROJECT.SOURCE.FILE.UPDATED` | [`source-file-event`](../../reference/Webhooks.v1.json/components/schemas/source-file-event) | Update source file by changing the `name` field
Add source file version
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | Update source file by changing the `fileType` or `fileRole` fields
Add source file version via `Replace file` action
Delete source file version
Cancel source file
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | -| `PROJECT.SOURCE.FILE.DELETED` | [`source-file-event`](../../reference/Webhooks.v1.json/components/schemas/source-file-event) |Delete project and its tasks | Delete project and its tasks | -| `PROJECT.TARGET.FILE.CREATED` | [`target-file-event`](../../reference/Webhooks.v1.json/components/schemas/target-file-event) | The project reaches the `File Format Conversion` task | The project reaches the `File Format Conversion` task | -| `PROJECT.TARGET.FILE.UPDATED` | [`target-file-event`](../../reference/Webhooks.v1.json/components/schemas/target-file-event) | Update source file by changing the `name` field
Add target file version
Import target file version
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | Add target file version via `Upload SDLXLIFF` action
Replace target file
Delete target file version
Cancel target file
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | -| `PROJECT.TARGET.FILE.DELETED` | [`target-file-event`](../../reference/Webhooks.v1.json/components/schemas/target-file-event) | Delete project and its tasks | Delete project and its tasks | -| `PROJECT.GROUP.PROJECT.MEMBERSHIP.CHANGE` | [`project-group-event`](../../reference/Webhooks.v1.json/components/schemas/project-group-event) | Add project to project group
Remove project from project group | Add project to project group
Remove project from project group | -| `PROJECT.ERROR.TASK.CREATED` | [`error-task-event`](../../reference/Webhooks.v1.json/components/schemas/error-task-event) | Generate error task | Generate error task | -| `PROJECT.ERROR.TASK.COMPLETED` | [`error-task-event`](../../reference/Webhooks.v1.json/components/schemas/error-task-event) | Complete error task | Complete error task | -| `PROJECT.ERROR.TASK.ACCEPTED` | [`error-task-event`](../../reference/Webhooks.v1.json/components/schemas/error-task-event) | Accept error task | Accept error task | +| `PROJECT.TASK.ACCEPTED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Accept task
Accept error task | Accept task
Accept error task | +| `PROJECT.TASK.CREATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task | Generate task | +| `PROJECT.TASK.COMPLETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Complete task | Complete task | +| `PROJECT.TASK.UPDATED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | Generate task
Accept task
Reject task
Release task
Assign task
Reassign task
Complete task | +| `PROJECT.TASK.DELETED` | [`task-event`](../../api/Webhooks.v1-fv.html#/schemas/task-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.CREATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Create project | Create project | +| `PROJECT.STARTED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project | Start project | +| `PROJECT.UPDATED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing any field
Complete project
Cancel source file
Complete target file | Start project (This event will also be emitted in addition to `PROJECT.STARTED`)
Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab
Complete project
Set project back in progress
Cancel project
Complete target file | +| `PROJECT.DELETED` | [`project-event`](../../api/Webhooks.v1-fv.html#/schemas/project-event) | Delete project | Delete project | +| `PROJECT.TEMPLATE.CREATED` | [`project-template-event`](../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template | +| `PROJECT.TEMPLATE.UPDATED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Create project template
Update project template | +| `PROJECT.TEMPLATE.DELETED` | [`project-template-event`](../../api/Webhooks.v1-fv.html#/schemas/project-template-event) | | Delete project template | +| `PROJECT.SOURCE.FILE.CREATED` | [`source-file-event`](../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Add source file to project
Attach source files to project | Add reference file to project
Add translatable file to project | +| `PROJECT.SOURCE.FILE.UPDATED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) | Update source file by changing the `name` field
Add source file version
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | Update source file by changing the `fileType` or `fileRole` fields
Add source file version via `Replace file` action
Delete source file version
Cancel source file
The project reaches the `File Type Detection` task
The project reaches the `File Format Conversion` task | +| `PROJECT.SOURCE.FILE.DELETED` | [`source-file-event`](../../api/Webhooks.v1-fv.html#/schemas/source-file-event) |Delete project and its tasks | Delete project and its tasks | +| `PROJECT.TARGET.FILE.CREATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | The project reaches the `File Format Conversion` task | The project reaches the `File Format Conversion` task | +| `PROJECT.TARGET.FILE.UPDATED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Update source file by changing the `name` field
Add target file version
Import target file version
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | Add target file version via `Upload SDLXLIFF` action
Replace target file
Delete target file version
Cancel target file
The project reaches the `File Format Conversion` task
The project reaches the `Copy Source to Target` task
The project reaches the `Machine Translation` task
The project reaches the `Bilingual Engineering` task
The project reaches the `Translation` task
The project reaches the `Linguistic Review` task
The project reaches the `Customer Review` task
The project reaches the `Implement Customer Review` task
The project reaches the `Target File Generation` task | +| `PROJECT.TARGET.FILE.DELETED` | [`target-file-event`](../../api/Webhooks.v1-fv.html#/schemas/target-file-event) | Delete project and its tasks | Delete project and its tasks | +| `PROJECT.GROUP.PROJECT.MEMBERSHIP.CHANGE` | [`project-group-event`](../../api/Webhooks.v1-fv.html#/schemas/project-group-event) | Add project to project group
Remove project from project group | Add project to project group
Remove project from project group | +| `PROJECT.ERROR.TASK.CREATED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Generate error task | Generate error task | +| `PROJECT.ERROR.TASK.COMPLETED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Complete error task | Complete error task | +| `PROJECT.ERROR.TASK.ACCEPTED` | [`error-task-event`](../../api/Webhooks.v1-fv.html#/schemas/error-task-event) | Accept error task | Accept error task | + diff --git a/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md index f5c6a97..e38f01e 100644 --- a/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md +++ b/articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md @@ -1,4 +1,4 @@ ---- +--- stoplight-id: eg4ja9nrs9wtk --- @@ -24,9 +24,9 @@ Here are the detailed steps: 2. Expand the account menu on the top right-hand corner and select **Integrations**. 3. Select the **Applications** sub-tab. 4. Select **New Application** and enter the following information: - - **Name** – Enter a unique name for your custom application. - - (Optional) **URL** – Enter your custom application URL. - - **Service User** – Select a service user from the dropdown list. To understand how service users are added in Trados Cloud Platform, check step 1 in the [Authenticate](../../docs/Service-credentials.md) topic. + - **Name** – Enter a unique name for your custom application. + - (Optional) **URL** – Enter your custom application URL. + - **Service User** – Select a service user from the dropdown list. To understand how service users are added in Trados Cloud Platform, check step 1 in the [Authenticate](../../docs/Service-credentials.md) topic. 5. Select **Add**. 6. Back in the **Applications** sub-tab, select the check box corresponding to your application. 7. Select **Edit**. @@ -71,7 +71,7 @@ The followings are true: -Remember that each time events occur, Trados Cloud Platform will call your server on a `POST` request, on the URL you configured in the Trados Cloud Platform application, and the request body will emulate the [Webhook](../../reference/Webhooks.v1.json/components/schemas/webhook) object format. +Remember that each time events occur, Trados Cloud Platform will call your server on a `POST` request, on the URL you configured in the Trados Cloud Platform application, and the request body will emulate the [Webhook](../../api/Webhooks.v1-fv.html#/schemas/webhook) object format. ## Validate the Webhook notifications @@ -103,12 +103,12 @@ checksum.update(event.getBytes(UTF_8)); long crc32Val = checksum.getValue(); //build the message -String message = transmissionTime + “|” + applicationId + “|” + webhookId + “|” + crc32Val; +String message = transmissionTime + “|” + applicationId + “|” + webhookId + “|” + crc32Val; //build PublicKey byte[] bytes = org.springframework.security.crypto.codec.Base64.decode(publicKeyAsString.getBytes()); X509EncodeKeySpec ks = new X509EncodeKeySpec(bytes); -KeyFactory kf = KeyFactory.getInstance(“RSA”); +KeyFactory kf = KeyFactory.getInstance(“RSA”); PublicKey publicKey = kf.generatePublic(ks); //verify signature @@ -197,3 +197,4 @@ The circuit breaker is triggered when 3 calls to a URL fail within a short time * `X-LC-Webhook`: Unique identifier of the webhook defined for the LC application which is the recipient of the webhook message. It can be ignored because it is not exposed in the Trados UI. * `X-LC-Region`: Region of the account of the user, which is the recipient of the webhook message. + diff --git a/articles/LCPublicAPI/toc.yml b/articles/LCPublicAPI/toc.yml index 36646ae..606b1f4 100644 --- a/articles/LCPublicAPI/toc.yml +++ b/articles/LCPublicAPI/toc.yml @@ -75,6 +75,11 @@ - name: Translation Memory import and export href: docs/translation-memory/Translation-memory-import-export.md +- name: Translations + items: + - name: Translation Memory import and export + href: docs/translations/Translations.md + - name: Custom fields href: docs/Custom-Fields.md From d71e85b6f0385636cffd5a2a5e4910914da79f28 Mon Sep 17 00:00:00 2001 From: Radu Pascal Date: Tue, 4 Nov 2025 11:27:29 +0200 Subject: [PATCH 07/19] Fix webhook documentation links and add scripts for converting contract and reference links - Updated Webhook payload documentation links from .md to .html format in Webhooks.v1.json. - Added PowerShell script (convert-contract-links.ps1) to convert markdown links in contract JSON files to HTML links, handling both .md to .html conversions and JSON reference paths. - Added PowerShell script (convert-reference-links.ps1) to convert ../reference/*.json links in markdown files to ../api/*-fv.html links, supporting both paths and components/schemas references. --- Requirements.md | 38 +++ articles/LCPublicAPI/api/Public-API.v1.json | 82 +++---- articles/LCPublicAPI/api/Webhooks.v1.json | 8 +- scripts/convert-contract-links.ps1 | 259 ++++++++++++++++++++ scripts/convert-reference-links.ps1 | 169 +++++++++++++ 5 files changed, 511 insertions(+), 45 deletions(-) create mode 100644 Requirements.md create mode 100644 scripts/convert-contract-links.ps1 create mode 100644 scripts/convert-reference-links.ps1 diff --git a/Requirements.md b/Requirements.md new file mode 100644 index 0000000..e2256e7 --- /dev/null +++ b/Requirements.md @@ -0,0 +1,38 @@ +# Requirements + +Create a powershell script (convert-reference-links.ps1) that will: + +- Find all links in markdown files in "./articles/LCPublicAPI/docs/" and for links that start with "../reference/.json/paths/" replace with: + - for links that link to operations: "../api/-fv.html#/operations/" + - for links that link to scheams: "../api/-fv.html#/schemas/" +- Current links in the markdown relative paths are not correct. those are actually referencing files from the /articles/LCPublicAPI/api + +Second powershell script (convert-contract-links.ps1) that will: + +- Find all links in markdown format (ex: `[Translation API](../docs/translations/Translations.md)`) in a provided contract file (.json file in "/articles/Extensibility/api" or "/articles/LCPublicAPI/api") and rename them to *.html +- Find all links in markdown format (ex: `[Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post)`) in the given contract (same as above) and: + - change the url to operationId using hash, example: `[Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get)` becomes `[Poll Upload Zip File](#/operations/PollUploadZipFile)` + - for schemas the path becomes `#/schemas/..` + - if the url is relative to another contract file format a full relative path, ex: `[Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get)` becomes `[Poll Upload Zip File](../../LCPublicAPI/api/Public-API.v1-fv.html#/operations/PollUploadZipFile)` + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/articles/LCPublicAPI/api/Public-API.v1.json b/articles/LCPublicAPI/api/Public-API.v1.json index 1811773..197adb5 100644 --- a/articles/LCPublicAPI/api/Public-API.v1.json +++ b/articles/LCPublicAPI/api/Public-API.v1.json @@ -1,4 +1,4 @@ -{ +{ "openapi": "3.1.0", "info": { "title": "Trados Cloud Platform API", @@ -1455,7 +1455,7 @@ "/files": { "post": { "summary": "Upload Zip File", - "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoint. Alternatively, they can be used to [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Uploads an archive containing source files in `.zip` format, which will be extracted and used during project creation.\n\nStatus of the upload operation can be tracked using the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint.\n\nOnce this Upload Zip File operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint. Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\n\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "operationId": "UploadZipFile", "requestBody": { "content": { @@ -1476,7 +1476,7 @@ } } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "parameters": [ { @@ -1714,7 +1714,7 @@ } } }, - "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) / [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis~1{operationId}/get) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "description": "This endpoint allows you to request the word count and an estimated cost for your files. \r\n\r\nUse the [Upload Zip File](#/operations/UploadZipFile) / [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoints to upload your files and get the `fileIds`. Send these `fileIds` together with the `languageProcessingRuleId` and `sourceLanguage` to receive the word count.\r\n\r\nOptionally, send the `quotingOptions` object to receive the `estimatedCosts`.\r\n\r\nUse the [Poll File Analysis](#/operations/PollFileAnalysis) endpoint to monitor the operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] @@ -1827,7 +1827,7 @@ "$ref": "#/components/parameters/fields" } ], - "description": "Monitor the [File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", + "description": "Monitor the [File Analysis](#/operations/RequestFileAnalysis) operation and receive the analysis results.\r\n\r\n> File analysis results will be available for 24 hours after generation.", "tags": [ "File" ] @@ -1918,7 +1918,7 @@ "$ref": "#/components/parameters/X-LC-Tenant" } ], - "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1source-files~1attach-files/post) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](../reference/Public-API.v1.json/paths/~1files~1analysis/post) details like word counts and estimated costs.\r\n", + "description": "Monitors the unzipping operation for a previously uploaded archive and retrieves details about the extracted files.\r\n\r\nOnce the [Upload Zip File](#/operations/UploadZipFile) operation has finished extracting the files, they can be added to the desired project using the [Attach Source Files](#/operations/AddSourceFiles) endpoint.\r\n Alternatively, they can be used to [Request File Analysis](#/operations/RequestFileAnalysis) details like word counts and estimated costs.\r\n", "tags": [ "File" ] @@ -2792,7 +2792,7 @@ "x-stoplight": { "id": "thyh9npsnqozm" }, - "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](../reference/Public-API.v1.json/paths/~1perfect-match-mappings~1{mappingId}/get) endpoint.", + "description": "For more details on the PerfectMatch feature please consult the [official documentation](https://docs.rws.com/791595/1155478/trados-enterprise---accelerate/perfectmatch-general-information).\r\n\r\nAfter creating a mapping, target files from the `matchingProjects` are automatically matched to the source files in the new project. This is a long-running background operation, and its `status` can be tracked by polling the [Get PerfectMatch Mapping](#/operations/GetPerfectMatchMapping) endpoint.", "requestBody": { "content": { "application/json": { @@ -3196,7 +3196,7 @@ } } }, - "description": "Updates a PerfectMatch batch mapping.\r\n\r\nPay special attention to how [updating works](https://languagecloud.sdl.com/lc/api-docs/updating-data-with-put).", + "description": "Updates a PerfectMatch batch mapping.\r\n\r\nPay special attention to how [updating works](../docs/Updating-data-with-PUT.html).", "x-stoplight": { "id": "k414o2pdrvauv" } @@ -3329,7 +3329,7 @@ } } }, - "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](../reference/Public-API.v1.json/paths/~1perfect-match-mappings~1{mappingId}~1batch-mappings~1{batchMappingId}~1file-mappings~1{fileMappingId}~1target-languages~1{targetLanguage}~1candidates/get) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " + "description": "Updates a PerfectMatch file mapping with an existing target file from a PerfectMatch candidate. Only valid candidates can be used to request an update.\r\n\r\nUse the [Candidates](#/operations/GetPerfectMatchCandidates) endpoint to retrieve a list of valid `fileId` and `projectId` to provide as matching data. " } }, "/perfect-match-mappings/{mappingId}/batch-mappings/{batchMappingId}/file-mappings/{fileMappingId}/file": { @@ -5581,7 +5581,7 @@ ], "summary": "Export Project Files", "operationId": "ExportProjectFiles", - "description": "Generates an asynchronous export operation. To monitor the progress until completion, use the [Poll Project Files Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}/get) endpoint. \n\nThis operation triggers the packaging of the project files into a `zip` format.", + "description": "Generates an asynchronous export operation. To monitor the progress until completion, use the [Poll Project Files Export](#/operations/ExportProjectFilesStatus) endpoint. \n\nThis operation triggers the packaging of the project files into a `zip` format.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -5693,7 +5693,7 @@ ], "summary": "Poll Project Files Export", "operationId": "ExportProjectFilesStatus", - "description": "Retrieves the state of the export operation. \n\n Once the state is marked as `done`, you can download the generated `zip` file using the following endpoint: [Download Exported Project Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports~1{exportId}~1download/get).", + "description": "Retrieves the state of the export operation. \n\n Once the state is marked as `done`, you can download the generated `zip` file using the following endpoint: [Download Exported Project Files](#/operations/DownloadFile).", "responses": { "200": { "description": "OK", @@ -5804,7 +5804,7 @@ "Project" ], "summary": "Download Exported Project Files", - "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1files~1exports/post) endpoint.", + "description": "Downloads the generated `zip` file containing the files according to initial export operation parameters. \n\nThe final ZIP file will be named using the project name. \n\n When the export operation is performed with `downloadFlat=true` and one target language specified, the resulting ZIP file name will be a combination of the project name and the target language code, as defined by the [Export Project Files](#/operations/ExportProjectFiles) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6059,7 +6059,7 @@ "Source File" ], "summary": "Add Source File", - "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) endpoint.", + "description": "Adds a source file to the project. Files can be uploaded before starting a project or after the project has started. When adding a `translatable` file after the project started, a new start project request should be performed.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n\n> Note: Zip files will be added as reference files. If you want to upload zip files, please use the [Upload Zip File](#/operations/UploadZipFile) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6091,7 +6091,7 @@ } }, "required": true, - "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.md)." + "description": "For details on how to send multipart/form-data with `properties` see this [article](../docs/How-to-multipart.html)." }, "responses": { "201": { @@ -6274,7 +6274,7 @@ "Source File" ], "summary": "Attach Source Files", - "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](../reference/Public-API.v1.json/paths/~1files/post) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](../reference/Public-API.v1.json/paths/~1files~1{fileId}/get) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", + "description": "This endpoint can only be used after files have been uploaded via the [Upload Zip File](#/operations/UploadZipFile) endpoint. It allows you to add multiple source files to a project. \n\n Each file must be individually attached by setting the `fileUrl` to the `associatedFiles.id` returned by the [Poll Upload Zip File](#/operations/PollUploadZipFile) endpoint, once the `unzipStatus` is `extracted`. \n\nIf a file is attached after the project has already been started, a new start project request must be made.\n\n> Note: The maximum character size of the sum between the `name` and the `path` fields must not exceed 255. Otherwise the request cannot be validated.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -6833,9 +6833,9 @@ } } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.md) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](../reference/Public-API.v1.json/paths/~1tasks~1{taskId}~1source-files~1{sourceFileId}/put).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint.\n\nThe [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](../reference/Public-API.v1.json/paths/~1projects~1{projectId}/get) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", + "description": "Adds a new version of the source file in [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) or native format. More information about file formats can be found on the [File formats](../docs/File-formats.html) page.\n\nThe version is added on the task represented by `taskId`. To successfully execute the add operation the task should already be assigned and accepted by a user. If the task is automatic, it's possible to add a source file version only when the status of task is `inProgress`.\n\nThe file versions added need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a source file version using an extension task, the configuration of the task must declare the `scope`'s value as \"file\".\n\nIf the file type of the new added file is different than the supported source file type, the new `fileTypeSettingsId` must be specified in the body or an update of file type should be performed after the add operation, using the [Update Source File Properties](#/operations/UpdateSourceProperties).\n\nThe value of `fileTypeSettingsId` is one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint.\n\nThe [List File Type Settings](#/operations/ListFileTypeSettings) endpoint must be called with the File Processing Configuration identifier of your project.\n\nThe File Processing Configuration of your project can be retrieved from [Get Project](#/operations/GetProject) endpoint.\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation. \n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when adding files.\n", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -7147,7 +7147,7 @@ } } }, - "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](../reference/Public-API.v1.json/paths/~1file-processing-configurations~1{fileProcessingConfigurationId}~1file-type-settings/get) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](../reference/Public-API.v1.json/paths/~1file-processing-configurations/get) endpoint.", + "description": "Updates the properties of the source file.\n\n\nThe value of `fileTypeSettingsId` should be one of the identifiers listed by the [List File Type Settings](#/operations/ListFileTypeSettings) endpoint called with an identifier of a File Processing Configuration that exists on the project. The list of File Processing Configurations from a project can be retrieved by using the [List File Processing Configurations](#/operations/ListFileProcessingConfigurations) endpoint.", "requestBody": { "content": { "application/json": { @@ -7824,7 +7824,7 @@ "Target File" ], "summary": "Export Target File Version", - "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1{fileVersionId}~1exports~1{exportId}/get) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Generates an asynchronous export operation. Use the [Get Target File Version Export](#/operations/PollTargetFileVersionExport) endpoint to poll until the export is completed. Used only for [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file versions.\n\nThis operation triggers a conversion of the BCM target file version in a native or SDLXLIFF format, based on the value of the `format` query parameter used.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8261,7 +8261,7 @@ "Target File" ], "summary": "Import Target File Version", - "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports~1{importId}/get) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Generates an asynchronous import operation. Use [Poll Target File Version Import endpoint](#/operations/PollTargetFileVersionImport) to poll until the import is completed. Only `sdlxliff` files can be imported.\n\nImport should be used when a file is downloaded as an `sdlxliff`, processed and then, replaced. \nThe import operation triggers internally the update of the [BCM](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html) file associated with the imported file. It should mostly be used for offline work.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8289,7 +8289,7 @@ } }, "required": true, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "responses": { "200": { @@ -8598,9 +8598,9 @@ } } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1target-files~1{targetFileId}~1versions~1imports/post). More information about file formats can be found on the [File formats](../docs/File-formats.md) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", + "description": "Adds a new version of the target file. Only the `native` and `bcm` file formats are accepted. For the `sdlxliff` files, you should use the [Import Target File endpoint](#/operations/ImportTargetFileVersion). More information about file formats can be found on the [File formats](../docs/File-formats.html) page. Additional details on BCM files can be found [here](https://developers.rws.com/languagecloud-api-docs/articles/BCM.NET_client_API.html).\n\nThe version is added on the task represented by `taskId`. To be able to execute the add operation the task should be assigned and accepted by user. If the task is automatic, it is possible to add a target file version only if the status is `inProgress`.\n\nThe added file versions need to respect the output file type declared by the task type of the enclosing task. On the [Rules for sequencing tasks correctly](https://docs.rws.com/791595/885137/trados-enterprise/rules-for-sequencing-tasks-correctly) page from the official RWS Documentation Center, you can find out what output file type is supported by each task.\n\nFor adding a target file version using an extension task, the configuration of the task type must declare the `scope`'s value as \"file\".\n\nThe multipart parameters in the body should respect and strictly follow the order specified in our documentation.\n\nConsider the [file and project size limit](https://docs.rws.com/791595/815967/trados-enterprise---accelerate/file-and-project-size-limit) when uploading files.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8808,7 +8808,7 @@ } } }, - "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/get) to check when the export is completed.

\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.", + "description": "Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the [polling endpoint](#/operations/PollQuoteReportExport) to check when the export is completed.

\nBuilt-in quotes are only available in the same languages as the user interface. See [this page](https://docs.rws.com/791595/1084405/trados-enterprise---accelerate/ui-languages) for more information.
\nCustomers who use non-default quote templates are responsible for the implementation of a suitable localization approach.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -8916,7 +8916,7 @@ } } }, - "description": "Polls a quote report via an export operation. The quote report can be [downloaded](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1download/get) once the status is \"completed\". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.", + "description": "Polls a quote report via an export operation. The quote report can be [downloaded](#/operations/DownloadQuoteReport) once the status is \"completed\". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried.\n\nIf the `exportId` query parameter is not provided, the polling action will return the status for the last generated export.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9028,7 +9028,7 @@ } } }, - "description": "Downloads a quote report generated by the [asynchronous export operation](../reference/Public-API.v1.json/paths/~1projects~1{projectId}~1quote-report~1export/post). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", + "description": "Downloads a quote report generated by the [asynchronous export operation](#/operations/ExportQuoteReport). \n\nIf the `exportId` query parameter is not provided, the last generated export quote will be downloaded.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9662,7 +9662,7 @@ "Project Group" ], "summary": "Add Projects To Group", - "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", + "description": "Adds projects to the project group.\n\nThe projects are not added instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -9783,7 +9783,7 @@ "Project Group" ], "summary": "Remove Projects From Group", - "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](../reference/Public-API.v1.json/paths/~1project-groups~1{projectGroupId}/get) endpoint.", + "description": "Removes projects from the project group.\n\nThe projects are not removed instantly. To check the status use the [Get Project Group](#/operations/GetProjectGroup) endpoint.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -13094,7 +13094,7 @@ } } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "tags": [ "Termbase Template" @@ -14222,7 +14222,7 @@ "$ref": "#/components/parameters/fields" } ], - "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.md#creating-a-termbase-entry).", + "description": "Creates a new termbase entry. For more information about how to use `fieldValueLinks` see [`Create termbase entry`](../docs/termbase/Termbase-entries.html#creating-a-termbase-entry).", "requestBody": { "content": { "application/json": { @@ -14841,7 +14841,7 @@ } } }, - "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](../reference/Public-API.v1.json/paths/~1termbases~1{termbaseId}~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", + "description": "Generates an asynchronous export operation.
\nUse the [Poll Export Termbase](#/operations/PollExportTermbase) endpoint to poll until the export status is `done`.", "tags": [ "Termbase Export" ] @@ -15470,7 +15470,7 @@ "examples": {} } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, "description": "Generates an asynchronous import operation.
\nUse the Poll Import Termbase endpoint to poll until the import status is `done`.
", "tags": [ @@ -16022,7 +16022,7 @@ } } }, - "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.md).", + "description": "Updates a Translation Memory. We recommend reading this page too [Updating data with PUT](../docs/Updating-data-with-PUT.html).", "requestBody": { "content": { "application/json": { @@ -16901,9 +16901,9 @@ "examples": {} } }, - "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.md)." + "description": "For details on multipart requests please see [this article](../docs/How-to-multipart.html)." }, - "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](../reference/Public-API.v1.json/paths/~1translation-memory~1imports~1{importId}/get).", + "description": "Generates an asynchronous import operation. \n
\n
Read more about prerequisites and limitations on the [official documentation center](https://docs.rws.com/791595/741139/trados-enterprise/importing-tm-content).\n
\nNote: The order of the multipart form parameter must be implemented as such: properties first, file second.\n
\nUse the Poll Translation Memory Import endpoint to poll until the import status is `done`.
\nTo track the progress of the import please refer to [Poll Translation Memory Import](#/operations/PollTMImport).", "tags": [ "Translation Memory Import" ] @@ -17109,7 +17109,7 @@ } } }, - "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](../reference/Public-API.v1.json/paths/~1translation-memory~1exports~1{exportId}/get) endpoint to poll until the export status is `done`.", + "description": "Generates an asynchronous export operation.\nUse the [Poll Translation Memory Export](#/operations/PollTranslationMemoryExport) endpoint to poll until the export status is `done`.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -17420,7 +17420,7 @@ "tags": [ "Translation" ], - "description": "Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "description": "Translates a phrase in plain text or a BCM fragment containing a single segment. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "requestBody": { "content": { "application/json": { @@ -17532,7 +17532,7 @@ "x-stoplight": { "id": "w7q4r8d7hum33" }, - "description": "Performs a concordance search for a given text within the TM linked to the specified translation engine. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "description": "Performs a concordance search for a given text within the TM linked to the specified translation engine. The translated content will be returned as a BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html) or [term](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Skeleton.Term.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "requestBody": { "content": { "application/json": { @@ -17644,7 +17644,7 @@ "x-stoplight": { "id": "pyjdd2h02zm8z" }, - "description": "Updates a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "description": "Updates a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -17749,7 +17749,7 @@ } }, "operationId": "TranslationsAdd", - "description": "Adds a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.md) page.", + "description": "Adds a translation unit. The system identifies matching translation units in the TM based on the provided BCM [fragment](https://developers.rws.com/languagecloud-api-docs/api/bcm/Sdl.Core.Bcm.BcmModel.Fragment.html). \n\n For detailed concepts and examples see the [Translation API](../docs/translations/Translations.html) page.", "parameters": [ { "$ref": "#/components/parameters/Authorization" @@ -32135,4 +32135,4 @@ } } } -} \ No newline at end of file +} diff --git a/articles/LCPublicAPI/api/Webhooks.v1.json b/articles/LCPublicAPI/api/Webhooks.v1.json index dfd877e..4697497 100644 --- a/articles/LCPublicAPI/api/Webhooks.v1.json +++ b/articles/LCPublicAPI/api/Webhooks.v1.json @@ -1,4 +1,4 @@ -{ +{ "openapi": "3.1.0", "info": { "title": "Webhooks", @@ -628,7 +628,7 @@ "webhook": { "title": "Webhook", "type": "object", - "description": "For correlation between `eventType` and `data`, please check the [Webhook Payload](../docs/webhooks/Webhooks-payload.md) page.", + "description": "For correlation between `eventType` and `data`, please check the [Webhook Payload](../docs/webhooks/Webhooks-payload.html) page.", "properties": { "eventId": { "type": "string", @@ -737,7 +737,7 @@ }, "items": { "$ref": "#/components/schemas/webhook", - "description": "For correlation between `eventType` and `data`, please check the [Webhook Payload](../docs/webhooks/Webhooks-payload.md) page.", + "description": "For correlation between `eventType` and `data`, please check the [Webhook Payload](../docs/webhooks/Webhooks-payload.html) page.", "x-stoplight": { "id": "6ff5pybiu7n07" } @@ -747,4 +747,4 @@ } } } -} \ No newline at end of file +} diff --git a/scripts/convert-contract-links.ps1 b/scripts/convert-contract-links.ps1 new file mode 100644 index 0000000..56ef915 --- /dev/null +++ b/scripts/convert-contract-links.ps1 @@ -0,0 +1,259 @@ +<# +Convert markdown links inside contract JSON files. + +Behavior: +- If a markdown link points to a .md file, replace the url to .html (literal change). +- If a markdown link points to a reference or api JSON path like + ../reference/Public-API.v1.json/paths/~1files~1{fileId}/get or ../api/Public-API.v1.json/components/schemas/foo + then replace the URL with either a local fragment (#/operations/... or #/schemas/...) when the referenced contract is the same file, + or with a full relative path to the referenced contract HTML (e.g. ../../LCPublicAPI/api/Public-API.v1-fv.html#/operations/OpId) + +Usage: +.\scripts\convert-contract-links.ps1 -Contract [-Root ] [-Force] +If -Contract is omitted the script will process all *.json files under +articles/Extensibility/api and articles/LCPublicAPI/api. + +Preview runs by default; add -Force to write changes. +#> + +param( + [string]$Contract, + [string]$Root = (Get-Location).Path, + [switch]$Force +) + +Write-Host "Root: $Root" + +# ensure $Root is a single string (some callers may pass arrays) +if ($Root -is [array]) { $Root = $Root[0] } + +function Resolve-ReferencedJsonFile { + param( + [string]$referencedFileName, + [string]$currentDir, + [string]$root + ) + + # Candidate locations relative to current file and repo + $candidates = @() + $candidates += Join-Path $currentDir "..\reference\$referencedFileName" + $candidates += Join-Path $currentDir "..\api\$referencedFileName" + $candidates += Join-Path $root "articles\LCPublicAPI\api\$referencedFileName" + $candidates += Join-Path $root "articles\Extensibility\api\$referencedFileName" + + foreach ($c in $candidates) { + try { + $p = Resolve-Path -Path $c -ErrorAction Stop + if ($p) { return $p.Path } + } catch { } + } + + return $null +} + +function Get-JsonPointerPath { + param([string]$pointer) + # pointer segments are separated by /; ~1 -> /, ~0 -> ~ + $seg = $pointer -split '/' + $decoded = ($seg | ForEach-Object { $_ -replace '~1', '/' -replace '~0','~' }) -join '/' + return $decoded +} + +function Get-OperationIdFromJson { + param( + [object]$jsonObj, + [string]$jsonPointer, + [string]$method + ) + # $jsonPointer is like 'paths/~1files~1{fileId}~1versions~1{fileVersionId}~1download' + $pathKey = $jsonPointer -replace '^paths/','' + # decode ~1 and ~0 + $pathKeyDecoded = ($pathKey -split '/').ForEach({ $_ -replace '~1','/' -replace '~0','~' }) -join '/' + if ($jsonObj.paths -and $jsonObj.paths.PSObject.Properties.Name -contains $pathKeyDecoded) { + $pathObj = $jsonObj.paths.$($pathKeyDecoded) + if ($null -ne $pathObj) { + $methodLower = $method.ToLower() + if ($pathObj.PSObject.Properties.Name -contains $methodLower) { + $op = $pathObj.$methodLower.operationId + if ($op) { return $op } + } + } + } + return $null +} + +function Get-SchemaNameFromJsonPointer { + param([string]$pointer) + # pointer like components/schemas/MySchema + if ($pointer -match '^components/schemas/(.+)$') { return $Matches[1] } + return $null +} + +if ($Contract) { + $contractFiles = @((Resolve-Path -Path $Contract).Path) +} else { + $dirs = @( + "$Root\articles\Extensibility\api", + "$Root\articles\LCPublicAPI\api" + ) + $contractFiles = @() + foreach ($d in $dirs) { + if (Test-Path $d) { + $contractFiles += Get-ChildItem -Path $d -Filter '*.json' -File -Recurse | Select-Object -ExpandProperty FullName + } + } +} + +if (-not $contractFiles -or $contractFiles.Count -eq 0) { + Write-Error "No contract files found to process. Provide -Contract or ensure API folders exist under articles/." + exit 1 +} + +$report = @() + +foreach ($cf in $contractFiles) { + Write-Host "Processing: $cf" + $origContent = Get-Content -Raw -Path $cf -Encoding UTF8 + $newContent = $origContent + $currentDir = Split-Path -Path $cf -Parent + $jsonObj = $null + try { $jsonObj = $origContent | ConvertFrom-Json -ErrorAction Stop } catch { } + + # find markdown links [text](url) + $linkPattern = '\[([^\]]+)\]\(([^)]+)\)' + $linkMatches = [regex]::Matches($origContent, $linkPattern) + foreach ($m in $linkMatches) { + $fullMatch = $m.Value + $text = $m.Groups[1].Value + $url = $m.Groups[2].Value + + # Skip absolute URLs (http, https, mailto) + if ($url -match '^(https?:|mailto:|#)') { continue } + + $newUrl = $null + + # Case 1: .md -> .html + if ($url -match '\.md(\#.*)?$') { + $newUrl = $url -replace '\.md(\#.*)?$','.html$1' + $report += [pscustomobject]@{ File = $cf; Old = $url; New = $newUrl; Reason = '.md -> .html' } + } + + # Case 2: reference or api JSON paths + elseif ($url -match '^(?:\.\./)?(?:reference|api)/(?[^/]+\.json)/(?.+)$') { + $refFile = $Matches['file'] + $rest = $Matches['rest'] + + # locate referenced json file on disk + $resolved = Resolve-ReferencedJsonFile -referencedFileName $refFile -currentDir $currentDir -root $Root + if (-not $resolved) { + Write-Warning "Referenced JSON not found: $refFile (in $cf)" + continue + } + + # load referenced json object + try { + $refJsonText = Get-Content -Raw -Path $resolved -Encoding UTF8 + $refObj = $refJsonText | ConvertFrom-Json -ErrorAction Stop + } catch { + Write-Warning "Failed to parse referenced JSON: $resolved" + continue + } + + # determine if referenced file is the same as current contract + $isLocalContract = ($resolved -eq (Resolve-Path -Path $cf).Path) + + if ($rest -like 'paths/*') { + # rest format: paths/~1something~1foo/post + $parts = $rest -split '/' + # last segment is method + $method = $parts[-1] + $pointer = ($parts[0..($parts.Length-2)] -join '/') + + # try to get operationId + $opId = Get-OperationIdFromJson -jsonObj $refObj -jsonPointer $pointer -method $method + if (-not $opId) { + Write-Warning "OperationId not found for $url in $resolved" + continue + } + + if ($isLocalContract) { + $newUrl = "#/operations/$opId" + } else { + # compute relative path from current file to referenced file's folder + $refDir = Split-Path -Path $resolved -Parent + $refHtmlFile = [System.IO.Path]::Combine($refDir, ([System.IO.Path]::GetFileNameWithoutExtension($refFile) + '-fv.html')) + # create a relative path using URI trick + $fromUri = (Get-Item $currentDir).FullName.TrimEnd('\') + '\' + $toUri = (Get-Item $refHtmlFile).FullName + $uriFrom = New-Object System.Uri($fromUri) + $uriTo = New-Object System.Uri($toUri) + $rel = $uriFrom.MakeRelativeUri($uriTo).ToString() -replace '/','\' + # convert Windows backslashes to forward slashes for markdown + $rel = $rel -replace '\\','/' + $newUrl = "$rel#\/operations\/$opId" + # remove escapes inserted above + $newUrl = $newUrl -replace '\\/', '/' + } + + $report += [pscustomobject]@{ File = $cf; Old = $url; New = $newUrl; Reason = 'paths -> operationId' } + } + + elseif ($rest -like 'components/schemas/*') { + $schema = $rest -replace '^components/schemas/','' + if ($isLocalContract) { + $newUrl = "#/schemas/$schema" + } else { + $refDir = Split-Path -Path $resolved -Parent + $refHtmlFile = [System.IO.Path]::Combine($refDir, ([System.IO.Path]::GetFileNameWithoutExtension($refFile) + '-fv.html')) + $fromUri = (Get-Item $currentDir).FullName.TrimEnd('\') + '\' + $toUri = (Get-Item $refHtmlFile).FullName + $uriFrom = New-Object System.Uri($fromUri) + $uriTo = New-Object System.Uri($toUri) + $rel = $uriFrom.MakeRelativeUri($uriTo).ToString() -replace '/','\\' + $rel = $rel -replace '\\','/' + $newUrl = "$rel#\/schemas\/$schema" + $newUrl = $newUrl -replace '\\/', '/' + } + $report += [pscustomobject]@{ File = $cf; Old = $url; New = $newUrl; Reason = 'components/schemas -> schema' } + } + + else { + # Not handled pointer type + continue + } + } + + if ($newUrl) { + # literal replace the url inside the JSON content + $escapedOld = [Regex]::Escape($url) + # Replace only the exact markdown link target inside parentheses to avoid accidental replacements elsewhere + $patternFull = "(\[" + [Regex]::Escape($text) + "\]\()" + $escapedOld + "\)" + $replacement = "`$1" + $newUrl + ")" + # fallback simple replace if above fails + if ($newContent -match [regex]::Escape($fullMatch)) { + $newContent = $newContent -replace [regex]::Escape($fullMatch), "[$text]($newUrl)" + } else { + $newContent = $newContent -replace $patternFull, $replacement + } + } + } + + if ($newContent -ne $origContent) { + Write-Host "Preview (no write): $cf" + # print replacements for this file + $report | Where-Object { $_.File -eq $cf } | ForEach-Object { Write-Host " $($_.Old) -> $($_.New)" } + + if ($Force) { + Set-Content -Path $cf -Value $newContent -Encoding UTF8 + Write-Host "Wrote changes to $cf" + } + } +} + +# summary +$grouped = $report | Group-Object -Property File +foreach ($g in $grouped) { + Write-Host "File: $($g.Name) - Changes: $($g.Count)" +} + +if (-not $Force) { Write-Host "Processed $($contractFiles.Count) files. Use -Force to apply changes." } diff --git a/scripts/convert-reference-links.ps1 b/scripts/convert-reference-links.ps1 new file mode 100644 index 0000000..cd01f52 --- /dev/null +++ b/scripts/convert-reference-links.ps1 @@ -0,0 +1,169 @@ +<# +.SYNOPSIS + Convert ../reference/*.json links in markdown files to ../api/*-fv.html links. + +.DESCRIPTION + Scans all markdown files under articles/LCPublicAPI/docs and finds links that + reference JSON files under ../reference/. It converts two types of references: + + - paths -> operations: ../reference/.json/paths/~1path~1sub/get + becomes ../api/-fv.html#/operations/# + + - components/schemas -> schemas: ../reference/.json/components/schemas/ + becomes ../api/-fv.html#/schemas/# + + By default the script runs in preview mode and only prints proposed replacements. + Use -Force to apply changes to files. + +.PARAMETER Root + Root path of the repository. Defaults to the current working directory. + +.PARAMETER Force + Apply changes. If not specified the script only shows a preview. + +.EXAMPLE + # preview + .\convert-reference-links.ps1 + + # apply changes + .\convert-reference-links.ps1 -Force +#> + +param( + [string]$Root = (Get-Location).Path, + [switch]$Force +) + +Write-Host "Root: $Root" + +$docsDir = Join-Path $Root 'articles\LCPublicAPI\docs' +if (-not (Test-Path $docsDir)) { + Write-Error "Docs directory not found: $docsDir" + exit 1 +} + +$mdFiles = Get-ChildItem -Path $docsDir -Recurse -Include *.md -File +if ($mdFiles.Count -eq 0) { + Write-Host "No markdown files found under $docsDir" + exit 0 +} + +$linkPattern = '\.\./reference/(?[^/\\)]+)\.json/(?[^)\s]+)' +$regex = [regex]$linkPattern + +$summary = [System.Collections.Generic.List[psobject]]::new() + +foreach ($md in $mdFiles) { + $content = Get-Content -Raw -Path $md.FullName -ErrorAction Stop + $mMatches = $regex.Matches($content) + if ($mMatches.Count -eq 0) { continue } + + $newContent = $content + $fileChanges = [System.Collections.Generic.List[string]]::new() + + foreach ($m in $mMatches) { + $orig = $m.Value + $fileName = $m.Groups['file'].Value + $rest = $m.Groups['rest'].Value + + $newUrl = $null + + if ($rest -like 'paths/*') { + # expected format: paths// + $parts = $rest -split '/' | Where-Object { $_ -ne '' } + # remove the leading 'paths' + if ($parts.Count -lt 3) { continue } + $parts = $parts[1..($parts.Count - 1)] + $method = $parts[-1].ToLower() + $encPathParts = $parts[0..($parts.Count - 2)] + $encodedPointer = ($encPathParts -join '/') + # decode JSON Pointer escaping ~1 -> / and ~0 -> ~ + $decodedPath = $encodedPointer -replace '~1','/' -replace '~0','~' + + $refJsonPath = Join-Path $Root "articles\LCPublicAPI\reference\$fileName.json" + if (-not (Test-Path $refJsonPath)) { + # try the api folder as some sources place the json files under articles/LCPublicAPI/api + $apiJsonPath = Join-Path $Root "articles\LCPublicAPI\api\$fileName.json" + if (Test-Path $apiJsonPath) { + Write-Host "Info: using API JSON fallback: $apiJsonPath (for $fileName.json in $($md.FullName))" + $refJsonPath = $apiJsonPath + } + else { + Write-Warning "Referenced JSON not found: $refJsonPath (in $($md.FullName))" + continue + } + } + + try { + $json = Get-Content -Raw -Path $refJsonPath | ConvertFrom-Json -ErrorAction Stop + } + catch { + Write-Warning "Failed to parse JSON: $refJsonPath" + continue + } + + $pathObj = $null + if ($json.paths -and $json.paths.PSObject.Properties.Name -contains $decodedPath) { + $pathObj = $json.paths.PSObject.Properties[$decodedPath].Value + } + else { + # no exact match; try a best-effort find using replacement of '{' '}' to parameter name + $alt = $json.paths.PSObject.Properties.Name | Where-Object { $_ -replace '[{}]','' -eq ($decodedPath -replace '[{}]','') } + if ($alt) { $pathObj = $json.paths.PSObject.Properties[$alt].Value } + } + + $operationId = $null + if ($null -ne $pathObj) { + if ($pathObj.PSObject.Properties.Name -contains $method) { + $op = $pathObj.PSObject.Properties[$method].Value + if ($op -and $op.operationId) { $operationId = $op.operationId } + } + } + + if (-not $operationId) { + # fallback: create a slug-like id from method + path + $slug = ($method + '-' + ($decodedPath -replace '[^0-9A-Za-z]','-')).Trim('-') + $operationId = $slug + Write-Host "Warning: operationId not found for $fileName.json $decodedPath $method. Falling back to $operationId" + } + + # build new URL using fragment format '#/operations/' + $newUrl = "../api/$fileName-fv.html#/operations/$operationId" + } + elseif ($rest -like 'components/schemas/*') { + # schema name is the last segment + $parts = $rest -split '/' + $schema = $parts[-1] + $newUrl = "../api/$fileName-fv.html#/schemas/$schema" + } + else { + continue + } + + if ($newUrl) { + # literal replace the matched path portion to avoid regex escape issues + $newContent = $newContent.Replace($orig, $newUrl) + $fileChanges.Add("$orig -> $newUrl") + } + } + + if ($fileChanges.Count -gt 0) { + $summary.Add([pscustomobject]@{ File = $md.FullName; Changes = $fileChanges }) + if ($Force) { + Set-Content -Path $md.FullName -Value $newContent -Encoding UTF8 + Write-Host "Updated: $($md.FullName)" + } + else { + Write-Host "Preview (no write): $($md.FullName)" + foreach ($c in $fileChanges) { Write-Host " $c" } + } + } +} + +# Summary +if ($summary.Count -eq 0) { + Write-Host "No links matched the pattern." +} +else { + Write-Host "Processed $($summary.Count) files. Use -Force to apply changes." +} From 38cc86fc49d5992920438fe1549c784036163113 Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Tue, 4 Nov 2025 11:52:56 +0200 Subject: [PATCH 08/19] Push new branch --- articles/Extensibility/docs/appManagement/Approvals.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/Extensibility/docs/appManagement/Approvals.md b/articles/Extensibility/docs/appManagement/Approvals.md index b464bb0..2b1b4cc 100644 --- a/articles/Extensibility/docs/appManagement/Approvals.md +++ b/articles/Extensibility/docs/appManagement/Approvals.md @@ -8,7 +8,7 @@ stoplight-id: f0cb88dbb2089 All apps have to go through the **Approval Process** in order to achieve certain results. The **Approval Process** is our way of validating that your apps comply with the RWS Trados policies. We have a dedicated **RWS Support** team responsible for the apps validations. The support team has full rights over the registered apps. -After having registered your app in Trados, you will gain access to the comments panel within the app's details page. Here you can leave comments or questions for our **RWS Support** team. The replies received from the Support team members will be displayed in the same panel. +After having registered your app in Trados, you will gain access to the comments panel within the app's details page. Here you can leave comments or questions for our **RWS Support** team. The replies received from the Support team members will be displayed in the same panel. -![Register](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/extensibility/app-management/RegisterApp.gif?raw=true) +![Register](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/extensibility/app-management/RegisterAppDevCheckbox.gif?raw=true) Common issues that may occur during registration include: diff --git a/articles/Extensibility/docs/appManagement/Sharing.md b/articles/Extensibility/docs/appManagement/Sharing.md index aa5e268..65b6a19 100644 --- a/articles/Extensibility/docs/appManagement/Sharing.md +++ b/articles/Extensibility/docs/appManagement/Sharing.md @@ -5,6 +5,8 @@ stoplight-id: ruuiy7dsn27on # Sharing the App By default, a newly registered app is private, meaning that only the developer tenant has access to it. However, you can share your app with other tenants even if it hasn't been published yet. +A private version of a public app can also be shared prior to its publication. Please note that once the app is published, the Share button will no longer be visible. + To share the app you need to: 1. Test that it works as expected. 2. Select your app from the **My Apps** tab and click the **Share** button. diff --git a/articles/Extensibility/docs/development/App-Versioning.md b/articles/Extensibility/docs/development/App-Versioning.md index d8a4308..ed51b20 100644 --- a/articles/Extensibility/docs/development/App-Versioning.md +++ b/articles/Extensibility/docs/development/App-Versioning.md @@ -9,7 +9,7 @@ This article explains how the app versions work and how to use multiple versions ## Versions in Trados -When registering the app, the descriptor is saved in Trados as the initial version. The [descriptor](../../App-API.v1.json/paths/~1descriptor/get) includes a `version` field, which indicates the app's version. This version number should be incremented each time changes are made to the descriptor (such as endpoints or naming) to ensure Trados detects the new version. Newly detected versions are added alongside existing ones. This enables the installed instances to be associated with a particular version of the app. +When registering the app, the descriptor is saved in Trados as the initial version. The [descriptor](../../App-API.v1.json/paths/~1descriptor/get) includes a `version` field, which indicates the app's version. This version number should be incremented each time changes are made to the descriptor (such as endpoints or naming) to ensure Trados detects the new version. Only descriptors with higher version numbers are detected and added alongside existing ones. This enables the installed instances to be associated with a particular version of the app. Throughout an app's lifespan, it can be installed in various versions across different tenants. For instance, one tenant might install version 1.0.1, another 1.0.2, and a third 1.0.3. Although they expect to use the app at these particular versions, if no special actions are taken by the developer, they will probably all be using the same instance, which probably has a single implementation and does not take into consideration the expected version. diff --git a/articles/Extensibility/docs/development/Multi-Region.md b/articles/Extensibility/docs/development/Multi-Region.md index 9ede93c..1fdeb82 100644 --- a/articles/Extensibility/docs/development/Multi-Region.md +++ b/articles/Extensibility/docs/development/Multi-Region.md @@ -16,6 +16,9 @@ To enable multi-region on your app you must provide regional instances of your a Currently, the supported regions are Europe(`eu`) and Canada(`ca`). Depending on where your app is deployed you can choose either one or both of them. This will tell Trados what endpoints to invoke based on where the consumer tenant is living. + +> All instances, in all regions should provide the exact same descriptor. + ## Installing an App with Multi-Region support When a consumer installs an app, if `regionalBaseUrls` is present and same region as consumer's is available, that region will be used. @@ -33,6 +36,9 @@ The `INSTALLED` lifecycle event now includes the region information for the acco The `baseUrl` property from [descriptor](../../App-API.v1.json/paths/~1descriptor/get) remains mandatory even if you add the `regionalBaseUrls` property(which is optional). + +> The `baseUrl` in your app should stay fixed and not change based on region. When an App is registered, `baseUrl` from that initial descriptor is used for setting audience for all future authentication requests, independent of regions (it is possible to change it later, see [Changing Base URL](App-Descriptor.md#changing-base-url). + Your "multi-region descriptor" should look something like this: ```json { diff --git a/articles/Extensibility/docs/development/Preview-App-development-guide.md b/articles/Extensibility/docs/development/Preview-App-development-guide.md index f340195..0f32b31 100644 --- a/articles/Extensibility/docs/development/Preview-App-development-guide.md +++ b/articles/Extensibility/docs/development/Preview-App-development-guide.md @@ -10,7 +10,7 @@ stoplight-id: i7ib8ruwpxdxr Preview apps offer the possibility to use external preview providers within the Trados Enterprise platform. -The type of preview generated is known as "Dynamic Preview" as it can dynamically adjust depending on choices the user might make in the browser, for instance, selecting different preview sections or views from the rendered preview. The extension acts as a webserver which implements custom endpoints to serve the content to the browser. This content can be anything which the browser is able to parse and display accordingly. For more details on Dynamic Preview Concepts, please see the second section towards the end of this document. +The type of preview generated is known as "Dynamic Preview" as it can dynamically adjust depending on choices the user might make in the browser, for instance, selecting different preview sections or views from the rendered preview. The extension acts as a webserver which implements custom endpoints to serve the content to the browser. This content can be anything which the browser is able to parse and display accordingly. To build a new preview app we recommend to start by using the provided [app blueprints](https://github.com/RWS/language-cloud-extensibility/tree/main/blueprints). @@ -38,13 +38,12 @@ For example: }, "supportedFileTypes": "html", "requiredInputFiles": { - "bilingualDocument": false, - "previewPackageTemplate": false, - "nativeSourceFile": false, - "nativeTargetFile": false, - "nativeAnnotatedTargetFile": true + "bilingualDocument": true, + "previewPackageTemplate": true, + "nativeFile": true, + "nativeAnnotatedFile": true }, - "outputType": "previewUrl" + "outputType": "previewPackage" } } ] @@ -58,26 +57,18 @@ For example: - `extensionPointId` - the extension point identifier corresponding to this extensionType: **lc.previewprovider**. - `description` - the preview extension description - `configuration` - the extension configuration. - - `endpoints` - the required endpoints for the preview extension. - - `lc.previewprovider.startpreview` - the endpoint used to start the preview generation. - - `lc.previewprovider.refreshpreview` - the endpoint used to refresh the existing preview session. - - `lc.previewprovider.updatesegment` - the endpoint used to update a segment based on a BCM document fragment. - - `lc.previewprovider.endpreview` - the endpoint used to clean up any state associated with a given preview session. - - For the V2 API, they are: - - `lc.previewprovider.startpreview.v2` - - `lc.previewprovider.refreshpreview.v2` - - `lc.previewprovider.updatesegment.v2` - - `lc.previewprovider.endpreview.v2` - + - `endpoints` - the required endpoints for the preview extension, should be relative to your `baseUrl`. + - `lc.previewprovider.startpreview` - the endpoint used to start the preview generation. For ex: `/start-preview`. + - `lc.previewprovider.refreshpreview` - the endpoint used to refresh the existing preview session. For ex: `refresh-preview`. + - `lc.previewprovider.updatesegment` - the endpoint used to update a segment based on a BCM document fragment. For ex: `update-segment`. + - `lc.previewprovider.endpreview` - the endpoint used to clean up any state associated with a given preview session. For ex: `end-preview`. - `supportedFileTypes` - A list of FileTypeDefinitionIds which this app may be associated with - `requiredInputFiles` - provides details about which types of input files this extension will require for generating a preview. - `bilingualDocument` - request an endpoint for downloading a BCM document. - `previewPackageTemplate` - request an endpoint for downloading a preview Package Template. - - `nativeSourceFile` - request an endpoint for downloading a native source file. - - `nativeTargetFile` - request an endpoint for downloading a native target file. - - `nativeAnnotatedTargetFile` - request an endpoint for downloading a native annotated target file. - - `outputType` - Indicates which type of output is generated by the extension. Dynamic previews only support a URL endpoint result and thus this should be set to **previewUrl** + - `nativeFile` - request an endpoint for downloading a native file. + - `nativeAnnotatedFile` - request an endpoint for downloading a native annotated file. + - `outputType` - Indicates which type of output is generated by the extension. For v1, this can be "previewPackage" for package-based previews or "previewUrl" for dynamic URL-based previews. ### Preview App Endpoints @@ -87,18 +78,14 @@ and returns after creating the background worker which generates the actual prev If the app needs to store any state, it should associate it with this identifier. The very first call for a given session should always be _startPreview_. If other endpoints are called before this, they should return an error. -The preview content is served by the app via one or more endpoints the app implements. The content can be any format, as long as the browser hosting the preview can parse and display that content. This includes, HTML, PDF, streamed video etc. -The resulting resource identifier returned from this call should be set in the `previewResult` field of the callback response. This will be a URL pointing to the initial endpoint implementation on the extension which the Browser hosting the preview will use to retrieve the preview content. As mentioned, the preview extension can implement additional endpoints which can then be called from the hosted portion in the Browser via AJAX calls or similar. +If the app is generating a previewPackage or standalone HTML result, it should be uploaded via the URL defined in the `previewResultFileUrl` field. +The resulting resource identifier returned from this call should be set in the `previewResult` field of the callback response. -There are currently 2 versions of the Preview API supported by Extensions: +For dynamic previews (outputType: "previewUrl"), the preview content is served by the app via one or more endpoints the app implements. The content can be any format, as long as the browser hosting the preview can parse and display that content. This includes HTML, PDF, streamed video etc. The resulting URL returned from this call should be set in the `previewResult` field of the callback response. -## APIs - -### API V1 - - Examples: + Example: ```html -POST /v1/start-preview +POST https://your-app.com/start-preview ``` - The request is as follows: @@ -175,7 +162,7 @@ The request and responses (REST and Callback) are identical to the _startPreview Example: ```html -POST /v1/refresh-preview +POST https://your-app.com/refresh-preview ``` Endpoint usage: @@ -188,7 +175,7 @@ The _updateSegment_ endpoint accepts a list of BCM document fragments along with Example: ```html -POST /v1/update-segment +POST https://your-app.com/update-segment ``` - The request is as follows: @@ -246,7 +233,7 @@ The _endPreview_ endpoint is called when a given preview session associated with Example: ```html -POST /v1/end-preview +POST https://your-app.com/end-preview ``` ```json @@ -260,246 +247,11 @@ Called to indicate a preview session has terminated. Any required cleanup should Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.endpreview/post) for further details. -### API V2 - - Examples: -```html -POST /v2/start-preview -``` - -- The request is as follows: - -```json -{ - "previewSessionId": "string", - "projectId": "string", - "scope": "target", - "fileInformation": { - "name": "string", - "sourceLanguage": "string", - "targetLanguage": "string" - }, - "inputFiles": { - "bilingualDocument": {"id": "string", "version": "int", "url": "string"}, - "previewPackageTemplate": {"id": "string", "version": "int", "url": "string"}, - "nativeSourceFile": {"id": "string", "version": "int", "url": "string"}, - "nativeTargetFile": {"id": "string", "version": "int", "url": "string"}, - "nativeAnnotatedTargetFile": {"id": "string", "version": "int", "url": "string"} - }, - "callbackUrl": "string", -} -``` -- The response after setting up the background worker, would look like this: -```json -{ - "errorCode": "string", - "message": "string", - "details": [ - { - "name": "string", - "code": "string", - "value": "string" - } - ] -} -``` - -- The final result, which is sent on the callback, is shown below: - -```json -{ - "previewSessionId": "string", - "previewResult": "string", - "errors": [ - { - "errorCode": "string", - "message": "string", - "details": [ - { - "name": "string", - "code": "string", - "value": "string" - } - ] - } - ] -} -``` - -Endpoint usage: - -This endpoint is used to initiate a preview session on the app. When this endpoint is called, the app should generate the initial preview and associate it (internally, if any state is kept) - with the `previewSessionId`. - -This should be the first endpoint called for any given session - if another endpoint is called for a given session ID before this one, an error should be returned. +### Javascript Communication Protocol +The Online Editor Container communicates with the Preview Viewer iframe using the Javascript postMessage mechanism. The API is detailed below: -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.startpreview.v2/post) for further details. - -#### RefreshPreview -The _refreshPreview_ endpoint refreshes an existing preview. The mechanism for this in entirely up to the Extension implementation in that it might keep state from the initial preview generation from _startPreview_ in order to speed up the refresh. - -The request and responses (REST and Callback) are identical to the _startPreview_ endpoint. - - Example: -```html -POST /v2/refresh-preview -``` - -Endpoint usage: -This endpoint is called when a preview refresh is requested by the user. Any state the app holds from the initial preview generation may be used to speed up the refresh. - -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.refreshpreview.v2/put) for further details. - -#### UpdateSegment -The _updateSegment_ endpoint accepts a list of BCM document fragments along with their associated segment IDs. The Extension will generate and return an HTML rendered fragment for each BCM document fragment sent in this manner. - -Example: -```html -POST /v2/update-segment -``` - -- The request is as follows: - -```json -{ - "previewSessionId": "string", - "segments": [ - { - "segmentId": "string", - "fragment": {} - } - ], - "fileInformation": { - "name": "string", - "sourceLanguage": "string", - "targetLanguage": "string" - }, - "scope": "source" -} -``` -- `previewSessionId` - unique ID of current preview session. -- `segments` - an array of segments with the following details: - - `segmentId` - ID of segment being rendered. - - `fragment` - BCM document JSON fragment. -- `fileInformation` - provides information relating to the file for which the rendered HTML is being generated. -- `scope` - indicates whether the generation is happening for source or target content. - -- The response would look like this: -```json -{ - "previewSessionId": "string", - "renderedTranslations": [ - { - "html": "string", - "segmentId": "string", - "errorCode": "string" - } - ] -} -``` -- `previewSessionId` - unique ID of current preview session. -- `renderedTranslations` - an array of rendered translations with the following details: - - `html` - rendered HTML content for this segment. - - `segmentId` - ID of this segment. - - `errorCode` - Error code for this segment (App/Extension specific). - -Endpoint usage: -This endpoint is called when the user is updating one or more segments in the Editor. For each segment, the extension will render an equivalent HTML fragment based on the input BCM document fragment. - -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.updatesegment.v2/post) for further details. - -#### EndPreview -The _endPreview_ endpoint is called when a given preview session associated with the previewSessionId is finished. This is called so that the app may perform any required cleanup. - -Example: -```html -POST /v2/end-preview -``` - -```json -{ - "previewSessionId": "string" -} -``` - -Endpoint usage: -Called to indicate a preview session has terminated. Any required cleanup should be performed by the app. - -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.endpreview.v2/post) for further details. - - -## Session Management and Tenant Separation -It is up to the app to manage any session state internally and have an expiry mechanism for this. -Also, any data which is tenant specific needs to be kept separate from any other data and the app also needs to manage tenant separation concerns internally. -
-
-
- - -# Dynamic Preview Concepts - -Dynamic Preview concepts are explained a little more in this section. The Preview Container/Viewer (which hosts its content in an iframe) can dynamically update parts of the preview when the user selects different "pages" inside it via a selection mechanism, such as a drop-down or something similar. The app implements an endpoint which will initially serve the starting content and also any additional "dynamic" content requested via an AJAX call or similar. In general, the content generated dynamically will be a different rendering or view of the same BCM document content. For example, applying different XSLTs to an XML could provide such dynamic content (if the native file is XML based). It might also be different sections of the previewed document, or indeed, streamed video snippets, depending on which segments etc are selected in the previewed document. - - -Please refer also to this document before continuing: -[Preview Provider](../../docs/development/Preview-App-development-guide.md). - - -The app acts as a web server for this dynamic content. Some of the concepts around this are defined here: - -- Custom Preview Endpoint(s) - this is a custom endpoint on the app which supports TLS and which is used to serve the Initial Preview Content and the subsequent Dynamic Preview Content. Depending on the implementation, the app might specify one or more of these. -- Initial Preview Content - this is the HTML/Javascript content which is first served from the custom preview endpoint. It consists of some basic HTML and Javascript content which initializes the preview and loads an initial dynamic page. The URL for this initial call is set as the value for the "src" attribute on the iframe and is in the following format: - -```json -https://my.extension/custom-endpoint?sessionId={sessionId}&tenant={tenantId}&accessToken={hard-to-guess-access-token}&page={pageId} -``` -An example of such a URL is: - -```json -https://0ba1-212-17-60-65.ngrok.io/api/dynamic/v1/preview/endpoint?sessionId=1234567892&tenantId=12345&accessToken=a6f56954-7f55-440a-9919-160a2c4af91c&page=initial -``` - -The returned HTML/Javascript will be embedded in an iframe and there should be some Javascript mechanism to extract the access token from the current URL of the iframe and next pass it as a header in subsequent dynamic calls made from the iframe during dynamic content selection. -- Dynamic Preview Content - this is the dynamic content which is loaded based on a page selection. This can be loaded initially as part of the initialization routine of the Initial Preview Content after it checks for the hash fragment, and then also, when a user selects a given page using the page selection mechanism (via drop-down or similar). Loading the dynamic content involves making a dynamic call to the app on one of the Custom Preview Endpoints and must pass in the hash fragment as a header to the call. Mechanisms for initiating the call and updating the content might involve AJAX/JQuery or similar. -- TLS (Transport Layer Security) - the app should enable the TLS protocol on all custom endpoints. A valid certificate will be needed for this. -- Authorization/Access token - this is a hard-to-guess value which the app must generate and return as a response to the initial StartPreview request. It should be set as a hash fragment value on the returned URL. The app should provide for a TTL on this access token so that it will expire after a pre-determined time. The app should manage the TTL and any requirements around expiry of this. -- Preview Session - This is a session related to a given preview. Each session has a unique ID associated with it called "Preview Session ID" and it is sent to the app during various requests, including StartPreview. The app should use this to keep track of content related to a specific session when storing it locally. -- App storage - this could be a database or local disk-based storage etc. It is used by the app to store preview related content for specific sessions, such as files used to generate the preview, generated preview content, and any other specific data the app needs to store to work. -- Input Files - these files represent the initial data used to generate the preview. They might be a PreviewPackageTemplate, Native Source or Target files or Annotated Native Source or Target files. These files are described in more detail here: - - PreviewPackageTemplate - this file is a zip package containing different content which is used in the generation of preview content. Examples include XML, HTML, images, CSS, XSLT, Javascript etc. The content of this file is specific to the native file format used to generate the preview. - - Native File - this represents the native format which is being translated or previewed. Examples would be Word documents, Excel documents, XML documents, text documents etc. These files can be source or target, where the source represents the language which is being translated into other languages and the target represents the translated file (for example, source might be Japanese, and target might be French.) - This is a one-to-many relationship type, meaning that there is only one source language but possibly many more target languages. - - Annotated Native File - This is a native source or target file which has been annotated with special characters which encode a segment identifier in the annotation. The annotations also indicate where the segment boundaries are. These are used for segment navigation between the Editor and the Preview and for updating of segments inside the preview when content has changed in the Editor. -- Output Preview Content - The generated content is stored by the app locally and a URL is created allowing access to the stored content via a Custom Preview Endpoint on the app. In essence, the app acts like a web server. -- CORS (Cross Origin Resource Sharing) - Please see https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS . -- iframe - Please see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe. - - -## Creating a Preview Provider App - -The following steps should be considered when creating a Dynamic Preview App: - -- Add one or more custom endpoints in the PreviewController class -- Ensure the TLS security protocol is enabled on the app endpoints. A certificate from a trusted CA is required for this. -- Implement the endpoint functionality in the PreviewService class. -- Implement a mechanism for generating and storing hard-to-guess tokens with TTL support. When any of the custom endpoints are called, the TTL associated with that session's access token should be refreshed. When RefreshPreview is called, a new custom URL and access token with a new TTL should be generated. -- Implement the code to generate the preview from the initial files downloaded from the Trados Cloud Platform API. -- In the StartPreview implementation in the PreviewService class, ensure the background job is set up to call the preview generation implementation. -- Store the resulting initial files and the generated preview content from the above preview implementation locally or in a database. -- The response from the background job (StartPreview/RefreshPreview) should generate a URL as detailed in the previous section which points to the custom endpoint and includes the hard-to-guess access token as a hash fragment. This response should return the Initial Preview Content. -- Subsequent Dynamic Preview Content requests should respond with the relevant dynamic content after authorizing the access token sent in a header in the request. The header name can be decided by the app developer as it will be present in the Initial Preview Content HTML/Javascript and will be sent by the dynamic request (AJAX/JQuery etc) from there. -- If the access token has expired, the app should respond with a 401. -- Any calls to RefreshPreview should generate a new access token. -- Any calls to EndPreview should clean up all local data related to the given Preview Session ID. -- Implement a TTL on the local data. If EndPreview has not been called before the TTL expires, clean up all local data related to the given Preview Session ID. -- Implement UpdateSegment endpoint. -- Ensure UpdateSegment updates ALL dynamic pages generated by the app so that when a particular page is selected, it will have the updated content inside the segment. -- Implement a background job which cleans up sessions after a set interval. -- The TTLs associated with the access tokens and session cleanup should be configurable. - - -## Javascript API details -The Online Editor Container communicates with the Preview Viewer iframe using the Javascript postMessage mechanism. The API is detailed here in this Javascript file: -```js +```javascript "use strict"; /* Communication Protocol between the RWS Online Editor and the preview loaded into it. @@ -525,284 +277,101 @@ The Online Editor Container communicates with the Preview Viewer iframe using th } if (!window.sdlPreviewScriptIncludeGuard) { + // when the preview package gets inlined into a single html file, the script can + // get included multiple times; we use this guard to only subscribe to the events + // once + window.sdlPreviewScriptIncludeGuard = true; + //state var selectedSegmentId = ""; var segmentIdToSigCache = {}; var initialized = false; - // events ---------------------------------------------------------------------- - + // names of the events var PREVIEW_SEGMENT_SELECTED = "Preview:segmentSelected"; var PREVIEW_SHOW_MESSAGE = "Preview:showMessage"; var UE_SEGMENT_SELECTED = "UE:segmentSelected"; var UE_UPDATE_SEGMENT = "UE:updateSegment"; -} - - // communication --------------------------------------------------------------- - - function onSegmentSelectedInEditor(segmentId) { - setActiveSegment(segmentId); -} - - function onUpdateSegmentWithTranslation(payload) { - var segmentId = payload.segmentId; - var segmentSnippet = payload.snippet; - updateSegmentWithTranslation(segmentId, segmentSnippet); -} - - function onSegmentSelectedInPreview(segmentId) { - if (window.chrome && window.chrome.webview) { - window.chrome.webview.postMessage({ - "type": "selectSegment", - "segmentId": segmentId - }); - } else { - emitEvent(PREVIEW_SEGMENT_SELECTED, segmentId); - } -} - - function notifyPreviewControlToApplyInitialSelection() { - if (window.chrome && window.chrome.webview) { - window.chrome.webview.postMessage({ - "type": "applyInitialSelection" - }); - } -} - - function notifyNavigationFailure(segmentId) { - if (window.chrome && window.chrome.webview) { - window.chrome.webview.postMessage({ - "type": "cannotNavigateToSegment", - "segmentId": segmentId - }); - } - else - emitEvent(PREVIEW_SHOW_MESSAGE, "CannotNavigateToSegment"); -} - - function notifyPreviewUpdateFailure() { - emitEvent(PREVIEW_SHOW_MESSAGE, "PreviewCannotUpdate"); -} - - function emitEvent(eventName, parameter) { - window.parent.postMessage({ - "eventName": eventName, - "payload": parameter - }, '*'); -} - - // for scroll sync on side-by-side preview - if (window.chrome && window.chrome.webview) { - window.onscroll = () => window.chrome.webview.postMessage({ - "type": "windowScrolled", - "x": window.scrollX, - "y": window.scrollY - }); -} - - // segment update -------------------------------------------------------------- - - function updateSegmentWithTranslation(segmentId, segmentSnippet) { - var sigs = segmentIdToSigCache[segmentId]; - if (!sigs || !sigs.length || sigs.length > 1) { - notifyPreviewUpdateFailure(); - return; - }; - - var sigToReplace = sigs[0]; - var segmentSnippetDom = new DOMParser().parseFromString(segmentSnippet, "text/html"); - updateImagesInSnippet(segmentSnippetDom, sigToReplace); - updateFieldsInSnippet(segmentSnippetDom, sigToReplace); - sigToReplace.innerHTML = ""; - - var updatedSegment = segmentSnippetDom.getElementsByTagName("segment")[0]; - - while (updatedSegment.hasChildNodes()) { - sigToReplace.appendChild(updatedSegment.firstChild); - } -} - - function updateImagesInSnippet(segmentSnippetDom, sigToReplace) { - var snippetImgs = segmentSnippetDom.getElementsByTagName("img"); - var sigImgs = sigToReplace.getElementsByTagName("img"); - - if (snippetImgs.length > sigImgs.length) { - notifyPreviewUpdateFailure(); - return; - } - - if (snippetImgs.length > 0 && snippetImgs[0].dataset.preserveallimages) { - // object and it might have multiple images - for (let i = sigImgs.length - 1; i >= 0; i--) { - snippetImgs[0].parentElement.insertBefore(sigImgs[i], snippetImgs[0].nextSibling); - } - snippetImgs[0].remove(); - } else { - for (let i = 0; i < snippetImgs.length; i++) { - var currentImg = snippetImgs[i]; - cloneAttributes(currentImg, sigImgs[i]); - } - } -} - - function updateFieldsInSnippet(segmentSnippetDom, sigToReplace) { - - var snippetSpans = segmentSnippetDom.getElementsByTagName("span"); - - for (var i = 0; i < snippetSpans.length; i++) { - var currentSpan = snippetSpans[i]; - if (currentSpan.dataset.field) { - var fieldType = currentSpan.dataset.field; - var fieldInDom = sigToReplace.getElementsByTagName(fieldType); - - if (fieldInDom.length !== 1) { - notifyPreviewUpdateFailure(); - return; - } - - currentSpan.parentElement.insertBefore(fieldInDom[0], currentSpan); - currentSpan.remove(); - } - } -} - - function cloneAttributes(element, sourceNode) { - var attr; - var attributes = Array.prototype.slice.call(sourceNode.attributes); - while ((attr = attributes.pop())) { - element.setAttribute(attr.nodeName, attr.nodeValue); - } -} - // navigation ------------------------------------------------------------------ + document.addEventListener("DOMContentLoaded", function (event) { + /* preparations can be done here */ + }); - function setActiveSegment(segmentId) { - clearSegmentHighlight(selectedSegmentId); - selectedSegmentId = segmentId; + window.addEventListener(UE_SEGMENT_SELECTED, function (event) { + // event.detail will contain the id of the segment we need to navigate to + // the segment with this id can be highlighted and scrolled into view - highlightSegment(segmentId, "selected"); - scrollSegmentIntoView(segmentId); -} - - function highlightSegment(segmentId, className) { - var elements = segmentIdToSigCache[segmentId]; - if (!elements) { - if (initialized) notifyNavigationFailure(segmentId); - return; - } + // if the segment cannot be highlighted on the preview: + reportError("CannotNavigateToSegment"); + }); - for (var i = 0; i < elements.length; i++) { - var sig = elements[i]; - sig.setAttribute("class", className); - } -} + window.addEventListener(UE_UPDATE_SEGMENT, function(event) { + // the id of the segment being updated + var segmentId = event.detail.segmentId; - function clearSegmentHighlight(segmentId) { - if (!segmentId) return; + // the string (html snippet) returned by the segment updater + var segmentSnippet = event.detail.snippet; - var elements = segmentIdToSigCache[segmentId]; - if (!elements) return; + /* the contents of the corresponding page element can be changed + * here according to the snippet + */ - for (var i = 0; i < elements.length; i++) { - var sig = elements[i]; - sig.setAttribute("class", ""); - } + // if the update cannot be done: + reportError("PreviewCannotUpdate"); + }); } - function scrollSegmentIntoView(segmentId) { - var elements = segmentIdToSigCache[segmentId]; - if (!elements) return; +function reportError(type) { + // types currently being used are "CannotNavigateToSegment" and "PreviewCannotUpdate" + // TBD if we can support custom messages being sent in the detail attribute here - scrollIntoViewIfNeeded(elements[0]); + window.dispatchEvent(new CustomEvent( + PREVIEW_SHOW_MESSAGE, + { detail: type } + )); } - function scrollIntoViewIfNeeded(element) { - if (!element) return; - - var bottomLimit = Math.min( - document.documentElement.clientHeight, - document.body.clientHeight - ); - var rect = element.getBoundingClientRect(); - - var overTop = rect.top < 0; - var overBottom = rect.top + rect.height > bottomLimit; +function somethingWasClicked() { + // can be handler of onclick on page elements corresponding to segments - if (overTop || overBottom) { - element.scrollIntoView({ block: "center", inline: "center" }); - } -} + var previousSelection = "..."; + var segmentId = "..."; - //Finds y value of given object - function findPos(obj) { - var curtop = 0; - if (obj.offsetParent) { - do { - curtop += obj.offsetTop; - } while ((obj = obj.offsetParent)); - return [curtop]; + if (segmentId !== previousSelection) { + window.dispatchEvent(new CustomEvent( + PREVIEW_SEGMENT_SELECTED, + { detail: segmentId } // this informs the editor which segment it should navigate to + )); } - - return [curtop]; -} - - // others ---------------------------------------------------------------------- - - function onLoad() { - var sigs = document.getElementsByTagName("sig"); - segmentIdToSigCache = {}; - - for (var i = 0; i < sigs.length; ++i) { - var current = sigs[i]; - var id = current.getAttribute("data-segment-id"); - - if (id) { - current.onclick = onSigClick; - current.onmouseover = onSigMouseOver; - current.onmouseout = onSigMouseOut; - - if (segmentIdToSigCache[id]) { - segmentIdToSigCache[id].push(current); - } else { - segmentIdToSigCache[id] = [current]; - } - } - } - - if (selectedSegmentId) setActiveSegment(selectedSegmentId); - - notifyPreviewControlToApplyInitialSelection(); - - initialized = true; -} - function onSigClick() { - var id = this.getAttribute("data-segment-id"); - setActiveSegment(id); - onSegmentSelectedInPreview(id); -} - - function onSigMouseOver() { - var id = this.getAttribute("data-segment-id"); - if (id !== selectedSegmentId) highlightSegment(id, "highlighted"); } +``` - function onSigMouseOut() { - var id = this.getAttribute("data-segment-id"); - if (id !== selectedSegmentId) clearSegmentHighlight(id); -} +For dynamic previews, a more comprehensive Javascript API is available that handles communication via postMessage between the iframe and the Online Editor. This includes: +- Navigation between segments +- Segment updates with translation changes +- Error messaging +- Scroll synchronization for side-by-side preview +- Segment highlighting and selection +### Session Management and Tenant Separation +It is up to the app to manage any session state internally and have an expiry mechanism for this. +Also, any data which is tenant specific needs to be kept separate from any other data and the app also needs to manage tenant separation concerns internally. - // entry point - window.addEventListener("message", function (event) { - switch(event.data.eventName) { - case UE_SEGMENT_SELECTED: - onSegmentSelectedInEditor(event.data.payload); - break; - case UE_UPDATE_SEGMENT: - onUpdateSegmentWithTranslation(event.data.payload); - break; - default: - console.log("No handler for event: ", event.data.eventName); - } -}); - document.addEventListener("DOMContentLoaded", onLoad); \ No newline at end of file +### Input Files +The preview provider works with various types of input files: +- **PreviewPackageTemplate** - a zip package containing content used in preview generation (XML, HTML, images, CSS, XSLT, Javascript etc.) +- **Native File** - the native format being translated or previewed (Word, Excel, XML documents etc.) +- **Annotated Native File** - a native file annotated with special characters encoding segment identifiers and boundaries + +### Dynamic Preview Concepts (for outputType: "previewUrl") +When implementing dynamic previews: +- The app acts as a web server implementing custom endpoints +- TLS (Transport Layer Security) must be enabled on all custom endpoints +- Authorization via hard-to-guess access tokens with TTL support +- Content can be dynamically updated based on user selections +- Support for different renderings or views of the same BCM document content + +The URL format for dynamic preview endpoints: +``` +https://my.extension/custom-endpoint?sessionId={sessionId}&tenant={tenantId}&accessToken={hard-to-guess-access-token}&page={pageId} +``` \ No newline at end of file diff --git a/articles/Extensibility/docs/development/Tehnical-Requirements-And-Best-Practices.md b/articles/Extensibility/docs/development/Tehnical-Requirements-And-Best-Practices.md new file mode 100644 index 0000000..0f1e89f --- /dev/null +++ b/articles/Extensibility/docs/development/Tehnical-Requirements-And-Best-Practices.md @@ -0,0 +1,70 @@ +# Technical Requirements And Best Practices + +## Technical requirements for Apps + +Most technical requirements are driven by the app's developer. For example, CPU/Memory requirements should be decided by the developer after taking into consideration the particular functionality of the app and its expected load. + +For reference, a typical machine translation app built on the .NET Core Blueprint, which adapts a third party translation engine, with 250,000 transactions per month, only requires very minimal hardware resources, with 0.1 CPU and 500 MB RAM. + +But there are certain aspects that still need to be covered to ensure secure and resilient operations. + +## Framework + +Apps can be developed using any framework, but we provide two blueprints to help you get started: one for .NET Core 8 and the other for Java. + +## Redundancy + +A load balanced, two instance deployment is recommended to ensure there are no interruptions in operation in case of failures, or more importantly, no downtime when a new version is deployed (by using rolling deployments). + +This recommended setup can be easily achieved if the application is deployed on a cloud platform. + +## Security +All communication should be secured against interfering and eavesdropping. This includes the communication between the Trados platform and the App, and also between the app and the resources it uses: third party Machine Translation Engines, databases and other resources. + +Trados uses two mechanisms to secure the apps communication: +- HTTPS support is mandatory, and Trados will not communicate with the app over an unsecured HTTP channel, or via a channel with expired or invalid certificates. +- The app can also validate that the caller is indeed Trados, by verifying the signature in each call with the [Public Key](https://languagecloud.sdl.com/lc/api-docs/8c6f7b35af0ea-list-public-keys) available from Trados on an HTTPS endpoint. + +An additional security mechanism used by Trados is signing the request body. This provides an extra layer of validation, but it can also be used in case the application gets compromised, and an analysis is required to identify which messages are authentic and which aren't. For that, all incoming messages need to be logged or audited in some form. + +By following these guidelines, app developers can ensure that their code is secure and resistant to attacks, protecting sensitive data and maintaining the confidentiality, integrity, and availability of their applications, while also staying aware of and addressing any potential vulnerabilities in their dependencies: + +- Input Validation: Always validate user inputs to ensure they are within the expected range and format. This helps to prevent injection attacks such as SQL injection or Cross-Site Scripting (XSS). +- Secure Configuration: Configure your app securely by avoiding default settings and keeping all passwords and sensitive information out of code. +- Secure Coding Practices: Follow secure coding practices such as avoiding hardcoded passwords, using secure coding patterns and libraries, and avoiding dynamic code execution. +- Access Control: Ensure that access controls are in place to prevent unauthorized access to sensitive data or functions within the application. +- Error Handling: Implement proper error handling to prevent sensitive information from being exposed to attackers. +- Manage Vulnerable Dependencies: Keep track of the dependencies used in your application and regularly check for any known vulnerabilities in those dependencies. Update to the latest version of the dependency as soon as possible to reduce the risk of exploitation. + +## Logging + +Logging is required for tracking the flow of operations and for debugging any possible issues. Logging is already set up for both blueprints, but you need to adjust the template of the logs and their destinations. + +Important components in the logs, already present in the blueprints, include: +- timestamp - this should have a timezone, to avoid any confusion of whether it's local time or UTC. +- trace id - each request sent from Trados contains a trace id which can be used to track a complete flow. This is also propagated in the code from the moment a request is performed until a response is returned. +- thread id +- host/node name - this depends on your infrastructure setup, and we recommend having it logged, especially if you have more than one instance running. +- account id +- message - an informative description of what is happening +- error and stack trace + +Do not log sensitive information in the logs, like personal identification information, API keys, incoming authentication details or signatures. + +## Metrics + +Metrics help answer questions like: +- Usage - how many/how much? +- Hardware requirements - are the currently allocated resources enough? Do we need to scale up or can we scale down to save on running costs? + +This is not a strict requirement, but it is strongly recommended to have some form of metrics set up. This should be set up in such a way to enable you to: +- Track the number of failed request/errors. +- Track the total number of transactions. +- Track the timing of the transactions/requests (this can be addressed by various metrics like `max`, `min`, `median`, `percentile`). +- Monitor CPU and Memory utilization. This should be used to correlate transactions with resource usage. + +## Error Responses + +It's important to follow the specification for the endpoints when it comes to returning error responses. Each endpoint defines a set of expected error responses and the error response model. Implementing the contract correctly allows Trados to parse the response correctly and, in some situations, to handle the error and make decisions on it. + +Endpoints can have a set of predefined error codes that Trados can interpret. One such example would be the `invalidConfiguration`. Error responses can even pinpoint further the source of the problem, in the `details` array that might indicate, for example, the actual field with the incorrect value, along with a corresponding code, for example, `invalidValue` or `nullValue`. \ No newline at end of file diff --git a/articles/Extensibility/docs/development/UI-App-custom-elements-locations.md b/articles/Extensibility/docs/development/UI-App-custom-elements-locations.md index 8b141e9..b0a5e82 100644 --- a/articles/Extensibility/docs/development/UI-App-custom-elements-locations.md +++ b/articles/Extensibility/docs/development/UI-App-custom-elements-locations.md @@ -6,7 +6,7 @@ tags: [Development] # Custom Elements and Locations The platform supports the addition of various UI elements, including **buttons** (generic, link, and dropdown) and **panels** (generic, sidebar, and tab). -These elements can be incorporated into specific sections of the user interface in the **Inbox** and **Projects** areas. +These elements can be incorporated into specific sections of the user interface in the **Inbox, Orders, Projects and Reports** areas. @@ -21,7 +21,17 @@ These elements can be incorporated into specific sections of the user interface - + + + + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + +
InboxInboxTasks list + tasks-list-tabpanel + tasks-list-tabpanel location + tab
New tasks list new-tasks-list-sidebar @@ -135,8 +145,28 @@ These elements can be incorporated into specific sections of the user interface
ProjectsProjects listOrdersOrders list + orders-list-tabpanel + orders-list-tabpanel location + tab
ProjectsProjects list + projects-list-tabpanel + projects-list-tabpanel location + tab
projects-list-toolbar projects-list-toolbar location @@ -236,6 +266,17 @@ These elements can be incorporated into specific sections of the user interface projectDetailsActiveTab, projectDetails, projectTaskHistory
ReportsReports list + reports-list-tabpanel + reports-list-tabpanel location + tab
diff --git a/articles/Extensibility/docs/development/UI-App-development-guide.md b/articles/Extensibility/docs/development/UI-App-development-guide.md index 25e991d..95447bd 100644 --- a/articles/Extensibility/docs/development/UI-App-development-guide.md +++ b/articles/Extensibility/docs/development/UI-App-development-guide.md @@ -50,7 +50,7 @@ If you don't already have Node.js installed, you can download the most recent LT ### Dependencies -- [@trados/trados-ui-extensibility](https://www.npmjs.com/package/@trados/trados-ui-extensibility) v0.1.4 +- [@trados/trados-ui-extensibility](https://www.npmjs.com/package/@trados/trados-ui-extensibility) v0.1.5 - [GitHub repository](https://github.com/RWS/trados-ui-extensibility) - [GitHub wiki](https://github.com/RWS/trados-ui-extensibility/wiki) diff --git a/articles/Extensibility/docs/development/Verification-App-development-guide.md b/articles/Extensibility/docs/development/Verification-App-development-guide.md index 6b41ea4..3019d2f 100644 --- a/articles/Extensibility/docs/development/Verification-App-development-guide.md +++ b/articles/Extensibility/docs/development/Verification-App-development-guide.md @@ -1,28 +1,31 @@ --- -stoplight-id: 0rl7inhtg6utq +stoplight-id: 9r7ku59767q11 --- # Verification Provider ## Overview + Trados provides verification functionality on translatable content (source and/or target) in several ways: + - Batch Verification Task (set in project workflows) - Editor Document Verification Task - Editor Segment-level Verification operation + The first two verification tasks validate the whole document, whereas the last operation, validates a single segment. For document validation, native verification is also possible. This allows for validation of a native file or a native annotated file. The difference between an annotated file and a non-annotated file is that the first allows for the generation of location information and the second does not. For native verification, a verification resource package may also be retrieved by the extension. This would contain ancillary files such as schemas, for example, in the case of XML validation. Trados supports a set of internal verifiers which are fixed in nature and the user can decide, through settings, what will be verified using these. Some of them are, for example: + - QA Checker - Tag Verifier + To allow for extending of the verification functionality, Trados supports the creation of extensible or external verifiers. These are hosted in apps which are essentially a self-contained serviced offering the verification functionality. Extensible verifiers would normally only support a small set of verification types, such as a target segment length check (against the length of the source) for example, or perhaps, a punctuation checker. -Each verifier will generate a set of error or warning messages based on the type of validation they perform. The user can change validation settings in the LC UI Project Settings which will affect how or when the messages are generated. External verifiers also have the option to specify resource packages in the settings which will allow the user to upload support files required during the validation process. This option is verifier specific as not all verifiers might require a package. - There are 2 types of verification which are supported by extensibility: - Bilingual Document Verification - Native File Verification @@ -31,6 +34,8 @@ There are 2 types of verification which are supported by extensibility: Native File Verification validates the native source or target file. This file might also be annotated to allow for the easy determination of segment identifiers. An example of native file verification would be schema validation on an XML file. The aim of native verification is to establish if the translation process has broken any of the document structure and rendered an invalid document. +Each verifier will generate a set of error or warning messages based on the type of validation they perform. The user can change validation settings in the LC UI Project Settings which will affect how or when the messages are generated. External verifiers also have the option to specify resource packages in the settings which will allow the user to upload support files required during the validation process. This option is verifier specific as not all verifiers might require a package. + The user can see generated verification messages in the Editor UI and can choose to ignore certain messages by message type or individually, depending on their needs. They can subsequently un-ignore them at a later stage if desired. Verifiers may also provide localized messages which can be displayed in the same language the Editor UI is presenting in. @@ -40,9 +45,7 @@ Flows: ![Verification Flow 2](https://github.com/RWS/language-cloud-public-api-doc-resources/blob/main/extensibility/verification-flow2.png?raw=true) - - -#### Notes on the above Flow Diagrams +#### Notes on the Flow Diagrams The ***StartVerification*** request initiates the background job on the extension. The background job will be responsible for generating the verification messages. @@ -57,21 +60,16 @@ The app receives a VerifyDocument request from Trados. The request specifies cer These resources are downloaded to the app via the Trados Cloud Platform API and can be stored locally during the verification operation. -When the request is received, the app responds with 201(Created) and starts a background job which will generate the verification messages. For each verification error or warning the app creates, it needs to send this back to Trados via the Trados Cloud Platform API. These messages may grouped into batches to minimize chatty behaviour between the app and the Trados Cloud Platform API. +When the request is received, the app responds with 201(Created) and starts a background job which will generate the verification messages. For each verification error or warning the app creates, it needs to send this back to Trados via the Trados Cloud Platform API. These messages may be grouped into batches to minimize chatty behavior between the app and the Trados Cloud Platform API. The app may also receive a request to verify a single segment. All interactions between the app and Trados Cloud Platform API are via REST calls. -## APIs -The extensible verifier API consists of a number of endpoints - an overview of their purpose is given here - there are currently two versions of the API - +### API Overview +The extensible verifier API consists of a number of endpoints - an overview of their purpose is given here: -### API V1 - -A verification extension defines the following in its descriptor - and specific details are shown below which are defined inside the `extensions` array +A verification extension defines the following in its descriptor: ```json -... -"extensions": [ { "extensionPointId": "lc.verificationprovider", "id": "string", @@ -88,7 +86,6 @@ A verification extension defines the following in its descriptor - and specific "validationInputType": "string", } } -] ``` The extensionPointId must always be ***"lc.verificationprovider"*** @@ -100,90 +97,11 @@ The validationInputType defines which type of validation will happen based on th The respective download URL(s) will be provided in the *StartVerification* request and the extension must download and store these resources as required. -The endpoints for V1 are: - -VerifyDocument: -```html -POST /v1/verify/document -``` -VerifySegment: -```html -POST /v1/verify/segment -``` -GetMessagesByCulture: -```html -GET /v1/messages -``` -GetSettingsSchema: -```html -GET /v1/schemas -``` - -### API V2 -The only difference between the V1 and V2 APIs is in the descriptor where the validationInputType has changed its name to validationInputFiles and its type to an array of strings in addition to versioning and the addition of the validatorType and supportedFileTypes fields - -```json -... -"extensions": [ -{ - "extensionPointId": "lc.verificationprovider", - "id": "string", - "name": "string", - "description": "string", - "extensionPointVersion": "2.0", - "configuration": { - "endpoints": { - "lc.verification.startverification.v2": "string", - "lc.verification.verifysegment.v2": "string", - "lc.verification.getmessagesbyculture.v2": "string", - "lc.verification.getsettingsschema.v2": "string" - }, - "validationInputFiles": ["string"], - "validatorType": "string", - "supportedFileTypes": ["string"]} - } -] -``` -The extensionPointId must always be `lc.verificationprovider` - -The `validationInputFiles` defines which files should be provided for the validation and can be one or more of the following, having unique entries in the array - NativeSource and NativeTarget are mutually exclusive selections: -- BilingualDocument -- NativeSource -- NativeTarget -- NativeAnnotatedTarget - -The `validatorType` defines which type of validator should be used. It can be one of the following: -- BilingualDocumentValidator -- NativeSourceValidator -- NativeTargetValidator -- NativeAnnotatedTargetValidator - -The `supportedFileTypes` field defines an array of FileTypeDefinitionIds to which this validator may be assigned to. - -The respective download URL(s) will be provided in the *StartVerification* request and the extension must download and store these resources as required. - -The endpoints for V2 are: - -VerifyDocument: -```html -POST /v2/verify/document -``` -VerifySegment: -```html -POST /v2/verify/segment -``` -GetMessagesByCulture: -```html -GET /v2/messages -``` -GetSettingsSchema: -```html -GET /v2/schemas -``` - - - -### API V1 and V2 Common +- `endpoints` - the required endpoints for the verification extension, should be relative to your `baseUrl`. + - `lc.verification.startverification` - the endpoint used to start the verification operation. For ex: `/verify/document`. + - `lc.verification.verifysegment` - the endpoint used to verify a single segment. For ex: `/verify/segment`. + - `lc.verification.getmessagesbyculture` - the endpoint used to retrieve localized messages. For ex: `/messages`. + - `lc.verification.getsettingsschema` - the endpoint used to retrieve the settings schema. For ex: `/schemas`. There are four endpoints which the extension supports: @@ -197,7 +115,12 @@ There are described in a little more detail here: ##### StartVerification This endpoint is called by Trados to initiate the document verification operation. Generally, a background job is started when this call is made and it returns 201(Created) The background job then prepares batches of verification messages which it then publishes to Trados via the Trados Cloud Platform API using the PublishMessages endpoint URL which is provided in the initial StartVerification request. Please see the API documentation for more details: -[StartVerification](../../App-API.v1.json/paths/~1lc.verification.startverification.v2~1{requestId}/post) +[StartVerification](../../App-API.v1.json/paths/~1lc.verification.startverification~1{requestId}/post) + +Example: +```html +POST https://your-app.com/verify/document +``` The request for StartVerification is shown below: @@ -304,11 +227,14 @@ Each message contains the following fields: `messageLocation` - the offsets within the segment representing the error span - - ##### VerifySegment This endpoint is called by Trados to validate an individual segment. This endpoint responds with a collection of messages which relate to any issues found for this segment. Please see the API documentation for more details: -[VerifySegment](../../App-API.v1.json/paths/~1lc.verification.verifysegment.v2/post) +[VerifySegment](../../App-API.v1.json/paths/~1lc.verification.verifysegment/post) + +Example: +```html +POST https://your-app.com/verify/segment +``` The request is structured as follows: @@ -341,11 +267,21 @@ The request is structured as follows: ##### GetMessagesByCulture This endpoint is called by Trados to retrieve localized resources for the messages. The culture is specified in the call as a URL parameter. The app can support localized resources for various languages which will allow the messages to be displayed in the native language of the user in the UI. Please see the API documentation for more details: -[GetMessagesByCulture](../../App-API.v1.json/paths/~1lc.verification.getmessagesbyculture.v2~1{culture}/get) +[GetMessagesByCulture](../../App-API.v1.json/paths/~1lc.verification.getmessagesbyculture~1{culture}/get) + +Example: +```html +GET https://your-app.com/messages/es-ES +``` ##### GetSettingsSchema -This endpoint is called by Trados to retrieve the schema related to any settings which the extension supports. **A note on schemas - once you define your settings schema for the extension, it should only be modified in a backwards compatible way, i.e. only adding of additional fields is allowed, not removing or renaming existing fields.** Please see the API documentation for more details: -[GetSettingsSchema](../../App-API.v1.json/paths/~1lc.verification.getsettingsschema.v2/get) +This endpoint is called by Trados to retrieve the schema related to any settings which the extension supports. **A note on schemas - once you define your settings schema for the extension, it should only be modified in a backwards compatible way, i.e. only adding of extra fields is allowed, not removing or renaming existing fields.** Please see the API documentation for more details: +[GetSettingsSchema](../../App-API.v1.json/paths/~1lc.verification.getsettingsschema/get) + +Example: +```html +GET https://your-app.com/schemas +``` An example schema is shown below: ```json @@ -362,6 +298,7 @@ An example schema is shown below: }, "verificationResourcePackage": { "type": "object", + "properties": { "platformSettingType": { "type": "string", "enum": [ diff --git a/articles/Extensibility/docs/development/Webhooks.md b/articles/Extensibility/docs/development/Webhooks.md index 775f56b..cd5c759 100644 --- a/articles/Extensibility/docs/development/Webhooks.md +++ b/articles/Extensibility/docs/development/Webhooks.md @@ -11,13 +11,16 @@ Apps can specify a list of webhooks that will be registered automatically when t Not all accounts have webhooks enabled. Installing of the app requiring webhooks will be disabled (grayed out in UI) on accounts that don't have webhooks enabled. + +> Webhooks require one of the following [scopes](./Trados-Cloud-API.md#scopes) to be delivered: `TENANT` or `TENANT_READ`. + ## Setup The required list of webhooks must be specified in the descriptor in the `webhooks` property. `webhooks` is an array of URLs and corresponding event types. You can specify a single URL for all webhook event types, or one URL for each event type, or any combination. This is done for maximum flexibility so you can decide if you want to ingest all webhooks through a single endpoint or have multiple endpoints maybe by event type or category, etc. -`url` can be an absolute URL or a path relative to `basePath`. +`url` can be an absolute URL or a path relative to `basePath`. Example of a `webhooks` property in the app descriptor: ```json @@ -26,7 +29,14 @@ Example of a `webhooks` property in the app descriptor: "webhooks": [ { "url": "/webhooks-endpoint", - "events": ["PROJECT.TASK.ACCEPTED", "PROJECT.TASK.CREATED"] + "evenTypes": [ + { + "eventType": "PROJECT.TASK.ACCEPTED" + }, + { + "eventType": "PROJECT.TASK.CREATED" + } + ] } ] ... From ad4fd96297d7771fa1443ec97c1beba0caf3cfc4 Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Tue, 4 Nov 2025 15:34:23 +0200 Subject: [PATCH 11/19] Update extensibility doc links to contract --- articles/Extensibility/docs/Whats-New.md | 10 +++++----- .../Extensibility/docs/appManagement/Installing.md | 4 ++-- .../Extensibility/docs/appManagement/Registering.md | 4 ++-- articles/Extensibility/docs/appManagement/Updating.md | 2 +- .../Extensibility/docs/development/App-Descriptor.md | 4 ++-- .../Extensibility/docs/development/App-Versioning.md | 4 ++-- .../Automatic-Task-App-development-guide.md | 6 +++--- .../docs/development/MT-App-development-guide.md | 6 +++--- .../Extensibility/docs/development/Multi-Region.md | 4 ++-- .../docs/development/Preview-App-development-guide.md | 10 +++++----- .../Extensibility/docs/development/Trados-Cloud-API.md | 4 ++-- .../docs/development/UI-App-development-guide.md | 6 +++--- .../development/Verification-App-development-guide.md | 8 ++++---- 13 files changed, 36 insertions(+), 36 deletions(-) diff --git a/articles/Extensibility/docs/Whats-New.md b/articles/Extensibility/docs/Whats-New.md index 4c0fb16..48a70bf 100644 --- a/articles/Extensibility/docs/Whats-New.md +++ b/articles/Extensibility/docs/Whats-New.md @@ -10,7 +10,7 @@ ## April 2025 -- To facilitate the management of large translation requests, batching support has been added for MT provider apps. This update includes the introduction of a new parameter, `extensions.configuration.segmentBatchSize`, which can be added to your [descriptor](../App-API.v1.json/paths/~1descriptor/get), along with a new error response featuring status code [413](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/413) on the translation [endpoint](../App-API.v1.json/paths/~1lc.mtprovider.translate/post). +- To facilitate the management of large translation requests, batching support has been added for MT provider apps. This update includes the introduction of a new parameter, `extensions.configuration.segmentBatchSize`, which can be added to your [descriptor](../api/Extensibility-API.v1-fv.html#/operations/descriptor), along with a new error response featuring status code [413](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Status/413) on the translation [endpoint](../api/Extensibility-API.v1-fv.html#/operations/MachineTranslationProviderTranslateBCM). - A new option has been introduced on the app registration [page](../docs/appManagement/Registering.md), allowing users to designate their app for development purposes by selecting a checkbox. ## December 2024 @@ -25,7 +25,7 @@ - With this release we deliver a new extension point designed to allow developers to extend and customize the UI elements of our platform. This extension point is being released as BETA. For more details see this [page](../docs/development/UI-App-development-guide.md). - We unified the Preview documentation pages into a single comprehensive [page](../docs/development/Preview-App-development-guide.md). We have introduced a new version, known as V2, of our Preview APIs. - We extended the information available under Verification Provider [page](../docs/development/Verification-App-development-guide.md). We have introduced a new version, known as V2, of our Verification APIs. -- You can now add comments to [Submit Task Outcome](../App-API.v1.json/paths/~1external-job~1v1~1callback/post) for the automatic task extensions. +- You can now add comments to [Submit Task Outcome](../api/Extensibility-API.v1-fv.html#/operations/automatiktasktypecallback) for the automatic task extensions. ## June 2024 - With this release, we have migrated from the Add-Ons concept to Apps. This significant first step sets the stage for expanding this concept to multiple areas that facilitate integrations. @@ -38,12 +38,12 @@ ## August 2023 -- With this release we introduced a folder identifier where the translation engines will be added. This can be used to filter the [engines](../App-API.v1.json/paths/~1lc.mtprovider.engines/get) by folder. +- With this release we introduced a folder identifier where the translation engines will be added. This can be used to filter the [engines](../api/Extensibility-API.v1-fv.html#/operations/GetMachineTranslationProviderEngines) by folder. - We also added recommendations on [best practices](../docs/development/Tehnical-Requirements-And-Best-Practices.md) for a secure application development. - We made additional smaller improvements and corrections to our documentation. ## April 2023 -- We added details for the `engineId`, `projectId`, `sourceFileId` and `targetFileId` parameters of the [Translate](../App-API.v1.json/paths/~1lc.mtprovider.translate/post) endpoint. +- We added details for the `engineId`, `projectId`, `sourceFileId` and `targetFileId` parameters of the [Translate](../api/Extensibility-API.v1-fv.html#/operations/MachineTranslationProviderTranslateBCM) endpoint. - We updated the [Registering the app](../docs/appManagement/Registering.md) page. @@ -51,7 +51,7 @@ - We introduced requirements that become mandatory for all future apps, namely: acceptance of Terms & Conditions and the Privacy Policy, along with the provisioning of the app's release notes, documentation link and the developer's contact details, starting with descriptor version `1.3`. - We published newer blueprints for both Java and .NET. - We made available headers for developers to implement custom functionality based on the current version of the installed apps: `appVersion`, `extensionPointVersion` and `extensionId`. -- Added `projectId`, `sourceFileId` and `targetFileId` on the [translate](../App-API.v1.json/paths/~1lc.mtprovider.translate/post) request. +- Added `projectId`, `sourceFileId` and `targetFileId` on the [translate](../api/Extensibility-API.v1-fv.html#/operations/MachineTranslationProviderTranslateBCM) request. ## January 2023 - We published new pages with our recommendations for implementing Dynamic Preview. diff --git a/articles/Extensibility/docs/appManagement/Installing.md b/articles/Extensibility/docs/appManagement/Installing.md index dc40d35..c258bd8 100644 --- a/articles/Extensibility/docs/appManagement/Installing.md +++ b/articles/Extensibility/docs/appManagement/Installing.md @@ -9,7 +9,7 @@ After the app is successfully registered, you can proceed to install it. The ins To install the app you need to: 1. Find your app in the **My Apps** tab and select the **Install** button. -2. When prompted with a form containing placeholders for the account settings details, remember that these are the configuration settings exposed through the [descriptor](../../App-API.v1.json/paths/~1descriptor/get). All mandatory fields will be marked with '*'. +2. When prompted with a form containing placeholders for the account settings details, remember that these are the configuration settings exposed through the [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor). All mandatory fields will be marked with '*'. 3. Pay attention if the app advertises any [scopes](../../docs/development/Authentication-Overview.md), you will be notified by the installation form. > The `baseUrl` in your app should stay fixed and not change based on region. When an App is registered, `baseUrl` from that initial descriptor is used for setting audience for all future authentication requests, independent of regions (it is possible to change it later, see [Changing Base URL](App-Descriptor.md#changing-base-url). diff --git a/articles/Extensibility/docs/development/Preview-App-development-guide.md b/articles/Extensibility/docs/development/Preview-App-development-guide.md index 0f32b31..49bc2a7 100644 --- a/articles/Extensibility/docs/development/Preview-App-development-guide.md +++ b/articles/Extensibility/docs/development/Preview-App-development-guide.md @@ -16,7 +16,7 @@ To build a new preview app we recommend to start by using the provided [app blue ## Preview App Extension -A preview app needs to define at least one preview extension within its [descriptor](../../App-API.v1.json/paths/~1descriptor/get). +A preview app needs to define at least one preview extension within its [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor). For example: ```json @@ -153,7 +153,7 @@ This endpoint is used to initiate a preview session on the app. When this endpoi This should be the first endpoint called for any given session - if another endpoint is called for a given session ID before this one, an error should be returned. -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.startpreview/post) for further details. +Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/StartPreview) for further details. #### RefreshPreview The _refreshPreview_ endpoint refreshes an existing preview. The mechanism for this in entirely up to the Extension implementation in that it might keep state from the initial preview generation from _startPreview_ in order to speed up the refresh. @@ -168,7 +168,7 @@ POST https://your-app.com/refresh-preview Endpoint usage: This endpoint is called when a preview refresh is requested by the user. Any state the app holds from the initial preview generation may be used to speed up the refresh. -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.refreshpreview/put) for further details. +Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/RefreshPreview) for further details. #### UpdateSegment The _updateSegment_ endpoint accepts a list of BCM document fragments along with their associated segment IDs. The Extension will generate and return an HTML rendered fragment for each BCM document fragment sent in this manner. @@ -226,7 +226,7 @@ POST https://your-app.com/update-segment Endpoint usage: This endpoint is called when the user is updating one or more segments in the Editor. For each segment, the extension will render an equivalent HTML fragment based on the input BCM document fragment. -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.updatesegment/post) for further details. +Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/UpdateSegment) for further details. #### EndPreview The _endPreview_ endpoint is called when a given preview session associated with the previewSessionId is finished. This is called so that the app may perform any required cleanup. @@ -245,7 +245,7 @@ POST https://your-app.com/end-preview Endpoint usage: Called to indicate a preview session has terminated. Any required cleanup should be performed by the app. -Please refer to the endpoint's [documentation](../../App-API.v1.json/paths/~1lc.preview.endpreview/post) for further details. +Please refer to the endpoint's [documentation](../../api/Extensibility-API.v1-fv.html#/operations/EndPreview) for further details. ### Javascript Communication Protocol diff --git a/articles/Extensibility/docs/development/Trados-Cloud-API.md b/articles/Extensibility/docs/development/Trados-Cloud-API.md index 0652eb8..4e6b403 100644 --- a/articles/Extensibility/docs/development/Trados-Cloud-API.md +++ b/articles/Extensibility/docs/development/Trados-Cloud-API.md @@ -8,7 +8,7 @@ Communication to Trados Cloud Platform API is also authenticated and the process ## Credentials -When an app is registered, credentials (`clientId` and `clientSecret`) are sent to the app with the `REGISTERED` lifecycle event on the [App Lifecycle endpoint](../../App-API.v1.json/paths/~1app-lifecycle/post). +When an app is registered, credentials (`clientId` and `clientSecret`) are sent to the app with the `REGISTERED` lifecycle event on the [App Lifecycle endpoint](../../api/Extensibility-API.v1-fv.html#/operations/Lifecycle). An example payload: @@ -27,7 +27,7 @@ An example payload: Here `clientId` and `clientSecret` represent the credentials for the Trados Cloud Platform API and can be used for getting a token for communicating with the Trados Cloud Platform API, as described by the [Trados Cloud Platform API documentation](https://languagecloud.sdl.com/lc/api-docs/ZG9jOjExMDcyMQ-authentication). -When an app is installed on an account, a service user will be created in Trados and an event will be sent on the [App Lifecycle endpoint](../../App-API.v1.json/paths/~1app-lifecycle/post) with event `id` being `INSTALLED`. +When an app is installed on an account, a service user will be created in Trados and an event will be sent on the [App Lifecycle endpoint](../../api/Extensibility-API.v1-fv.html#/operations/Lifecycle) with event `id` being `INSTALLED`. Account ID should always be used from the request authentication header token. This is built in in the provided blueprints. diff --git a/articles/Extensibility/docs/development/UI-App-development-guide.md b/articles/Extensibility/docs/development/UI-App-development-guide.md index 95447bd..bc080e4 100644 --- a/articles/Extensibility/docs/development/UI-App-development-guide.md +++ b/articles/Extensibility/docs/development/UI-App-development-guide.md @@ -16,7 +16,7 @@ UI extensions offer the possibility to add custom user interface elements and fu > * A UI extension's JavaScript file will be loaded in an isolated context, independent from Trados. > * The communication model between App UI and Backend will change in the final version and will have to be redesigned. -A UI extension is defined in the app [descriptor](../../App-API.v1.json/paths/\~1descriptor/get) in the `extensions` array. +A UI extension is defined in the app [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor) in the `extensions` array. ```json { @@ -40,7 +40,7 @@ A UI extension is defined in the app [descriptor](../../App-API.v1.json/paths/\~ The `extensionPointId` is always **"lc.ui"**. -The `configuration`'s `scriptPath` is the path of the JavaScript file which will be loaded in the Trados user interface. The path is relative to the `basePath` in the [descriptor](../../App-API.v1.json/paths/\~1descriptor/get). This JavaScript file contains the code describing the custom elements that will be added to the user interface and their functionality. +The `configuration`'s `scriptPath` is the path of the JavaScript file which will be loaded in the Trados user interface. The path is relative to the `basePath` in the [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor). This JavaScript file contains the code describing the custom elements that will be added to the user interface and their functionality. ## Prerequisites @@ -85,7 +85,7 @@ If you don't already have Node.js installed, you can download the most recent LT npm run build-dev ``` - - The `build` (or `build-dev`) command will create a `my-ui-extension-script.js` file in `Rws.LC.UISampleApp/Resources/frontend/dist/`. This is the path you need to use in the [descriptor](../../App-API.v1.json/paths/\~1descriptor/get) for your extension's configuration `scriptPath`, for example `Rws.LC.UISampleApp/Resources/frontend/dist/my-ui-extension-script.js`. + - The `build` (or `build-dev`) command will create a `my-ui-extension-script.js` file in `Rws.LC.UISampleApp/Resources/frontend/dist/`. This is the path you need to use in the [descriptor](../../api/Extensibility-API.v1-fv.html#/operations/descriptor) for your extension's configuration `scriptPath`, for example `Rws.LC.UISampleApp/Resources/frontend/dist/my-ui-extension-script.js`. - You can change the `my-ui-extension-script.js` file name by editing - the `module.exports`' `output.filename` property in `Rws.LC.UISampleApp/Resources/frontend/webpack.config.js` and diff --git a/articles/Extensibility/docs/development/Verification-App-development-guide.md b/articles/Extensibility/docs/development/Verification-App-development-guide.md index 3019d2f..b6a79f4 100644 --- a/articles/Extensibility/docs/development/Verification-App-development-guide.md +++ b/articles/Extensibility/docs/development/Verification-App-development-guide.md @@ -115,7 +115,7 @@ There are described in a little more detail here: ##### StartVerification This endpoint is called by Trados to initiate the document verification operation. Generally, a background job is started when this call is made and it returns 201(Created) The background job then prepares batches of verification messages which it then publishes to Trados via the Trados Cloud Platform API using the PublishMessages endpoint URL which is provided in the initial StartVerification request. Please see the API documentation for more details: -[StartVerification](../../App-API.v1.json/paths/~1lc.verification.startverification~1{requestId}/post) +[StartVerification](../../api/Extensibility-API.v1-fv.html#/operations/VerificationProviderStartVerification) Example: ```html @@ -229,7 +229,7 @@ Each message contains the following fields: ##### VerifySegment This endpoint is called by Trados to validate an individual segment. This endpoint responds with a collection of messages which relate to any issues found for this segment. Please see the API documentation for more details: -[VerifySegment](../../App-API.v1.json/paths/~1lc.verification.verifysegment/post) +[VerifySegment](../../api/Extensibility-API.v1-fv.html#/operations/VerificationProviderVerifySegment) Example: ```html @@ -267,7 +267,7 @@ The request is structured as follows: ##### GetMessagesByCulture This endpoint is called by Trados to retrieve localized resources for the messages. The culture is specified in the call as a URL parameter. The app can support localized resources for various languages which will allow the messages to be displayed in the native language of the user in the UI. Please see the API documentation for more details: -[GetMessagesByCulture](../../App-API.v1.json/paths/~1lc.verification.getmessagesbyculture~1{culture}/get) +[GetMessagesByCulture](../../api/Extensibility-API.v1-fv.html#/operations/VerificationProviderGetMessagesByCulture) Example: ```html @@ -276,7 +276,7 @@ GET https://your-app.com/messages/es-ES ##### GetSettingsSchema This endpoint is called by Trados to retrieve the schema related to any settings which the extension supports. **A note on schemas - once you define your settings schema for the extension, it should only be modified in a backwards compatible way, i.e. only adding of extra fields is allowed, not removing or renaming existing fields.** Please see the API documentation for more details: -[GetSettingsSchema](../../App-API.v1.json/paths/~1lc.verification.getsettingsschema/get) +[GetSettingsSchema](../../api/Extensibility-API.v1-fv.html#/operations/VerificationProviderGetSettingsSchema) Example: ```html From 4aa7f8c49432d7fe1439627cfde2c10d59fba537 Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Tue, 4 Nov 2025 15:47:30 +0200 Subject: [PATCH 12/19] Fix old broken linkds --- articles/Extensibility/docs/development/App-Descriptor.md | 2 +- .../docs/development/blueprints/Dot-Net-Migration-Blueprint.md | 2 +- .../docs/development/blueprints/Java-Migration-Blueprint.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/Extensibility/docs/development/App-Descriptor.md b/articles/Extensibility/docs/development/App-Descriptor.md index 50dbe86..4d22ddf 100644 --- a/articles/Extensibility/docs/development/App-Descriptor.md +++ b/articles/Extensibility/docs/development/App-Descriptor.md @@ -90,7 +90,7 @@ Any extension will have the generic set of properties: Read more on how to define the extensions for your app in our development guides: 1. Automatic Task [guide](./Automatic-Task-App-development-guide.md). 2. Machine Translation [guide](./MT-App-development-guide.md). -3. Preview [guide](./Dynamic-Preview-guide.md). +3. Preview [guide](./Preview-App-development-guide.md). ## Configuration diff --git a/articles/Extensibility/docs/development/blueprints/Dot-Net-Migration-Blueprint.md b/articles/Extensibility/docs/development/blueprints/Dot-Net-Migration-Blueprint.md index 6b235b2..e1ee3e3 100644 --- a/articles/Extensibility/docs/development/blueprints/Dot-Net-Migration-Blueprint.md +++ b/articles/Extensibility/docs/development/blueprints/Dot-Net-Migration-Blueprint.md @@ -52,7 +52,7 @@ AppRegistrationEntity appRegistration = await _appRegistrationRepository.GetRegi ClientCredentialsEntity clientCredentials = appRegistration.ClientCredentials; ``` -For more details see the [Trados Cloud Platform API guide](../Language-Cloud-API.md#Credentials). +For more details see the [Trados Cloud Platform API guide](../Trados-Cloud-API.md#credentials). ## Summary diff --git a/articles/Extensibility/docs/development/blueprints/Java-Migration-Blueprint.md b/articles/Extensibility/docs/development/blueprints/Java-Migration-Blueprint.md index 28cce76..d5fe941 100644 --- a/articles/Extensibility/docs/development/blueprints/Java-Migration-Blueprint.md +++ b/articles/Extensibility/docs/development/blueprints/Java-Migration-Blueprint.md @@ -52,7 +52,7 @@ AppRegistration entity = appRegistrationRepository.findFirst(); ClientCredentials clientCredentials = entity.getClientCredentials(); ``` -For more details see the [Trados Cloud Platform API guide](../Language-Cloud-API.md#Credentials). +For more details see the [Trados Cloud Platform API guide](../Trados-Cloud-API.md#credentials). ## Summary From 9454f24fafbd257d491fda92ae67d036b13698c8 Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Tue, 4 Nov 2025 16:11:14 +0200 Subject: [PATCH 13/19] Open extensibility API spec directly in fullscreen --- articles/Extensibility/toc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/articles/Extensibility/toc.yml b/articles/Extensibility/toc.yml index 37e3d1c..90afa12 100644 --- a/articles/Extensibility/toc.yml +++ b/articles/Extensibility/toc.yml @@ -101,4 +101,4 @@ - name: APIs items: - name: Extensibility API - href: api/Extensibility-API.v1.md \ No newline at end of file + href: api/Extensibility-API.v1-fv.html \ No newline at end of file From 13e3d6266cca608cb3144af4343f84edaa69186e Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Tue, 4 Nov 2025 16:57:11 +0200 Subject: [PATCH 14/19] Fix extensibility API internal links --- articles/Extensibility/api/Extensibility-API.v1.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/articles/Extensibility/api/Extensibility-API.v1.json b/articles/Extensibility/api/Extensibility-API.v1.json index 47b2f81..40efbe8 100644 --- a/articles/Extensibility/api/Extensibility-API.v1.json +++ b/articles/Extensibility/api/Extensibility-API.v1.json @@ -871,7 +871,7 @@ } } }, - "description": "This endpoint initiates the preview generation. It initiates an asynchronous background job to generate the preview. The timeout for this request which initiates the background job should be 10 seconds. The Response will be sent on the callbackUrl and not from this request.\n [Callback Response](App-API.v1.json/components/schemas/PreviewProvider.MainResponse)", + "description": "This endpoint initiates the preview generation. It initiates an asynchronous background job to generate the preview. The timeout for this request which initiates the background job should be 10 seconds. The Response will be sent on the callbackUrl and not from this request.\n [Callback Response](#/schemas/PreviewProvider.MainResponse)", "tags": [ "Preview Provider" ], @@ -931,7 +931,7 @@ } } }, - "description": "This endpoint refreshes the preview. This initiates an asynchronous background job to generate the preview. The timeout for this request which initiates the background job should be 10 seconds - the background job might run longer than this. The Response will be sent on the callbackUrl and not from this request. [Callback Response](App-API.v1.json/components/schemas/PreviewProvider.MainResponse)", + "description": "This endpoint refreshes the preview. This initiates an asynchronous background job to generate the preview. The timeout for this request which initiates the background job should be 10 seconds - the background job might run longer than this. The Response will be sent on the callbackUrl and not from this request. [Callback Response](#/schemas/PreviewProvider.MainResponse)", "tags": [ "Preview Provider" ], @@ -1109,7 +1109,7 @@ } } }, - "description": "This endpoint initiates the background job for verification. The background job will push messages back to the Verification Service via a publish message URL and then send an asynchronous response once the job has completed.\nThe response for the callback is given here:\n[CallbackResponse](AddOn-API.v1.json/components/schemas/VerificationProvider.MainResponse)", + "description": "This endpoint initiates the background job for verification. The background job will push messages back to the Verification Service via a publish message URL and then send an asynchronous response once the job has completed.\nThe response for the callback is given here:\n[CallbackResponse](#/schemas/VerificationProvider.MainResponse)", "security": [ { "Trados Cloud Platform JWS Token": [] From 9c998b1040b1177f5bcdeb7a8eff7308ed35c811 Mon Sep 17 00:00:00 2001 From: Mihai Dipsan Date: Wed, 5 Nov 2025 08:28:29 +0200 Subject: [PATCH 15/19] Revert navbar search icon placement and clean up CSS after merge from main --- RWSTemplate/partials/navbar.tmpl.partial | 1 + RWSTemplate/styles/docfx.css | 2 -- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/RWSTemplate/partials/navbar.tmpl.partial b/RWSTemplate/partials/navbar.tmpl.partial index 995c57a..4f18a57 100644 --- a/RWSTemplate/partials/navbar.tmpl.partial +++ b/RWSTemplate/partials/navbar.tmpl.partial @@ -14,6 +14,7 @@