openapi: 3.2.0 info: title: Fenergo Lookup API version: '1.0' description: 'Operations tagged Lookup across 4 of this provider''s published API definitions: fenergo-docgenquery-v1-0-openapi.json, fenergo-localisationquery-v1-0-openapi.json, fenergo-lookupcommand-v1-0-openapi.json, fenergo-lookupquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /docgenquery - url: /localisationquery - url: /lookupcommand - url: /lookupquery security: - Bearer: [] tags: - name: Lookup paths: /api/lookup/languageCode: get: tags: - Lookup summary: Get standard language code list description: This method returns BCP47 standard langage codes list. operationId: GetLanguageCodes 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 language codes 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 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: /docgenquery /api/lookup/languageSelect: get: tags: - Lookup summary: Get language select list with description description: This method returns BCP47 standard langage codes list. operationId: GetLanguageSelect 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 language codes is returned content: text/plain: schema: $ref: '#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse' application/json: schema: $ref: '#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse' text/json: schema: $ref: '#/components/schemas/LanguageSelectDtoIEnumerableServiceResponse' '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 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: /docgenquery /api/lookup: post: tags: - Lookup summary: Create a new Lookup using values as the source of truth description: 'This method creates new Lookups 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: ReferenceDataEditorEdit' operationId: CreateLookup 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: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/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: - Lookup summary: Gets all Lookups for the client tenant description: 'This method returns all Lookups for given tenant Required permissions: Following permissions are required: LookupAccess' operationId: GetAllLookups 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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 deprecated: true servers: - url: /lookupcommand /api/lookup/items: post: tags: - Lookup summary: Create a new Lookup using items as the source of truth description: 'This method creates new Lookups 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: ReferenceDataEditorEdit' operationId: CreateLookupItems 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: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/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: /lookupcommand /api/lookup/{lookupId}: put: tags: - Lookup summary: Update Lookups Settings description: 'Update the settings of a lookup, specifically the IsSystemLookup flag. To convert to a system lookup, set IsSystemLookup to (true), and to revert to a standard lookup set it to (false) This affect to all versions of a Lookup Required permissions: Following permissions are required: ReferenceDataEditorEdit' operationId: UpdateLookup parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/UpdateLookupDto' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupDto' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupDto' responses: '202': description: Accepted for processing '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: - Lookup summary: Delete Lookup and all it's versions description: 'This method deletes an existing Lookup as well as all its versions. Required permissions: Following permissions are required: ReferenceDataEditorDelete' operationId: DeleteLookup parameters: - name: lookupId in: path description: Lookup 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: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: - Lookup summary: Create a new Version for an existing Lookup using Values as the source of truth description: 'This method creates a new Lookup version, using values as the source of truth 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: ReferenceDataEditorEdit' operationId: CreateLookupVersion parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/LookupDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: - Lookup summary: Get the active version of an existing Lookup by ID description: 'This method returns the active, currently in effect, published version for a given lookup Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupById parameters: - name: lookupId in: path description: The id of the lookup 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 Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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. Lookup 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: /lookupcommand /api/lookup/bulk-delete: post: tags: - Lookup summary: Bulk Delete Lookups description: 'This method bulk deletes existing Lookups as well as all their versions. Required permissions: Following permissions are required: ReferenceDataEditorDelete' operationId: BulkDeleteLookup 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: description: ServiceRequest with the options content: application/json: schema: allOf: - $ref: '#/components/schemas/BulkDeleteLookupDto' text/json: schema: allOf: - $ref: '#/components/schemas/BulkDeleteLookupDto' application/*+json: schema: allOf: - $ref: '#/components/schemas/BulkDeleteLookupDto' required: true responses: '202': description: Lookup(s) deleted successfuly '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: One or more Lookups with given ID(s) do(es) not exist(s) type: Error errorCode: Error Code '500': description: Internal server error '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 '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: /lookupcommand /api/lookup/{lookupId}/items: post: tags: - Lookup summary: Create a new Version for an existing Lookup using Items as the source of truth description: 'This method creates a new Lookup version, using items as the source of truth 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: ReferenceDataEditorEdit' operationId: CreateLookupVersionItems parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/CreateLookupItemsDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}: put: tags: - Lookup summary: Updates an existing Version of a Lookup using Values as the source of truth description: 'This method updates an existing Lookup version using Values as the source of truth. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: ReferenceDataEditorEdit' operationId: UpdateLookupVersion parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/UpdateLookupVersionDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupVersionDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: - Lookup summary: Delete an existing Version of a Lookup description: 'This method deletes the selected version of an existing Lookup. 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: ReferenceDataEditorDelete' operationId: DeleteLookupVersion parameters: - name: lookupId in: path description: Lookup 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: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: - Lookup summary: Get a specific version of an existing Lookup description: 'This method returns the, specified by number, version for a given Lookup Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupVersionById parameters: - name: lookupId 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 Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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. Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}/items: put: tags: - Lookup summary: Updates an existing Version of a Lookup using the items as the source of truth description: 'This method updates an existing Lookup version using the items as the source of truth. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: ReferenceDataEditorEdit' operationId: UpdateLookupVersionItems parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/UpdateLookupVersionItemsDtoServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupVersionItemsDtoServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/UpdateLookupVersionItemsDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}/submit-for-approval: put: tags: - Lookup summary: Submit an existing Version of a Lookup for Approval description: 'This method submits the selected version of an existing Lookup for Approval. Required permissions: Following permissions are required: ReferenceDataEditorEdit' operationId: SubmitLookupVersion parameters: - name: lookupId 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: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}/sign: put: tags: - Lookup summary: Sign an existing Version of a Lookup description: 'This method signs the selected version of an existing Lookup. The Status of the version changes according to the action sent (Approve/Reject). Required permissions: Following permissions are required: ReferenceDataEditorApprove' operationId: SignLookupVersion parameters: - name: lookupId 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: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' text/json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' application/*+json: schema: allOf: - $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupVersionSignResponseServiceResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}/archive: put: tags: - Lookup summary: Archive an existing Version of a Lookup description: 'This method archives the selected version of an existing Lookup. Required permissions: Following permissions are required: ReferenceDataEditorArchive' operationId: ArchiveLookupVersion parameters: - name: lookupId 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: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup 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: /lookupcommand /api/lookup/{lookupId}/version/{versionNumber}/file: put: tags: - Lookup summary: Import a CSV to update an existing Draft Version of a Lookup description: 'This method updates an existing Lookup Draft version using data from a CSV file as the source of truth. Only Draft versions are allowed to be updated using this method. Required permissions: Following permissions are required: ReferenceDataEditorEdit' operationId: ImportLookupCsvFile parameters: - name: lookupId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: '' 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: content: multipart/form-data: schema: required: - Data.File type: object properties: Data.File: type: string description: CSV File for lookup data. format: binary encoding: Data.File: style: form responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Lookup with given ID does not exist type: Error errorCode: Error Code '500': description: Internal server error '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 '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: - Lookup summary: Retrieves a specific lookup version as a CSV file description: 'Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupVersionFile parameters: - name: lookupId 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: Returns the CSV file stream of the version of a lookup. content: application/json: schema: type: string format: binary '400': description: The request is invalid or the 'LookupVersion' is null. content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: No Lookup version was found with the provided details. 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: /lookupcommand /api/lookup/active: get: tags: - Lookup summary: Gets all Lookups active version for the client tenant description: 'This method returns all Lookups with only the active for a given tenant Required permissions: Following permissions are required: LookupAccess' operationId: GetAllActiveLookups 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: /lookupquery /api/lookup/lite: get: tags: - Lookup summary: Gets all Lookups (lite) description: 'This method returns all Lookups for given tenant. This is lite endpoint and will not return the definitions of the values and signees. Required permissions: Following permissions are required: LookupAccess' operationId: GetAllLookupsLite parameters: - name: includeNotes in: query description: Indicates whether the result should contain versions with Notes field value included. schema: type: boolean default: false - 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupLiteDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: /lookupquery /api/lookup/lite/v2: get: tags: - Lookup summary: Gets all Lookups V2 (lite) with the option of including/excluding versions description: 'This method returns all Lookups with/without their underlying versions for given tenant. This is lite endpoint and will not return the definitions of the values and signees. Required permissions: Following permissions are required: LookupAccess' operationId: GetAllLookupsLiteV2 parameters: - name: includeNotes in: query description: Indicates whether the result should contain versions with Notes field value included. schema: type: boolean default: false - name: requireVersions in: query description: Indicates whether versions are required in the response. schema: type: boolean default: false - 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupLiteV2DtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: /lookupquery /api/lookup/lite/paged: get: tags: - Lookup summary: Gets all Lookups (lite) paged description: 'This method returns all Lookups for given tenant. This is lite endpoint and will not return the definitions of the values and signees . Required permissions: Following permissions are required: LookupAccess' operationId: GetAllLookupsLitePaged parameters: - name: includeNotes in: query description: Indicates whether the result should contain versions with Notes field value included. schema: type: boolean default: false - name: paginationToken in: query description: Token to retrieve more results schema: type: string - name: limit in: query description: '' schema: type: integer format: int32 default: 150 - 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupLiteDtoItemsPageServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: /lookupquery /api/lookup/counts/total: get: tags: - Lookup summary: Retrieves the total count of Lookups for the client tenant description: 'Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupsTotalCount 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 Lookups is returned content: application/json: schema: $ref: '#/components/schemas/Int32ServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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: /lookupquery /api/lookup/name/{lookupName}: get: tags: - Lookup summary: Get the active version of an existing Lookup by Name description: 'This method returns the active, currently in effect, published version for a given lookup Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupByName parameters: - name: lookupName in: path description: The name of the lookup 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 Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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. Lookup 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: /lookupquery /api/lookup/{lookupId}/detailed: get: tags: - Lookup summary: Get detailed lookup by ID with all versions description: 'This method returns the detailed lookup with all versions Required permissions: Following permissions are required: LookupAccess' operationId: GetDetailedLookupById parameters: - name: lookupId in: path description: The id of the lookup 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 Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupDtoServiceResponse_2' '400': description: 'Bad request. Either the request has missing/invalid values, or the response would exceed the Lambda-safe payload size — in the latter case, retrieve versions individually via GetLookupVersionById instead.' content: application/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. Lookup 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: /lookupquery /api/lookup/{lookupId}/lite: get: tags: - Lookup summary: Get lite lookup by ID with all versions description: 'This method returns lite lookup with all versions Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupLiteById parameters: - name: lookupId in: path description: The id of the lookup to retrieve required: true schema: type: string - name: includeNotes in: query description: Indicates whether the result should contain versions with Notes field value included. schema: type: boolean default: false - 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 Lite Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupLiteDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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. Lite Lookup 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: /lookupquery /api/lookup/versions: post: tags: - Lookup summary: Gets a list of versions description: 'This endpoint returns a list of lookup versions from a received list of lookup ids paired with version numbers Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupsByIdsAndVersion parameters: - name: getActiveVersionIfNotFound in: query schema: type: boolean default: false - 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: allOf: - $ref: '#/components/schemas/LookupsByIdsAndVersionRequestServiceRequest' responses: '200': description: Success. A list of Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupVersionDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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 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: /lookupquery /api/lookup/names: post: tags: - Lookup summary: Gets a list of lookups and their active version from a list of names description: 'This method returns a list of lookups with their active version from a list of Names Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupsByNames 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: allOf: - $ref: '#/components/schemas/LookupsByNamesRequestServiceRequest' responses: '202': description: Success. A list of Lookups is returned content: application/json: schema: $ref: '#/components/schemas/LookupDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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 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: /lookupquery /api/lookup/{lookupId}/column-filter: post: tags: - Lookup summary: Get specific columns of an existing Lookup description: 'This method returns the, specified by column names, metadata for a given Lookup Id Required permissions: Following permissions are required: LookupAccess' operationId: GetLookupByIdWithColumnFilter parameters: - name: lookupId in: path description: The Id of the existing model 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 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/LookupMetadataColumnsRequestServiceRequest' responses: '200': description: Success. A Lookup is returned content: application/json: schema: $ref: '#/components/schemas/LookupVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/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. Lookup 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: /lookupquery components: schemas: LanguageSelectDto: type: object properties: value: type: - string - 'null' description: type: - string - 'null' 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 LanguageSelectDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LanguageSelectDto' 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 StringIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: type: string messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LanguageItemDto: type: object properties: bcP47Tag: type: - string - 'null' language: type: - string - 'null' region: type: - string - 'null' isMasterFileSupported: type: boolean languageName: type: - string - 'null' additionalProperties: false LanguageCodeListDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LanguageCodeListDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LanguageCodeListDto: type: object properties: languageItems: type: - array - 'null' items: $ref: '#/components/schemas/LanguageItemDto' description: List of language item additionalProperties: false UpdateLookupVersionDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateLookupVersionDto' description: Set of properties which define new version of Lookup additionalProperties: false MetadataColumnDto: required: - name - type - values type: object properties: type: minLength: 1 type: string description: Type of column example: string name: minLength: 1 type: string description: Name of column example: Text name values: type: object additionalProperties: $ref: '#/components/schemas/MetadataColumnValueDto' description: Column values - key is lookup value additionalProperties: false description: Defines column with metadata for lookup values UpdateLookupVersionItemsDto: required: - items - lookupId - lookupName type: object properties: lookupId: minLength: 1 type: string description: Lookup UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupName: minLength: 1 type: string description: Lookup Name example: TestLookup items: minItems: 1 type: array items: $ref: '#/components/schemas/LookupItemDto' description: Lookup items collection versionNumber: type: integer description: The number of the model version format: int32 example: 1 notes: maxLength: 400 type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes 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 columns: type: - array - 'null' items: $ref: '#/components/schemas/MetadataColumnDto' description: Lookup metadata column collection skipValueIdDefaultGeneration: type: - boolean - 'null' description: Whether or not to auto generate ids for a lookup when saving additionalProperties: false description: Set of properties which define new version of Lookup Signee: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false LookupDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/LookupDto' description: Lookup representation additionalProperties: false LookupDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupDto' description: Lookup representation messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false BulkDeleteLookupDto: required: - ids type: object properties: ids: minItems: 1 type: array items: type: string format: uuid description: The list of lookups'UiDs sent by user to be deleted additionalProperties: false ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupDto: required: - lookupName - values type: object properties: lookupId: type: string description: Lookup UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupName: minLength: 1 type: string description: Lookup Name example: Test1 values: minItems: 1 type: array items: type: string description: Lookup stage collection items: type: - array - 'null' items: $ref: '#/components/schemas/LookupItemDto' description: Lookup items collection columns: type: - array - 'null' items: $ref: '#/components/schemas/MetadataColumnDto' description: Lookup metadata column collection versionNumber: type: integer description: The number of the model version format: int32 example: 1 notes: maxLength: 400 type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes 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: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft isSystemLookup: type: boolean description: Flag to display if this is a System Lookup. System Lookups cannot be deleted and LookupName cannot be updated example: false signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version skipValueIdDefaultGeneration: type: - boolean - 'null' description: Whether valueIds should be auto generated when creating a lookup additionalProperties: false description: Lookup representation UpdateLookupDto: type: object properties: isSystemLookup: type: boolean description: '`true` to set System, Lookup `false` standard Lookup' example: true additionalProperties: false UpdateLookupVersionDto: required: - lookupId - lookupName - values type: object properties: lookupId: minLength: 1 type: string description: Lookup UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupName: minLength: 1 type: string description: Lookup Name example: TestLookup values: minItems: 1 type: array items: type: string description: Lookup stage collection items: type: - array - 'null' items: $ref: '#/components/schemas/LookupItemDto' description: Lookup items collection versionNumber: type: integer description: The number of the model version format: int32 example: 1 notes: maxLength: 400 type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes 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 columns: type: - array - 'null' items: $ref: '#/components/schemas/MetadataColumnDto' description: Lookup metadata column collection skipValueIdDefaultGeneration: type: - boolean - 'null' description: Whether the lookup should auto generate Ids additionalProperties: false description: Set of properties which define new version of Lookup LookupItemDto: type: object properties: id: type: - string - 'null' description: Id of Item example: D64AA6E3-C4BB-45B4-95A6-F9FC07DD1958 value: type: - string - 'null' description: Value of Item example: Ireland additionalProperties: false description: Defines column with metadata for lookup values Decision: enum: - Approve - Reject type: string ApproveActionServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/ApproveAction' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver' action: allOf: - $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false UpdateLookupVersionItemsDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateLookupVersionItemsDto' description: Set of properties which define new version of Lookup additionalProperties: false LookupVersionSignResponse: type: object properties: lookupId: type: string description: The Id of the Lookup Link the version belongs to format: uuid versionNumber: type: integer description: The number of the version that has been signed format: int32 status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The new version status additionalProperties: false description: Contains the new version Status, after a version sign operation CreateLookupItemsDtoServiceRequest: required: - data type: object properties: data: allOf: - $ref: '#/components/schemas/CreateLookupItemsDto' description: Lookup representation additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string MetadataColumnValueDto: type: object properties: value: type: - string - 'null' description: Value of lookup value's column entry example: Test value additionalProperties: false description: Defines value of lookup value's column entry LookupVersionSignResponseServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupVersionSignResponse' description: Contains the new version Status, after a version sign operation messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ApproveAction: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false CreateLookupItemsDto: required: - items - lookupName type: object properties: lookupId: type: string description: Lookup UiD format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupName: minLength: 1 type: string description: Lookup Name example: Test1 items: minItems: 1 type: array items: $ref: '#/components/schemas/LookupItemDto' description: Lookup items collection columns: type: - array - 'null' items: $ref: '#/components/schemas/MetadataColumnDto' description: Lookup metadata column collection versionNumber: type: integer description: The number of the model version format: int32 example: 1 notes: maxLength: 400 type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes 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: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft isSystemLookup: type: boolean description: Flag to display if this is a System Lookup. System Lookups cannot be deleted and LookupName cannot be updated example: false signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version skipValueIdDefaultGeneration: type: - boolean - 'null' description: Whether the lookup ids must be auto generated additionalProperties: false description: Lookup representation LookupsByIdsAndVersionRequest: type: object properties: lookups: type: - object - 'null' additionalProperties: type: integer format: int32 description: The dictionary that contains lookup IDs and version numbers to find example: 6b6de3e3-48b1-46a1-adb0-701653a61c2c: 1 6b6de3e3-48b2-46a1-adb0-701653a61c2c: 2 6b6de3e3-48b3-46a1-adb0-701653a61c2c: 3 additionalProperties: false description: Object for querying Lookup data LookupsByIdsRequest: type: object properties: lookupIds: type: - array - 'null' items: type: string description: Id list for searched lookups additionalProperties: false description: Object for querying Lookup data LookupLiteDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LookupLiteDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupMetadataColumnsRequest: type: object properties: columnNames: type: - array - 'null' items: type: string description: Column names list for searched lookups additionalProperties: false description: Object for querying Lookup data MetadataColumnDto_2: type: object properties: type: type: - string - 'null' description: Type of column example: text name: type: - string - 'null' description: Name of column example: Text name values: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/MetadataColumnValueDto' description: Column values - key is lookup value additionalProperties: false description: Defines column with metadata for lookup values LookupLiteVersionDto: type: object properties: 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' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft 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 id: type: string description: The UiD of the version format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupId: type: string description: The UiD of the Lookup that the version belongs to format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5152 lookupName: type: - string - 'null' description: Display name of the model example: TestLookup notes: type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-12-12T15:55:00.000Z' created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' isSystemLookup: type: boolean description: Flag to display if is a System Lookup and is protect to be deleted or updated LookupName example: false additionalProperties: false description: Instance of a Lookup Version. LookupLiteDtoItemsPageServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupLiteDtoItemsPage' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Int32ServiceResponse: type: object properties: data: type: integer format: int32 messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupsByNamesRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupsByNamesRequest' description: Object for querying Lookup data additionalProperties: false LookupDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupDto_2' description: Lookup Data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupLiteDtoItemsPage: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/LookupLiteDto' paginationToken: type: - string - 'null' additionalProperties: false LookupLiteV2Dto: type: object properties: id: type: string description: The UiD of the lookup format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 isSystemLookup: type: boolean description: Flag to display if this is a System Lookup example: false name: type: - string - 'null' description: Lookup Name example: Journey Type status: allOf: - $ref: '#/components/schemas/VersionStatus' description: Lookup active version status example: Status activeVersionNumber: type: integer description: Lookup active version number format: int32 example: 6 publicationDate: type: - string - 'null' description: The date that the active version got published format: date-time example: '2021-12-12T15:55:00.000Z' versions: type: - array - 'null' items: $ref: '#/components/schemas/LookupLiteVersionDto' description: List of available lookup versions additionalProperties: false description: Lookup Data LookupMetadataColumnsRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupMetadataColumnsRequest' description: Object for querying Lookup data additionalProperties: false LookupVersionDto: type: object properties: 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' status: allOf: - $ref: '#/components/schemas/VersionStatus' description: The status of the version example: Draft 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 id: type: string description: The UiD of the version format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 lookupId: type: string description: The UiD of the Lookup that the version belongs to format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5152 lookupName: type: - string - 'null' description: Display name of the model example: TestLookup notes: type: - string - 'null' description: Optional description of the references and details of changes made that will be visible to all users who can access the version. It's assumed that version notes won't contain 'personal identifiable information'. Please note that having many versions with very long notes could hurt API performance in the long term. example: Example Notes publicationDate: type: - string - 'null' description: The date that the version got published format: date-time example: '2021-12-12T15:55:00.000Z' created: type: string description: The creation date of the version format: date-time example: '2021-12-12T15:55:00.000Z' isSystemLookup: type: boolean description: Flag to display if is a System Lookup and is protect to be deleted or updated LookupName example: false values: type: - array - 'null' items: type: string description: List of values for lookup items: type: - array - 'null' items: $ref: '#/components/schemas/LookupItemDto' description: List of reference values for lookup signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees for the version columns: type: - array - 'null' items: $ref: '#/components/schemas/MetadataColumnDto_2' description: Lookup metadata column collection additionalProperties: false description: Instance of a Lookup Version. LookupDto_2: type: object properties: id: type: string description: Lookup Id format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 isSystemLookup: type: boolean description: Flag to display if this is a System Lookup example: false versions: type: - array - 'null' items: $ref: '#/components/schemas/LookupVersionDto' description: List of available lookup versions additionalProperties: false description: Lookup Data LookupVersionDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LookupVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupVersionDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupVersionDto' description: Instance of a Lookup Version. messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupLiteV2DtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LookupLiteV2Dto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ProblemDetails: type: object properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' additionalProperties: {} LookupsByNamesRequest: type: object properties: lookupNames: type: - array - 'null' items: type: string description: Name list for searched lookups additionalProperties: false description: Object for querying Lookup data LookupLiteDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupLiteDto' description: Lookup Data messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false LookupsByIdsRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupsByIdsRequest' description: Object for querying Lookup data additionalProperties: false LookupsByIdsAndVersionRequestServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/LookupsByIdsAndVersionRequest' description: Object for querying Lookup data additionalProperties: false LookupLiteDto: type: object properties: id: type: string description: The UiD of the lookup format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 isSystemLookup: type: boolean description: Flag to display if this is a System Lookup example: false versions: type: - array - 'null' items: $ref: '#/components/schemas/LookupLiteVersionDto' description: List of available lookup versions additionalProperties: false description: Lookup Data LookupDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/LookupDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-docgenquery-v1-0-openapi.json - fenergo-localisationquery-v1-0-openapi.json - fenergo-lookupcommand-v1-0-openapi.json - fenergo-lookupquery-v1-0-openapi.json