Autodesk Construction Cloud Weather API

openapi: 3.2.0
info:
  title: Construction.Forms Weather API
  version: '1.0'
  contact:
    name: Autodesk Plaform Services
    url: https://aps.autodesk.com/
    email: aps.help@autodesk.com
  termsOfService: https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service
  x-support: https://stackoverflow.com/questions/tagged/autodesk-platform-services
  description: 'The Autodesk Construction Cloud (ACC) Forms API (Forma) lets you retrieve form

    templates and layouts, create and update forms, read and batch-update form field

    values (including tabular values), and retrieve weather data captured on forms

    for a project.'
servers:
- url: https://developer.api.autodesk.com
security:
- 3-legged: []
tags:
- name: Weather
  description: Retrieve weather data associated with a form.
paths:
  /construction/forms/v3/projects/{projectId}/weather/{weatherId}:
    parameters:
    - $ref: '#/components/parameters/ProjectId'
    - name: weatherId
      in: path
      required: true
      description: The unique identifier of the weather record. Use GET forms to retrieve the weather ID from a form's weatherId field.
      schema:
        type: integer
    get:
      tags:
      - Weather
      summary: Get Weather
      operationId: getWeather
      description: 'Returns weather data for a specific weather record associated with a project.


        Weather data is returned in metric units: - Temperature values (temp, temperatureMin, temperatureMax) are in Celsius - Wind speed values (windSpeed, windGust) are in kilometers per hour (km/h) - Precipitation values (precipitationAccumulation) are in millimeters (mm)


        Weather records are created when forms capture weather conditions. Use the weatherId from a form to retrieve the full weather details.'
      responses:
        '200':
          description: Weather data in metric units.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Weather'
              examples:
                example-1:
                  value:
                    id: 12345
                    summaryKey: CLEAR
                    precipitationType: RAIN
                    precipitationAccumulation: 12.7
                    hourlyWeather:
                    - id: 67890
                      summaryKey: PARTLY_CLOUDY
                      hour: '12:00:00'
                      temp: 22.5
                      windSpeed: 16.9
                      windBearing: 225
                      windBearingKey: SW
                      humidity: 0.65
                    provider: WEATHER_KIT
                    fetchedAt: '2024-01-20T14:30:00+00:00'
        '400':
          description: The request is invalid due to malformed syntax or a missing request header.
        '401':
          description: The request lacks valid authentication credentials.
        '403':
          description: The client is authenticated but does not have permission to access the resource.
        '404':
          description: The weather record cannot be found
        '429':
          description: The request exceeds the rate limit for this resource.
        '500':
          description: The request failed due to an internal server error.
      x-codeSamples:
      - lang: cURL
        source: 'curl -v "https://developer.api.autodesk.com/construction/forms/v3/projects/{projectId}/weather/{weatherId}" -H "Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a"'
components:
  parameters:
    ProjectId:
      name: projectId
      in: path
      required: true
      description: The ID of the project. Use the Data Management API to retrieve the project ID. For more information, see the Retrieve a Project ID tutorial. You need to convert the project ID into a project ID for the Forma API by removing the "b." prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.
      schema:
        type: string
  schemas:
    WeatherHourly:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the hourly weather record.
        summaryKey:
          type: string
          description: 'A code describing the weather conditions for this hour in SCREAMING_SNAKE_CASE. Common values include: CLEAR, RAIN, SNOW, SLEET, WIND, FOG, CLOUDY, PARTLY_CLOUDY, MOSTLY_CLEAR, MOSTLY_CLOUDY, HEAVY_RAIN, DRIZZLE, HEAVY_SNOW, FLURRIES, FREEZING_RAIN, THUNDERSTORMS, WINDY, BREEZY, FOGGY, HAZE, BLIZZARD, HOT, FRIGID, WINTRY_MIX. Additional values may appear as weather condition codes evolve.'
        hour:
          type: string
          description: The hour of day for this observation, in HH:MM:SS format (24-hour clock).
        temp:
          type: number
          description: Temperature during the specified hour, in degrees Celsius (°C).
        windSpeed:
          type: number
          description: Average wind speed during the specified hour, in kilometers per hour (km/h).
        windBearing:
          type: integer
          description: Direction the wind is coming from, in degrees (0-360). North is 0°, East is 90°, South is 180°, West is 270°.
        windBearingKey:
          type: string
          description: 'Cardinal direction the wind is coming from. Possible values: N, NE, E, SE, S, SW, W, NW.'
          enum:
          - N
          - NE
          - E
          - SE
          - S
          - SW
          - W
          - NW
        humidity:
          type: number
          description: Relative humidity as a decimal value between 0 and 1 (e.g., 0.65 represents 65% humidity).
    Weather:
      type: object
      description: Weather data in metric units.
      properties:
        id:
          type: integer
          description: Unique identifier for the weather record.
        summaryKey:
          type: string
          description: 'A code describing the weather conditions in SCREAMING_SNAKE_CASE. Common values include: CLEAR, RAIN, SNOW, SLEET, WIND, FOG, CLOUDY, PARTLY_CLOUDY, MOSTLY_CLEAR, MOSTLY_CLOUDY, HEAVY_RAIN, DRIZZLE, HEAVY_SNOW, FLURRIES, FREEZING_RAIN, THUNDERSTORMS, WINDY, BREEZY, FOGGY, HAZE, BLIZZARD, HOT, FRIGID, WINTRY_MIX. Additional values may appear as weather condition codes evolve.'
        precipitationType:
          type:
          - string
          - 'null'
          description: 'Type of precipitation. Possible values: RAIN, SNOW, SLEET, or null if no precipitation.'
        precipitationAccumulation:
          type: number
          description: Amount of precipitation accumulated throughout the day, in millimeters (mm).
        hourlyWeather:
          type: array
          description: Weather observations for specific hours of the day (typically 07:00, 12:00, and 16:00 local time).
          items:
            $ref: '#/components/schemas/WeatherHourly'
        provider:
          type: string
          description: 'Indicates the source of the weather data. Possible values: DARK_SKY, WEATHER_KIT'
          enum:
          - DARK_SKY
          - WEATHER_KIT
        fetchedAt:
          type: string
          format: date-time
          description: The date and time when the weather data was fetched from the weather API.
  securitySchemes:
    2-legged:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: ''
          refreshUrl: ''
          scopes: {}
    3-legged-implicit:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: ''
          refreshUrl: ''
          scopes: {}
    3-legged:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: ''
          tokenUrl: ''
          refreshUrl: ''
          scopes: {}
x-provenance:
  method: harvested
  publisher: Autodesk Construction Cloud
  source: https://raw.githubusercontent.com/autodesk-platform-services/aps-sdk-openapi/main/forma/forms/forms.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)