Aerones Core.projects.scope Items API

openapi: 3.2.0
info:
  title: Aerones Core.projects.scope Items API
  version: 0.1.1
  description: 'Operations tagged core.projects.scope-items across 2 of this provider''s published API definitions: aerones-openapi.json, aerones-operations-hub-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: core.projects.scope-items
paths:
  /api/core/v1/projects/{project_id}/scope-items:
    get:
      operationId: list_project_scope_items
      summary: List Scope Items for Project
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      - in: query
        name: search
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Search by location, turbine, service code/description, component type, or turbine component identifiers
          title: Search
        required: false
        description: Search by location, turbine, service code/description, component type, or turbine component identifiers
      - in: query
        name: sort
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Sort by field (prefix with - for descending)
          title: Sort
        required: false
        description: Sort by field (prefix with - for descending)
      - in: query
        name: location_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by location ID
          title: Location Id
        required: false
        description: Filter by location ID
      - in: query
        name: service_id
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Filter by service ID
          title: Service Id
        required: false
        description: Filter by service ID
      - in: query
        name: paginate
        schema:
          default: true
          description: Enable pagination (false returns all results)
          title: Paginate
          type: boolean
        required: false
        description: Enable pagination (false returns all results)
      - in: query
        name: page
        schema:
          default: 1
          description: Page number
          minimum: 1
          title: Page
          type: integer
        required: false
        description: Page number
      - in: query
        name: page_size
        schema:
          default: 50
          description: Number of items per page
          maximum: 1000
          minimum: 1
          title: Page Size
          type: integer
        required: false
        description: Number of items per page
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProjectScopeItemResponse'
                title: Response
                type: array
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      description: List all child items for a parent with pagination, search, and sorting.
      tags:
      - core.projects.scope-items
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    post:
      operationId: create_project_scope_item
      summary: Create Scope Item
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectScopeItemResponse'
      description: Create a new child item for the parent.
      tags:
      - core.projects.scope-items
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectScopeItemCreate'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
  /api/core/v1/projects/{project_id}/scope-items/{scope_item_id}:
    get:
      operationId: get_project_scope_item
      summary: Get Scope Item
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      - in: path
        name: scope_item_id
        schema:
          title: Scope Item Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectScopeItemResponse'
      description: Get a single child item.
      tags:
      - core.projects.scope-items
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    patch:
      operationId: update_project_scope_item
      summary: Update Scope Item
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      - in: path
        name: scope_item_id
        schema:
          title: Scope Item Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectScopeItemResponse'
      description: Update a child item.
      tags:
      - core.projects.scope-items
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectScopeItemUpdate'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
    delete:
      operationId: delete_project_scope_item
      summary: Delete Scope Item
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      - in: path
        name: scope_item_id
        schema:
          title: Scope Item Id
          type: integer
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Success'
      description: Soft delete a child item.
      tags:
      - core.projects.scope-items
      security:
      - APIKeyAuth: []
      - CookieAuth: []
  /api/core/v1/projects/{project_id}/scope-item-batches:
    post:
      operationId: create_project_scope_item_batch
      summary: Create Scope Item Batch
      parameters:
      - in: path
        name: project_id
        schema:
          title: Project Id
          type: string
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ProjectScopeItemResponse'
                title: Response
                type: array
      description: Create multiple project scope rows for different turbines in one request.
      tags:
      - core.projects.scope-items
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProjectScopeItemBulkCreate'
        required: true
      security:
      - APIKeyAuth: []
      - CookieAuth: []
components:
  schemas:
    ErrorCode:
      description: Error codes for API errors.
      enum:
      - validation
      - server
      - auth
      - unknown
      - external
      - generic
      title: ErrorCode
      type: string
    ProjectScopeTurbineComponentObject:
      additionalProperties: false
      description: Nested turbine component descriptor for project scope rows.
      properties:
        id:
          title: Id
          type: integer
        serial_number:
          title: Serial Number
          type: string
        position:
          anyOf:
          - type: string
          - type: 'null'
          title: Position
      required:
      - id
      - serial_number
      title: ProjectScopeTurbineComponentObject
      type: object
    ProjectScopeItemUpdate:
      additionalProperties: false
      description: Schema for updating a ProjectScopeItem.
      properties:
        location_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Location ID
          title: Location Id
        turbine_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine ID
          title: Turbine Id
        component_type_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Component type ID
          title: Component Type Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        service_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service ID
          title: Service Id
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
        amount:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Amount
          title: Amount
        commercial_offer_item_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Commercial offer item ID from latest approved version
          title: Commercial Offer Item Id
      title: ProjectScopeItemUpdate
      type: object
    ProjectScopeTurbineObject:
      additionalProperties: false
      description: 'Nested turbine object for scope rows, carrying geo-coordinates.


        Coordinates power the Project scope map view. They come straight off

        ``core.Turbine`` (``latitude``/``longitude`` DecimalFields, backfilled from

        the free-text ``coordinates`` string by migration

        ``0058_populate_lat_lng_from_coordinates``). Pydantic ``from_attributes``

        reads them off the already ``select_related``-loaded turbine, so exposing

        them adds no query.'
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        latitude:
          anyOf:
          - type: number
          - type: 'null'
          description: Turbine GPS latitude
          title: Latitude
        longitude:
          anyOf:
          - type: number
          - type: 'null'
          description: Turbine GPS longitude
          title: Longitude
      required:
      - id
      - name
      title: ProjectScopeTurbineObject
      type: object
    ProjectScopeItemResponse:
      additionalProperties: false
      description: Schema for ProjectScopeItem response.
      properties:
        updated_at:
          description: Last update timestamp
          format: date-time
          title: Updated At
          type: string
        id:
          description: Project scope item ID
          title: Id
          type: integer
        project_id:
          description: Project ID
          title: Project Id
          type: integer
        service_order_line_refs:
          description: Live (non-cancelled) SOLs generated from this scope item
          items:
            $ref: '#/components/schemas/ScopeItemServiceOrderLineRef'
          title: Service Order Line Refs
          type: array
        location:
          $ref: '#/components/schemas/ProjectScopeLocationObject'
          description: Location information (with GPS coordinates for the map)
        turbine:
          anyOf:
          - $ref: '#/components/schemas/ProjectScopeTurbineObject'
          - type: 'null'
          description: Turbine information (with GPS coordinates for the map)
        component_type:
          anyOf:
          - $ref: '#/components/schemas/ComponentTypeObject'
          - type: 'null'
          description: Component type information
        turbine_component:
          anyOf:
          - $ref: '#/components/schemas/ProjectScopeTurbineComponentObject'
          - type: 'null'
          description: Turbine component information
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        turbine_component_serial_number:
          anyOf:
          - type: string
          - type: 'null'
          description: Turbine component serial number
          title: Turbine Component Serial Number
        service:
          anyOf:
          - $ref: '#/components/schemas/ServiceObject'
          - type: 'null'
          description: Service information
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
        amount:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Amount
          title: Amount
        current_commercial_offer_item_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: The latest offer's item on this scope item's CO line; null when the line is not in the latest offer (list responses only)
          title: Current Commercial Offer Item Id
      required:
      - updated_at
      - id
      - project_id
      - location
      title: ProjectScopeItemResponse
      type: object
    ProjectScopeLocationObject:
      additionalProperties: false
      description: 'Nested location object for scope rows, carrying geo-coordinates.


        Used as the map fallback when a turbine has no coordinates of its own

        (``core.Location.latitude``/``longitude``).'
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        type:
          anyOf:
          - $ref: '#/components/schemas/LocationType'
          - type: 'null'
        latitude:
          anyOf:
          - type: number
          - type: 'null'
          description: Location GPS latitude
          title: Latitude
        longitude:
          anyOf:
          - type: number
          - type: 'null'
          description: Location GPS longitude
          title: Longitude
      required:
      - id
      - name
      title: ProjectScopeLocationObject
      type: object
    ComponentTypeObject:
      additionalProperties: false
      description: Nested component type object for responses.
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        field_list:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Field List
      required:
      - id
      - name
      title: ComponentTypeObject
      type: object
    ScopeItemServiceOrderLineRef:
      additionalProperties: false
      description: A live SOL generated from a scope item (for linking from scope UIs).
      properties:
        id:
          description: ServiceOrderLine ID
          title: Id
          type: integer
        number:
          anyOf:
          - type: string
          - type: 'null'
          description: SOL number
          title: Number
        status:
          anyOf:
          - type: string
          - type: 'null'
          description: SOL status
          title: Status
      required:
      - id
      title: ScopeItemServiceOrderLineRef
      type: object
    Error:
      additionalProperties: false
      description: Error response schema.
      properties:
        code:
          $ref: '#/components/schemas/ErrorCode'
        message:
          title: Message
          type: string
      required:
      - code
      - message
      title: Error
      type: object
    Success:
      additionalProperties: false
      description: 'Schema returned for successful operations.


        The `success` field is always ``true`` in this schema. Failed operations are

        represented by the :class:`Error` schema instead, so a ``false`` value does

        not occur in practice. The field is included for consistency across responses

        and to make the contract explicit for clients.'
      properties:
        success:
          default: true
          description: Always true for this schema. Errors are represented by a separate Error schema, so false is never returned.
          title: Success
          type: boolean
      title: Success
      type: object
    LocationType:
      description: Allowed location type values in location.
      enum:
      - WIND_PARK
      - WAREHOUSE
      - SERVICE_HUB
      - PORT
      - TRAINING_CENTER
      - FACTORY
      - OFFICE
      title: LocationType
      type: string
    ServiceObject:
      additionalProperties: false
      description: Nested service object for responses (no timestamps).
      properties:
        id:
          title: Id
          type: integer
        code:
          title: Code
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_service:
          description: Whether this is a service (vs addon/material/support)
          title: Is Service
          type: boolean
        allows_materials:
          anyOf:
          - type: boolean
          - type: 'null'
          description: A CO line of this service can have material lines; unset where not loaded
          title: Allows Materials
      required:
      - id
      - code
      - is_service
      title: ServiceObject
      type: object
    ProjectScopeItemCreate:
      additionalProperties: false
      description: Schema for creating a ProjectScopeItem.
      properties:
        location_id:
          description: Location ID
          title: Location Id
          type: integer
        turbine_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine ID
          title: Turbine Id
        component_type_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Component type ID
          title: Component Type Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        service_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Service ID
          title: Service Id
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
        amount:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Amount
          title: Amount
        commercial_offer_item_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Commercial offer item ID from latest approved version
          title: Commercial Offer Item Id
      required:
      - location_id
      title: ProjectScopeItemCreate
      type: object
    ProjectScopeItemBulkCreate:
      additionalProperties: false
      description: Schema for bulk creating ProjectScopeItems for multiple turbines.
      properties:
        location_id:
          description: Location ID
          title: Location Id
          type: integer
        turbine_ids:
          description: List of turbine IDs
          items:
            type: integer
          minItems: 1
          title: Turbine Ids
          type: array
        component_type_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Component type ID
          title: Component Type Id
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        commercial_offer_item_id:
          description: Commercial offer item ID from latest approved version
          title: Commercial Offer Item Id
          type: integer
      required:
      - location_id
      - turbine_ids
      - commercial_offer_item_id
      title: ProjectScopeItemBulkCreate
      type: object
    ProjectScopeItemResponse_2:
      additionalProperties: false
      description: Schema for ProjectScopeItem response.
      properties:
        updated_at:
          description: Last update timestamp
          format: date-time
          title: Updated At
          type: string
        id:
          description: Project scope item ID
          title: Id
          type: integer
        project_id:
          description: Project ID
          title: Project Id
          type: integer
        service_order_line_refs:
          description: Live (non-cancelled) SOLs generated from this scope item
          items:
            $ref: '#/components/schemas/ScopeItemServiceOrderLineRef'
          title: Service Order Line Refs
          type: array
        location:
          $ref: '#/components/schemas/ProjectScopeLocationObject'
          description: Location information (with GPS coordinates for the map)
        turbine:
          anyOf:
          - $ref: '#/components/schemas/ProjectScopeTurbineObject'
          - type: 'null'
          description: Turbine information (with GPS coordinates for the map)
        component_type:
          anyOf:
          - $ref: '#/components/schemas/ComponentTypeObject'
          - type: 'null'
          description: Component type information
        turbine_component:
          anyOf:
          - $ref: '#/components/schemas/ProjectScopeTurbineComponentObject'
          - type: 'null'
          description: Turbine component information
        turbine_component_id:
          anyOf:
          - type: integer
          - type: 'null'
          description: Turbine component ID
          title: Turbine Component Id
        turbine_component_serial_number:
          anyOf:
          - type: string
          - type: 'null'
          description: Turbine component serial number
          title: Turbine Component Serial Number
        service:
          anyOf:
          - $ref: '#/components/schemas/ServiceObject_2'
          - type: 'null'
          description: Service information
        additional_information:
          anyOf:
          - type: object
          - type: 'null'
          description: Additional information as JSON
          title: Additional Information
        amount:
          anyOf:
          - type: number
          - type: string
          - type: 'null'
          description: Amount
          title: Amount
      required:
      - updated_at
      - id
      - project_id
      - location
      title: ProjectScopeItemResponse
      type: object
    ServiceObject_2:
      additionalProperties: false
      description: Nested service object for responses (no timestamps).
      properties:
        id:
          title: Id
          type: integer
        code:
          title: Code
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
        is_service:
          description: Whether this is a service (vs addon/material/support)
          title: Is Service
          type: boolean
      required:
      - id
      - code
      - is_service
      title: ServiceObject
      type: object
  securitySchemes:
    APIKeyAuth:
      type: http
      scheme: bearer
    CookieAuth:
      type: apiKey
      in: cookie
      name: opshub_prod_sessionid
    AuthBearer:
      type: http
      scheme: bearer
x-refined-from:
- aerones-openapi.json
- aerones-operations-hub-openapi.json