{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Localisation Query", "description": "**Localisation Query API**:\n\n
Localisation Query API retrieves localisations and aggregates.\n\n
**Localisation Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/localisationquery" } ], "paths": { "/api/localisation": { "get": { "tags": [ "Localisation" ], "summary": "Get all Localisations for the client tenant without Context data.", "description": "\nThis method returns all Localisations for given tenant

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetAllLocalisations", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Localisations is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/active": { "get": { "tags": [ "Localisation" ], "summary": "Get all Localisations active version for the client tenant.", "description": "\nThis method returns all Localisations with only the active latest version for a given tenant without context data.", "operationId": "GetAllActiveLocalisations", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Localisations is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalisationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/default": { "get": { "tags": [ "Localisation" ], "summary": "Get default localisation and language", "description": "\nThis method returns the user preferred localisation or the tenant localisation for given tenant.\n It will contain all the key value pairs which will be used by fen-x ui", "operationId": "GetDefaultLocalisation", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The default localisation and its values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalisationLiteVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalisationLiteVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalisationLiteVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/{localisationId}": { "get": { "tags": [ "Localisation" ], "summary": "Get the active version of an existing Localisation by ID", "description": "\nThis method returns the active, currently in effect, published version for a given localisation

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetLocalisationById", "parameters": [ { "name": "localisationId", "in": "path", "description": "The id of the localisation to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Localisation is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/{localisationId}/version/{versionNumber}": { "get": { "tags": [ "Localisation" ], "summary": "Get a specific version of an existing Localisation", "description": "\nThis method returns the, specified by number, version for a given Localisation

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetLocalisationVersionById", "parameters": [ { "name": "localisationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Localisation is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocalisationVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/{localisationId}/version/{versionNumber}/context/{contextName}": { "get": { "tags": [ "Localisation" ], "summary": "Get the context of a specific version for an existing Localisation", "description": "\nThis method returns the, specified by number, version for a given Localisation

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetLocalisationContextByVersionAndContextName", "parameters": [ { "name": "localisationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "contextName", "in": "path", "description": "The context name to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Localisation is returned", "content": { "text/plain": { "schema": { "type": "object", "additionalProperties": { } } }, "application/json": { "schema": { "type": "object", "additionalProperties": { } } }, "text/json": { "schema": { "type": "object", "additionalProperties": { } } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/{localisationId}/version/{versionNumber}/context/{contextName}/signedUrl": { "get": { "tags": [ "Localisation" ], "summary": "Get Presigned Url of specific version of an existing Localisation context", "description": "\nThis method returns a temporary Presigned Url to view S3 file of the specified Localisation context

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetLocalisationContextSignedUrlByVersionAndContextName", "parameters": [ { "name": "localisationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "contextName", "in": "path", "description": "The context name to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Localisation's Presigned Url is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/systemLanguages": { "get": { "tags": [ "Localisation" ], "summary": "Get All Supported System Language Code", "description": "\nThis method returns the list of language codes with translations supported by Fenergo.

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetAllSystemLanguages", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of supported system language iso code is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/localisation/systemLanguage/{languageCode}": { "get": { "tags": [ "Localisation" ], "summary": "Get Presigned Url and Last Updated time of specific System Language", "description": "\nThis method returns a temporary Presigned Url to view S3 file and last updated time of system language

Required permissions:
Following permissions are required: LocalisationAccess", "operationId": "GetSystemLanguageByLanguageCode", "parameters": [ { "name": "languageCode", "in": "path", "description": "standard language iso code", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A system language's presigned url and last updated time are returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SystemLanguageDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SystemLanguageDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SystemLanguageDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Localisation with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/lookup/languageCode": { "get": { "tags": [ "Lookup" ], "summary": "Get standard language code list.", "description": "\nThis method returns BCP47 standard langage code list", "operationId": "GetLanguageCode", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LanguageCodeListDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LanguageCodeListDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageCodeListDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/userpreference": { "get": { "tags": [ "UserPreference" ], "summary": "Get user language preference.", "description": "\nThis method returns the user language preference. If the user had selected system language then the\n LanguageId will be 00000000-0000-0000-0000-000000000000", "operationId": "GetUserPreference", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A UserPreference is returned", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPreferenceDtoServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPreferenceDtoServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPreferenceDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "ContextDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of column", "nullable": true, "example": "Text name" }, "description": { "type": "string", "description": "Description of the context", "nullable": true, "example": "Translation for Chinese" }, "localisationList": { "type": "object", "additionalProperties": { }, "description": "Type of column", "nullable": true }, "displayName": { "type": "string", "description": "Display name of the context", "nullable": true, "example": "ThaiTranslation" }, "lastUpdatedTime": { "type": "string", "description": "Last updated time of context file", "format": "date-time", "example": "2022-5-25" } }, "additionalProperties": false, "description": "Defines column with metadata for localisation values" }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "LanguageCodeListDto": { "type": "object", "properties": { "languageItems": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageItemDto" }, "description": "List of language item", "nullable": true } }, "additionalProperties": false }, "LanguageCodeListDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LanguageCodeListDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "LanguageItemDto": { "type": "object", "properties": { "bcP47Tag": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "isMasterFileSupported": { "type": "boolean" }, "languageName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocalisationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Localisation Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "isDefaultLocalisation": { "type": "boolean", "description": "Flag to display if this is a System Localisation", "example": false }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/LocalisationVersionDto" }, "description": "List of available localisation versions", "nullable": true } }, "additionalProperties": false, "description": "Localisation Data" }, "LocalisationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocalisationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "LocalisationLiteVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "localisationId": { "type": "string", "description": "The UiD of the Localisation that the version belongs to", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5152" }, "localisationName": { "type": "string", "description": "Display name of the model", "nullable": true, "example": "TestLocalisation" }, "isNumberSeparatorEnabled": { "type": "boolean", "description": "The flag to show if the number separator is enabled", "example": false }, "isMasterFileEnabled": { "type": "boolean", "description": "The flag to show if master file for the language pack is enabled", "example": false }, "localisationIsoCode": { "type": "string", "description": "Display iso code of the model", "nullable": true, "example": "en" }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query", "example": true }, "localisationValuesList": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { }, "nullable": true }, "description": "Type of column", "nullable": true }, "isDefaultLocalisation": { "type": "boolean", "description": "Flag to display if this is a System Localisation", "example": false } }, "additionalProperties": false, "description": "Instance of a Localisation Version." }, "LocalisationLiteVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LocalisationLiteVersionDto" } ], "description": "Instance of a Localisation Version.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "LocalisationVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "localisationId": { "type": "string", "description": "The UiD of the Localisation that the version belongs to", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5152" }, "localisationName": { "type": "string", "description": "Display name of the model", "nullable": true, "example": "TestLocalisation" }, "isNumberSeparatorEnabled": { "type": "boolean", "description": "The flag to show if the number separator is enabled", "example": false }, "isMasterFileEnabled": { "type": "boolean", "description": "The flag to show if master file for the language pack is enabled", "example": false }, "localisationIsoCode": { "type": "string", "description": "Display iso code of the model", "nullable": true, "example": "en" }, "versionNumber": { "type": "integer", "description": "The versions number", "format": "int32", "example": 1 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "effectiveUntil": { "type": "string", "description": "The calculated date that the version ceases being active", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query", "example": true }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees for the version", "nullable": true }, "contexts": { "type": "array", "items": { "$ref": "#/components/schemas/ContextDto" }, "description": "Localisation metadata column collection", "nullable": true } }, "additionalProperties": false, "description": "Instance of a Localisation Version." }, "LocalisationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/LocalisationVersionDto" } ], "description": "Instance of a Localisation Version.", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "StringIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SystemLanguageDto": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "Language code of returned system language", "nullable": true, "example": "zh-CN" }, "lastUpdatedOn": { "type": "string", "description": "Last updated time of system language file", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "signedUrl": { "type": "string", "description": "Presigned url to request system language file", "nullable": true, "example": "text" } }, "additionalProperties": false, "description": "Defines column with metadata for localisation values" }, "SystemLanguageDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SystemLanguageDto" } ], "description": "Defines column with metadata for localisation values", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "UserPreferenceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "UserPreference Model Id", "format": "uuid" }, "userId": { "type": "string", "description": "User Id", "nullable": true }, "localisationId": { "type": "string", "description": "Selected Localisation Id", "format": "uuid" } }, "additionalProperties": false }, "UserPreferenceDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserPreferenceDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }