openapi: 3.2.0 info: title: Fenergo Config Environment API version: '1.0' description: 'Operations tagged ConfigEnvironment across 2 of this provider''s published API definitions: fenergo-configexchangecommand-v1-0-openapi.json, fenergo-configexchangequery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /configexchangecommand - url: /configexchangequery security: - Bearer: [] tags: - name: ConfigEnvironment paths: /api/configuration-exchange: post: tags: - ConfigEnvironment summary: Create new ConfigurationEnvironment description: 'This method will create a new ConfigurationEnvironment. The ConfigurationEnvironment will initialize with the data provided in the DTO. Required permissions: Following permissions are required: ConfigurationExchangeEdit' operationId: CreateConfigurationEnvironment 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 Fenergo.Nebula.ConfigExchange.Command.Application.Dto.ConfigEnvironmentDto to create content: application/json: schema: $ref: '#/components/schemas/ConfigEnvironmentDtoServiceRequest' responses: '202': description: Success. ConfigurationEnvironment created content: application/json: schema: $ref: '#/components/schemas/ConfigEnvironmentDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: - ConfigEnvironment summary: Get all ConfigurationEnvironments description: 'Returns a list of all ConfigurationEnvironments for a given tenant Required permissions: Following permissions are required: ConfigurationExchangeAccess' operationId: GetAllConfigurationEnvironments 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 ConfigurationEnvironments is returned content: application/json: schema: $ref: '#/components/schemas/ConfigEnvironmentDtoIEnumerableServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '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: /configexchangecommand /api/configuration-exchange/{id}: put: tags: - ConfigEnvironment summary: Update existing ConfigurationEnvironment description: 'This method will update an existing ConfigurationEnvironment. The ConfigurationEnvironment will be updated with the data provided in the DTO. Required permissions: Following permissions are required: ConfigurationExchangeEdit' operationId: UpdateConfigurationEnvironment parameters: - name: id in: path description: The Id of the existing ConfigurationEnvironment to update 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 Fenergo.Nebula.ConfigExchange.Command.Application.Dto.ConfigEnvironmentDto to update content: application/json: schema: $ref: '#/components/schemas/ConfigEnvironmentDtoServiceRequest' responses: '202': description: Success. ConfigurationEnvironment updated '400': description: Not Found. ConfigurationEnvironment with given ID does not exist 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: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error. An unhandled exception occurred '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 delete: tags: - ConfigEnvironment summary: Delete existing ConfigurationEnvironment description: 'This method will delete an existing ConfigurationEnvironment. The ConfigurationEnvironment will be updated with the data provided in the DTO. Required permissions: Following permissions are required: ConfigurationExchangeEdit' operationId: DeleteConfigurationEnvironment parameters: - name: id in: path description: The Id of the existing ConfigurationEnvironment to delete 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: Success. ConfigurationEnvironment deleted '400': description: Not Found. ConfigurationEnvironment with given ID does not exist 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: Not Found type: Error errorCode: Error Code '500': description: Internal Server Error. An unhandled exception occurred '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: - ConfigEnvironment summary: Get a ConfigurationEnvironment description: 'Returns a ConfigurationEnvironment for a given ID Required permissions: Following permissions are required: ConfigurationExchangeAccess' operationId: GetConfigurationEnvironmentById parameters: - name: id in: path description: Unique Identifier of the ConfigurationEnvironment 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 ConfigurationEnvironment is returned content: application/json: schema: $ref: '#/components/schemas/ConfigEnvironmentDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values 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: Not Found. ConfigurationEnvironment 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: /configexchangecommand components: schemas: ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigEnvironmentDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/ConfigEnvironmentDto' 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 ConfigEnvironmentDto: type: object properties: id: type: string description: Unique Identifier of the environment format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa name: type: - string - 'null' description: Friendly name of the environment example: Fenergo Sandbox authorisationLoginUri: type: - string - 'null' description: The URI of the Authentication provider for this environment example: https://identity.fenergonebula.com configurationQueryUri: type: - string - 'null' description: The base URI of the API's for this environment example: https://api.fenergonebula.com additionalProperties: false description: The details of a configuration environment ConfigEnvironmentDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/ConfigEnvironmentDto' 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 ConfigEnvironmentDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ConfigEnvironmentDto_2' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ConfigEnvironmentDto_2: type: object properties: id: type: string description: Unique Identifier of the environment format: uuid example: 2920b7a7-7336-4fb1-82b7-1d691b8367fa name: type: - string - 'null' description: Friendly name of the environment example: Fenergo Sandbox authorisationLoginUri: type: - string - 'null' description: The URI of the Authentication provider for this environment example: https://identity.fenergonebula.com configurationQueryUri: type: - string - 'null' description: The base URI of the APIs for this environment example: https://app.fenergonebula.com additionalProperties: false description: The details of a configuration environment securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-configexchangecommand-v1-0-openapi.json - fenergo-configexchangequery-v1-0-openapi.json