Aedifion Project API

openapi: 3.2.0
info:
  description: 'Welcome to the interactive user interface (UI) for the aedifion REST API.


    This UI allows you to


    - browse documentation of all endpoints

    - explore schemas and examples of request parameters and responses

    - call endpoints and view responses


    Further documentation as well as extensive guides and tutorials are available in the official documentation.'
  title: Docs Project API
  version: ''
servers:
- url: ''
tags:
- description: Creating, modifying, and accessing projects and related resources.
  name: Project
paths:
  /v2/project/{project_id}:
    delete:
      description: 'Deletes the specified project and all its associated resources.

        Requires confirmation by the given project name.'
      operationId: delete_project
      parameters:
      - description: The id of the project that should be deleted.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The exact name of the project. Must match the project name exactly for deletion to proceed.
        in: query
        name: project_name
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation.

            The deleted project is returned within the ''resource'' field and ''operation'' will indicate a ''delete'' operation.

            '
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request. Details are returned in the 'error' field of the response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''delete''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Project not found.
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Delete project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    get:
      description: Returns the details of the queried project.
      operationId: get_project
      parameters:
      - description: The id of the project that should be retrieved.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectWithContext'
          description: 'Successful operation.

            Returns the project, the company that owns this project, and a list of data point keys associated with this project.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to get.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Get project's details
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    put:
      description: Updates the details of the specified project.
      operationId: put_project
      parameters:
      - description: The id of the project that should be updated.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProject'
        description: 'The details of the update to an existing project:

          - **name** is optional, a new name for the referenced project

          - **description** is optional, a new description for the referenced project

          - **latitude** is optional, a new latitude for the referenced project

          - **longitude** is optional, a new longitude for the referenced project

          - **units_system** is optional, a new preferred system of units for the referenced project

          - **currency_system** is optional, a new preferred currency system for the referenced project

          - **asset_manager_id** is id of the user that is the asset manager of the project. Assign `null` to remove the asset manager."

          - **account_manager_id** is id of the user that is the account manager of the project. Assign `null` to remove the account manager."

          - **project_engineer_id** is id of the user that is the project engineer. Assign `null` to remove the project engineer."

          '
        required: true
        x-body-name: project
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation.

            The updated project is returned within the ''resource'' field and ''operation'' will indicate a ''update'' operation.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''update''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Update project's details
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/ai/consent:
    post:
      description: 'Grant or revoke the consent for AI assistant for the specified project.

        Giving consent grants the AI assistant to process project''s data.'
      operationId: post_ai_assistant_consent
      parameters:
      - description: The id of the project
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: Consent status. Set to true to give consent, false to revoke.
        in: query
        name: consent
        required: true
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: AI assistant consent status updated successfully
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Grant or revoke the consent for AI Assistant
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/alerts:
    get:
      description: Returns the details of all alerts in a project.
      operationId: get_alerts
      parameters:
      - description: The numeric id of the project for which alerts should be queried.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: Page number.
        in: query
        name: page
        required: false
        schema:
          format: int64
          type: integer
      - description: Items per page. Defaults to 20, maximum limit is 100.
        in: query
        name: per_page
        required: false
        schema:
          format: int64
          type: integer
      - description: Optional parameter, filter on alert names.
        in: query
        name: search
        required: false
        schema:
          type: string
      - description: 'Results can be filtered by keys: alert_type, dataPointID, status.

          Format must be in the form of key=value.

          Multiple filters can be applied, separated by a '';'' like: key=value; key2=value

          Filters with same key will be processed as ''Or'' and ''And'' across different keys.

          The status filter accepts the values ''enabled'' and ''disabled'' (case-insensitive).

          '
        in: query
        name: filter
        required: false
        schema:
          type: string
      - description: Optional parameter, sort order, ascending by default
        in: query
        name: sort_order
        required: false
        schema:
          default: asc
          enum:
          - asc
          - desc
          type: string
      - description: Optional parameter, sort by, sorted by id by default
        in: query
        name: sort_by
        required: false
        schema:
          default: id
          enum:
          - id
          - name
          - alert_type
          - created
          - updated
          - status
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOfAlerts'
          description: Successful operation. A list of all alerts for the specified project is returned.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''get''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Get all alerts in a project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/avatar:
    delete:
      operationId: delete_project_avatar
      parameters:
      - description: id of the project
        in: path
        name: project_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: Successful operation.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Out of service.
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Deletes the current avatar image of the project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    post:
      operationId: post_project_avatar
      parameters:
      - description: id of the project
        in: path
        name: project_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UploadAvatarRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: Successful operation.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: File is not an image file.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Out of service.
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Uploads and stores an image for the project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/comments:
    get:
      description: Returns a paginated list of project comments.
      operationId: get_project_comments
      parameters:
      - description: The id of the project.
        in: path
        name: project_id
        required: true
        schema:
          type: integer
      - description: The page number.
        in: query
        name: page
        required: false
        schema:
          format: int64
          type: integer
      - description: Items per page. Defaults to 20, maximum limit is 100.
        in: query
        name: per_page
        required: false
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectCommentList'
          description: A paginated list of project comments.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request. Details on the error are returned in the ''error'' field of the response.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Get all comments of a project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    post:
      description: Create a new comment for a project given with `project_id`.
      operationId: post_project_comment
      parameters:
      - description: The id of the project the comment will be created for.
        in: path
        name: project_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewProjectComment'
        description: The details of the comment.
        required: true
        x-body-name: new_comment
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectComment'
          description: Success. The project comment has been created. The created comment is returned in the response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request. Details of the error are returned in the 'error' field of the response.
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Create a new project comment
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/comments/{comment_id}:
    delete:
      description: Delete a comment belonging to a project.
      operationId: delete_project_comment
      parameters:
      - in: path
        name: project_id
        required: true
        schema:
          type: integer
      - description: The id of the comment.
        in: path
        name: comment_id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          content: {}
          description: Success. The project comment has been deleted.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request. Details on the error are returned in the 'error' field of the response.
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Delete a project comment
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    get:
      description: Get the details of a project comment.
      operationId: get_project_comment
      parameters:
      - description: The id of the comment.
        in: path
        name: comment_id
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: project_id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectComment'
          description: Success. The queried project comment is returned in the response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request. Details on the error are returned in the 'error' field of the response.
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Get a project comment
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    put:
      description: Update the message of a project comment.
      operationId: put_project_comment
      parameters:
      - description: The id of the comment.
        in: path
        name: comment_id
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: project_id
        required: true
        schema:
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProjectComment'
        description: The changes to the comment.
        required: true
        x-body-name: comment
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectComment'
          description: Success. The project comment has been updated. The updated comment is returned in the response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request. Details on the error are returned in the 'error' field of the response.
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Edit a project comment
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/componentInProject:
    post:
      description: Adds a new component to the specified project.
      operationId: post_project_component
      parameters:
      - description: The numeric id of the project for which to add the new component.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The numeric id of the component to add.
        in: query
        name: component_id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewComponentInProject'
        description: 'The details of the component to add to the project.

          **Note:** At least one of ''name'', ''nameEN'', or ''nameDE'' must be provided.

          - **name** [optional], the component''s name. If not given, deprecated parameters ''nameEN'' and ''nameDE'' are going to be taken into account.

          - (deprecated) **nameEN** [optional], the component''s english name

          - (deprecated) **nameDE** [optional], the component''s german name

          - **abbreviation** [optional], the component''s abbreviated name

          '
        required: false
        x-body-name: component_details
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation.

            The newly added component is returned in the ''resource'' field and the ''operation'' is set to ''create''.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''create''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Add a new component in project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/componentInProject/attribute:
    delete:
      description: Deletes an attribute for a component in a project.
      operationId: delete_project_component_attribute
      parameters:
      - description: The numeric id of the project.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The numeric id of the component in project.
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The attribute key that should be deleted.
        in: query
        name: key
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation. The details of the deleted component attribute are returned in the ''resource'' field and ''operation'' will indicate a ''delete'' operation.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''delete''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Delete an attribute for a component in a project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    post:
      description: Adds a new attribute to the specified component in project.
      operationId: post_project_component_attribute
      parameters:
      - description: The numeric id of the project.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The numeric id of the componentInProject.
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostProjectComponentAttributeRequest'
        description: 'The details of the componentInproject attribute to add to the project:

          - **key** [mandatory], the key of the attribute

          - **value** [mandatory], the value of the attribute

          - **unit** [optional], the unit of the attribute

          '
        required: true
        x-body-name: attribute_details
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation.

            The newly added component is returned in the ''resource'' field and the ''operation'' is set to ''create''.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''create''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Add a new attribute to component in project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    put:
      description: Edits an attribute for a component in a project.
      operationId: put_project_component_attribute
      parameters:
      - description: The numeric id of the project.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The numeric id of the component in project.
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The attribute key.
        in: query
        name: key
        required: true
        schema:
          type: string
      - description: The new value of the attribute.
        in: query
        name: value
        required: true
        schema:
          type: string
      - description: The new unit of the attribute.
        in: query
        name: unit
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation.

            The edited component attribute is returned in the ''resource'' field and the ''operation'' is set to ''update''.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''update''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Edit an attribute for a component in a project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/componentInProject/attributes:
    patch:
      description: Adds, updates and removes the attributes of a specified component in project as described in the request.
      operationId: patch_project_component_attributes
      parameters:
      - description: The numeric id of the project.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The numeric id of the componentInProject.
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      - description: Option to force update controls apps that use the patched attributes.
        in: query
        name: force
        schema:
          default: false
          type: boolean
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchProjectComponentAttributesRequest'
        description: 'The details of the componentInproject attributes to update as a list of objects containing:

          - **key** [mandatory], the key of the attribute

          - **value** [optional], the value of the attribute

          - **unit** [optional], the unit of the attribute


          Providing key without a value results in deletion of the attribute.

          '
        required: true
        x-body-name: attribute_details_batch
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchAttributesSuccess'
          description: 'Successful operation.

            The newly added component is returned in the ''resource'' field and the ''operation'' is set to ''create''.

            '
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request. Details on the error are returned in the 'details' field of the response.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request. Details on the error are returned in the 'error' field of the response.
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Change attributes of a component in project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
  /v2/project/{project_id}/componentInProject/pin/datapoint:
    delete:
      description: Deletes a datapoint on component pin defined in project.
      operationId: delete_project_component_pin_datapoint
      parameters:
      - description: The id of the project from where to delete the component.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The id of the component.
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      - description: The id of the pin.
        in: query
        name: pin_id
        required: true
        schema:
          format: int64
          type: integer
      - $ref: '#/components/parameters/LanguageQueryParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
          description: 'Successful operation. The details of the deleted datapoint on component are returned in the ''resource'' field and ''operation'' will indicate a ''delete'' operation.

            '
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 'Unauthorized request.

            Details on the error are returned in the ''error'' field of the response and ''operation'' is set to ''delete''.

            '
          headers:
            WWW_Authenticate:
              schema:
                type: string
      security:
      - basicAuth: []
      - openIDConnect: []
      summary: Delete a datapoint on component pin for the project
      tags:
      - Project
      x-openapi-router-controller: app.controllers.project_controller
    post:
      description: Connects a datapoint to a component's pin within the specified project.
      operationId: post_project_component_pin_datapoint
      parameters:
      - description: The id of the project to add datapoint to its component pin.
        in: path
        name: project_id
        required: true
        schema:
          format: int64
          type: integer
      - description: '**componentinproject_id** [mandatory], the numeric id of the component in the project'
        in: query
        name: componentinproject_id
        required: true
        schema:
          format: int64
          type: integer
      - description: '**pin_id** [mandatory], the id of the pin.'
        in: query
        name: pin_id
        required: true
        schema:
 

# --- truncated at 32 KB (208 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aedifion/refs/heads/main/openapi/aedifion-project-api-openapi.yml