openapi: 3.2.0 info: title: Fenergo Localisation API version: '1.0' description: 'Operations tagged Localisation across 2 of this provider''s published API definitions: fenergo-localisationcommand-v1-0-openapi.json, fenergo-localisationquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /localisationcommand - url: /localisationquery security: - Bearer: [] tags: - name: Localisation paths: /api/localisation: post: tags: - Localisation summary: Create a new Localisation description: 'This method creates new Localisations with a first draft version. The new version initializes with the DTO data and has the default status of Draft and the Author as the only required Signee. Required permissions: Following permissions are required: LocalisationEdit' operationId: CreateLocalisation 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' '400': description: Invalid request 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 get: tags: - Localisation summary: Get all Localisations for the client tenant without Context data description: 'This 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 servers: - url: /localisationcommand /api/localisation/{localisationId}: put: tags: - Localisation summary: Update Localisations Settings description: 'Update the settings of a localisation, specifically the IsDefaultLocalisation flag. To convert to a default localisation, set IsDefaultLocalisation to (true), and to revert to a standard localisation set it to (false) This affect to all versions of a Localisation Required permissions: Following permissions are required: LocalisationEdit' operationId: UpdateLocalisation parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - 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 requestBody: description: ServiceRequest with the options content: application/json: schema: $ref: '#/components/schemas/UpdateLocalisationDto' text/json: schema: $ref: '#/components/schemas/UpdateLocalisationDto' application/*+json: schema: $ref: '#/components/schemas/UpdateLocalisationDto' responses: '202': description: Accepted for processing '400': description: Invalid request 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: Localisation with given ID does not exists 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 delete: tags: - Localisation summary: Delete Localisation and all it's versions description: 'This method deletes an existing Localisation as well as all its versions. Required permissions: Following permissions are required: LocalisationDelete' operationId: DeleteLocalisation parameters: - name: localisationId in: path description: Localisation Id required: true schema: type: string format: uuid - 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: '202': description: Accepted for processing '400': description: Invalid request 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: Localisation with given ID does not exists 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 post: tags: - Localisation summary: Create a new Version for an existing Localisation description: 'This method creates a new Localisation version. The new version initializes with the DTO data. It is assigned the next available version number, the default status of Draft and the Author as the only required Signee. Required permissions: Following permissions are required: LocalisationEdit' operationId: CreateLocalisationVersion parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - 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 requestBody: description: ServiceRequest with the new version data content: application/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/LocalisationDtoServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' application/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' text/json: schema: $ref: '#/components/schemas/LocalisationDtoServiceResponse' '400': description: Invalid request 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: Localisation with given ID does not exists 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 get: tags: - Localisation summary: Get the active version of an existing Localisation by ID description: 'This 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 servers: - url: /localisationcommand /api/localisation/{localisationId}/version/{versionNumber}: put: tags: - Localisation summary: Updates an existing Version of a Localisation description: 'This method updates an existing Localisation version. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: LocalisationEdit' operationId: UpdateLocalisationVersion parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: Number of version to update 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 requestBody: description: ServiceRequest with the updated version data content: application/json: schema: $ref: '#/components/schemas/UpdateLocalisationVersionDtoServiceRequest' text/json: schema: $ref: '#/components/schemas/UpdateLocalisationVersionDtoServiceRequest' application/*+json: schema: $ref: '#/components/schemas/UpdateLocalisationVersionDtoServiceRequest' responses: '202': description: Accepted for processing '400': description: Invalid request 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: Localisation with given ID does not exists 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 delete: tags: - Localisation summary: Delete an existing Version of a Localisation description: 'This method deletes the selected version of an existing Localisation. If the version is the last one, then the version number of it will become the next available one for the model. Otherwise, the version number will be flagged as Deleted and become unavailable. Required permissions: Following permissions are required: LocalisationDelete' operationId: DeleteLocalisationVersion parameters: - name: localisationId in: path description: Localisation Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to delete 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: '202': description: Accepted for processing '400': description: Invalid request 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: Localisation with given ID does not exists 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 get: tags: - Localisation summary: Get a specific version of an existing Localisation description: 'This 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 servers: - url: /localisationcommand /api/localisation/{localisationId}/version/{versionNumber}/submit-for-approval: put: tags: - Localisation summary: Submit an existing Version of a Localisation for Approval description: 'This method submits the selected version of an existing Localisation for Approval. Required permissions: Following permissions are required: LocalisationEdit' operationId: SubmitLocalisationVersion parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to submit 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: '202': description: Accepted for processing '400': description: Validation error 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: Localisation with given ID does not exists 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 servers: - url: /localisationcommand /api/localisation/{localisationId}/version/{versionNumber}/sign: put: tags: - Localisation summary: Sign an existing Version of a Localisation description: 'This method signs the selected version of an existing Localisation. The Status of the version changes according to the action sent (Approve/Reject). Required permissions: Following permissions are required: LocalisationApprove' operationId: SignLocalisationVersion parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to sign 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 requestBody: description: ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data content: application/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Accepted for processing content: text/plain: schema: $ref: '#/components/schemas/LocalisationVersionSignResponseServiceResponse' application/json: schema: $ref: '#/components/schemas/LocalisationVersionSignResponseServiceResponse' text/json: schema: $ref: '#/components/schemas/LocalisationVersionSignResponseServiceResponse' '400': description: Validation error 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: Localisation with given ID does not exists 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 servers: - url: /localisationcommand /api/localisation/{localisationId}/version/{versionNumber}/archive: put: tags: - Localisation summary: Archive an existing Version of a Localisation description: 'This method archives the selected version of an existing Localisation. Required permissions: Following permissions are required: LocalisationArchive' operationId: ArchiveLocalisationVersion parameters: - name: localisationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to archive 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: '202': description: Accepted for processing '400': description: Validation error 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: Localisation with given ID does not exists 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 servers: - url: /localisationcommand /api/localisation/active: get: tags: - Localisation summary: Get all Localisations active version for the client tenant description: This 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 servers: - url: /localisationquery /api/localisation/default: get: tags: - Localisation summary: Get default localisation and language description: 'This method returns the user preferred localisation or the tenant localisation for given tenant. 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 servers: - url: /localisationquery /api/localisation/{localisationId}/version/{versionNumber}/context/{contextName}: get: tags: - Localisation summary: Get the context of a specific version for an existing Localisation description: 'This 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 servers: - url: /localisationquery /api/localisation/{localisationId}/version/{versionNumber}/context/{contextName}/signedUrl: get: tags: - Localisation summary: Get Presigned Url of specific version of an existing Localisation context description: 'This 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 servers: - url: /localisationquery /api/localisation/systemLanguages: get: tags: - Localisation summary: Get All Supported System Language Code description: 'This 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 servers: - url: /localisationquery /api/localisation/systemLanguage/{languageCode}: get: tags: - Localisation summary: Get Presigned Url and Last Updated time of specific System Language description: 'This 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 servers: - url: /localisationquery components: schemas: LocalisationDto: type: object properties: localisationId: type: string description: Localisation UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 localisationIsoCode: type: - string - 'null' description: Localisation Iso Code in BCP47 standard example: en-AU versionNumber: type: integer description: The number of the model version 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' created: type: string description: The creation date of the version (Read-only) format: date-time example: '2021-12-12T15:55:00.000Z' status: $ref: '#/components/schemas/VersionStatus' isDefaultLocalisation: type: boolean description: Flag to display if this is a System Localisation. System Localisations cannot be deleted and LocalisationName cannot be updated example: false initialiseLanguageWithDefaultData: type: boolean description: Flag to initialise language with default data example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version additionalProperties: false description: Localisation representation Signee: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false LocalisationDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/LocalisationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LocalisationDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/LocalisationDto' additionalProperties: false UpdateLocalisationVersionDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/UpdateLocalisationVersionDto' additionalProperties: false UpdateLocalisationDto: type: object properties: isDefaultLocalisation: type: boolean description: '`true` to set System, Localisation `false` standard Localisation' example: true additionalProperties: false Decision: enum: - Approve - Reject type: string ApproveActionServiceRequest: type: object properties: data: $ref: '#/components/schemas/ApproveAction' additionalProperties: false ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code LocalisationVersionSignResponseServiceResponse: type: object properties: data: $ref: '#/components/schemas/LocalisationVersionSignResponse' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LocalisationVersionSignResponse: type: object properties: localisationId: type: string description: The Id of the Localisation Link the version belongs to format: uuid versionNumber: type: integer description: The number of the version that has been signed format: int32 status: $ref: '#/components/schemas/VersionStatus' additionalProperties: false description: Contains the new version Status, after a version sign operation StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false UpdateLocalisationVersionDto: type: object properties: localisationId: type: string description: Localisation UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 localisationIsoCode: type: - string - 'null' description: Localisation Iso Code in BCP47 standard example: en-AU isNumberSeparatorEnabled: type: boolean description: Flag to enable number separator example: false isMasterFileEnabled: type: boolean description: Flag to enable master file for the language pack example: false versionNumber: type: integer description: The number of the model version 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' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version additionalProperties: false description: Set of properties which define new version of Localisation ApproveAction: type: object properties: comment: type: - string - 'null' decision: $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false LocalisationDto_2: 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 - 'null' items: $ref: '#/components/schemas/LocalisationVersionDto' description: List of available localisation versions additionalProperties: false description: Localisation Data 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 - 'null' description: Display name of the model 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 - 'null' description: Display iso code of the model 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 - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-12-12T15:55:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time 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 at the time of the query' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee_2' description: The defined list of signees for the version contexts: type: - array - 'null' items: $ref: '#/components/schemas/ContextDto' description: Localisation metadata column collection additionalProperties: false description: Instance of a Localisation Version. Signee_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: 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 - 'null' description: Display name of the model 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 - 'null' description: Display iso code of the model 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 - 'null' description: The calculated date that the version ceases being active format: date-time example: '2021-12-12T15:55:00.000Z' publicationDate: type: - string - 'null' description: The date that the version got published format: date-time 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 at the time of the query' example: true localisationValuesList: type: - object - 'null' additionalProperties: type: - object - 'null' additionalProperties: {} description: Type of column isDefaultLocalisation: type: boolean description: Flag to display if this is a System Localisation example: false additionalProperties: false description: Instance of a Localisation Version. SystemLanguageDto: type: object properties: languageCode: type: - string - 'null' description: Language code of returned system language 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 - 'null' description: Presigned url to request system language file example: text additionalProperties: false description: Defines column with metadata for localisation values LocalisationVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LocalisationVersionDto' description: Instance of a Localisation Version. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ContextDto: type: object properties: name: type: - string - 'null' description: Name of column example: Text name description: type: - string - 'null' description: Description of the context example: Translation for Chinese localisationList: type: - object - 'null' additionalProperties: {} description: Type of column displayName: type: - string - 'null' description: Display name of the context 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 LocalisationLiteVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LocalisationLiteVersionDto' description: Instance of a Localisation Version. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false SystemLanguageDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/SystemLanguageDto' description: Defines column with metadata for localisation values messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LocalisationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LocalisationDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: type: string messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ApproveAction_2: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-localisationcommand-v1-0-openapi.json - fenergo-localisationquery-v1-0-openapi.json