---
openapi: 3.0.0
info:
  description: >-
    This is the interface for handling requests for
    [App Components](https://developers.asana.com/docs/app-components-overview). This reference
    is generated from an [OpenAPI spec]
    (https://raw.githubusercontent.com/Asana/developer-docs/master/defs/app_components_oas.yaml).
  title: App Components
  termsOfService: https://asana.com/terms
  contact:
    name: Asana Support
    url: https://asana.com/support
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: '0.1'
  x-docs-schema-whitelist:
    - AttachedResourceResponse
    - FormMetadataResponse
    - RanActionResponse
    - WidgetMetadataResponse
    - TypeaheadItem
    - FormValues
servers:
  - url: "{siteUrl}"
    description: Main endpoint.
tags:
  - name: App Forms
    description: >-
      The creation form is displayed when the user starts the flow to create a resource. Asana will make a signed
      request to the specified form_metadata_url in the capabilities, and expect a response with the metadata needed to
      create the form. This process is also used for forms within rules.
  - name: App Rules
    description: >-
      When a rule containing an app action is triggered, the Rules Engine will make a request to the app to
      inform the app to run the configured app action. The resulting status code will indicate to the Rules Engine
      whether the action was successfully completed and, if not, specify a cause for the error.
  - name: App Resource Searching
    description: >-
      If the app defined a search url, tasks without a widget offer the search functionality. This appears as a text
      input to the user. When the user submits the text, the app responds with either an attachment or an error.
  - name: App Widgets
    description: >-
      The widget is displayed when the user views a task with an attachment with a resource URL matching your
      capability’s match_url_pattern. When this happens, Asana will make a signed request to your widget_metadata_url,
      and expect a response with information to build the widget.
components:
  parameters:
    action:
      name: action
      in: query
      schema:
        type: string
      description: >-
        The id of an existing app action that is being edited. Should be omitted when configuring a new app action.
    action_type:
      name: action_type
      required: true
      in: query
      schema:
        type: string
      description: >-
        The id of the configuration used to create the app action
    attachment:
      name: attachment
      required: true
      in: query
      schema:
        type: string
      description: >-
        The attachment id of the URL attachment
    expires_at:
      name: expires_at
      required: true
      in: query
      schema:
        type: string
      description: >-
        The time (in ISO-8601 date format) when the request should expire
    fragment:
      name: fragment
      required: true
      in: query
      schema:
        type: string
      description: >-
        The text entered into the typeahead input
    project:
      name: project
      required: true
      in: query
      schema:
        type: string
      description: >-
        The project gid this hook is coming from.
    user:
      name: user
      required: true
      in: query
      schema:
        type: string
      description: >-
        The user gid this hook is coming from.
    resource_url:
      name: resource_url
      required: true
      in: query
      schema:
        type: string
      description: >-
        The URL of the URL attachment on the task (i.e. Jira issue, GitHub pull request)
    task:
      name: task
      required: true
      in: query
      schema:
        type: string
      description: >-
        The task gid this hook is coming from.
    workspace:
      name: workspace
      required: true
      in: query
      schema:
        type: string
      description: >-
        The workspace gid this hook is coming from.
  responses:
    BadRequest:
      description: >-
        Bad Request
    Unauthorized:
      description: >-
        Unauthorized
    Forbidden:
      description: >-
        Forbidden
    NotFound:
      description: >-
        Not Found
    TooManyRequests:
      description: >-
        Too Many Requests
    Gone:
      description: >-
        Gone
    InternalServerError:
      description: >-
        Server Error
    ImATeapot:
      description: >-
        I'm A Teapot
  schemas:
    RootUIComponentRequest:
      description: >-
        The building block of all App Component requests.
      type: object
      properties:
        expires_at:
          type: string
          description: >-
            The time (in ISO-8601 date format) when the request should expire
        user:
          type: string
          description: >-
            The user gid this hook is coming from.
        workspace:
          type: string
          description: >-
            The workspace gid this hook is coming from.
    AttachResourceRequest:
      allOf:
        - $ref: '#/components/schemas/RootUIComponentRequest'
        - type: object
          description: >-
            The body of an attach request.
          properties:
            task:
              type: string
              description: >-
                The task gid this hook is coming from.
            attachment:
              type: string
              description: >-
                The attachment id of the URL attachment
            query:
              type: string
              description: >-
                The user’s input in the attach resource text input (this is often a resource url or resource key, such as
                CP-1 or https://abcde.atlassian.net/browse/CP-1)
    AttachedResourceResponse:
      description: >-
        The response to a successful attach request.
      type: object
      properties:
        resource_name:
          description: >-
            The name of the attached resource
          type: string
          example: 'Build the Thing'
        resource_url:
          description: >-
            The URL of the attached resource
          type: string
          example: 'https://example.atlassian.net/browse/CP-1'
        error:
          description: >-
            The error that should be displayed to the user
          type: string
          example: 'No resource matched that input'
    FormField:
      description: >-
        Every form field type has a set of properties to describe what should be rendered on the form. These are the
        common properties among every form field type, which should be included in addition to any unique properties of
        each form field type. `checkboxes` has a limit of 10 options, `radio_button` has a limit of 5 options, and
        `dropdown` has a limit of 50.
      type: object
      properties:
        type:
          description: >-
            The type of field the form field is
          type: string
          enum:
            - single_line_text
            - multi_line_text
            - rich_text
            - static_text
            - dropdown
            - checkbox
            - radio_button
            - date
            - datetime
            - typeahead
          example: 'single_line_text'
        id:
          description: >-
            The id of the field, which is used to reference the field. These should be unique across the entire form
          type: string
          example: 'item-description'
        name:
          description: >-
            The title displayed on top of the field in the creation form. If not provided, no title will be shown. Max size of 40 char.
          type: string
          example: 'Item Description'
        value:
          description: >-
            The value of the field, the type of which varies based on the particular field. If not provided, the field
            will be empty and the form cannot be submitted if it is required. `single_line_text` has a limit of 200 characters
            while `multi_line_text` and `rich_text` have limits of 3000 characters.
          example: "It's over 9000"
        is_required:
          description: >-
            Whether the field is required to submit the form
          type: boolean
          example: true
        placeholder:
          description: >-
            *Conditional*. Only relevant for custom fields of type `single_line_text`, `multi_line_text`, `date_input`,
            `date_time_input`, and `typeahead`.
            The placeholder for the input, which is shown if the field has no value. If not provided, there will be no
            placeholder.
          type: string
          example: 'Type description here...'
        width:
          description: >-
            *Conditional*. Only relevant for custom fields of type
            `single_line_text`. The width of the form field. The default is "full".
          type: string
          enum:
            - full
            - half
        is_watched:
          description: >-
            Whether the field should be watched. Fields that are watched send requests to the on_change URL specified
            in the form metadata to get updated form information.
          type: boolean
        options:
          description: >-
            *Conditional*. Only relevant for custom fields of type `dropdown`, `checkbox`, and `radio_button`.
            An array of FieldOption objects
          items:
            $ref: '#/components/schemas/FieldOption'
    FieldOption:
      description: >-
        An option for a dropdown or checkbox field. This is a property of the dropdown field, and should not include the
        FormField properties.
      type: object
      properties:
        id:
          description: >-
            The id of the option
          type: string
          example: 'opt-in'
        label:
          description: >-
            The label of the option
          type: string
          example: 'Opt in to emails.'
        icon_url:
          description: >-
            *Conditional*. Only relevant for fields of type `dropdown`.
            The URL for the icon beside the label. If not present, no icon will be displayed.
          type: string
          example: 'some-icon.png'
    FormMetadataResponse:
      description: >-
        Contains the metadata that describes how to display and manage a form
      type: object
      properties:
        template:
          type: string
          enum:
            - form_metadata_v0
          example: 'form_metadata_v0'
        metadata:
          type: object
          properties:
            title:
              description: >-
                The title of the form, which is displayed at the top of the creation form
              type: string
              example: 'Create New Issue'
            fields:
              description: >-
                An array of FormField objects that are rendered in the order they are in the array. Limit of 30 fields.
              type: array
              items:
                $ref: '#/components/schemas/FormField'
            submit_button_text:
              description: >-
                The text to display on the form’s submit button. If not provided, the default text “Submit” will be
                displayed on the button.
              type: string
              example: 'Create New Issue'
            on_submit_callback:
              description: >-
                The URL to POST the form to when the user clicks the submit button.
                If this is field is omitted then the submission button will be disabled. This is useful if the user must
                enter information in a watched field first, such as to show additional fields.
              type: string
              example: 'https://www.example.com/on_submit'
            on_change_callback:
              description: >-
                The URL to POST the form to whenever watched field values are changed.
              type: string
              example: 'https://www.example.com/on_change'
    FormSubmissionRequest:
      allOf:
        - $ref: '#/components/schemas/RootUIComponentRequest'
        - type: object
          description: >-
            The body of a form submission.
          properties:
            task:
              type: string
              description: >-
                The task gid this hook is coming from.
            values:
              type: object
              description: >-
                A FormValues object mapping each FormField’s name to its value
              additionalProperties:
                type: object
                properties:
                  field_name:
                    type: string
                  field_object:
                    $ref: '#/components/schemas/FormField'
    ActionFormSubmissionRequest:
      allOf:
        - $ref: '#/components/schemas/FormSubmissionRequest'
        - type: object
          description: >-
            The body of a form submission.
          properties:
            rule_name:
              type: string
              description: >-
                The name of the rule being created
            action:
              type: string
              description: >-
                The id of an existing app action that is being edited
            action_type:
              type: string
              description: >-
                The id of the configuration used to create the app action
    FormOnChangeBaseRequest:
      allOf:
        - $ref: '#/components/schemas/RootUIComponentRequest'
        - type: object
          description: >-
            The body of an onchange event.
          properties:
            changed_field:
              type: string
              description: >-
                The name of the changed FormField
    FormOnChangeRequest:
      allOf:
        - $ref: '#/components/schemas/FormOnChangeBaseRequest'
        - type: object
          description: >-
            The body of an onchange event.
          properties:
            task:
              type: string
              description: >-
                The task gid this hook is coming from.
    ActionFormOnChangeRequest:
      allOf:
        - $ref: '#/components/schemas/FormOnChangeBaseRequest'
        - type: object
          description: >-
            The body of an action onchange event.
          properties:
            action:
              type: string
              description: >-
                The id of an existing app action that is being edited
            action_type:
              type: string
              description: >-
                The id of the configuration used to create the app action
    RunActionRequest:
      allOf:
        - $ref: '#/components/schemas/RootUIComponentRequest'
        - type: object
          description: >-
            The body of an action request.
          properties:
            target_object:
              type: string
              description: >-
                The id of the target object that the Rule is acting on (currently always a Task id)
            action:
              type: string
              description: >-
                The action id generated from rule creation.
            action_type:
              type: string
              description: >-
                The id from the configuration used to create the app action. This is a developer-provided string.
            idempotency_key:
              required: true
              type: string
              description: >-
                A unique key associated with the "Run action" request. App Servers should use
                this key to implement idempotency.
    RanActionResponse:
      type: object
      description: >-
        The response to an action request.
      properties:
        error:
          description: >-
            The error that should be displayed to the user
          type: string
          example: 'That resource no longer exists'
        action_result:
          type: string
          enum:
            - resources_created
            - ok
          description: >-
            Specifies any additional information that the app wants to send to Asana on completion of the action.
            Can only be `resources_created` or `ok`.
          example: 'ok'
        resources_created:
          type: array
          description: >-
            A field with the data corresponding to the action_result value. Each action_result has its own data field
            shape that Asana expects. `resources_created` expects the name and url of the resources that the action
            created.
          items:
            $ref: '#/components/schemas/AttachedResourceResponse'
    TypeaheadItem:
      description: >-
        An object describing a typeahead result
      type: object
      properties:
        title:
          description: >-
            The title of the typeahead item
          type: string
          example: 'OTP Team PF'
        subtitle:
          description: >-
            The subtitle of the typeahead item
          type: string
          example: 'OTP'
        value:
          description: >-
            The value of the typeahead item
          type: string
          example: 'OTP'
        icon_url:
          description: >-
            The URL of the icon to display next to the title
          type: string
          example: 'https://example-icon.png'
    WidgetMetadataResponse:
      description: >-
        An object containing information about the widget
      type: object
      properties:
        template:
          type: string
          enum:
            - summary_with_details_v0
          example: 'summary_with_details_v0'
        metadata:
          type: object
          properties:
            error:
              description: >-
                The error that should be displayed to the user
              type: string
              example: 'The resource cannot be accessed'
            title:
              description: >-
                The text to show in the title of the widget. Max length of 200 chars.
              type: string
              required: true
              example: 'Status'
            fields:
              description: >-
                An array of WidgetField objects. A widget must contain at least 1 field and no more than 5.
              type: array
              required: true
              items:
                $ref: '#/components/schemas/WidgetField'
            subtitle:
              description: >-
                The text to show under the title of the widget, next to "Open in {App Name}". If not provided, the
                resource_name from the app definition will be used as default
              type: string
              example: 'Custom App Story · Open in Custom App'
            subicon_url:
              description: >-
                The URL of the subicon next to the subtitle . If not provided, no icon will be shown
              type: string
              example: 'https://example-icon.png'
            footer:
              $ref: '#/components/schemas/WidgetFooter'
            num_comments:
              description: >-
                The number of comments to display on the lower right corner of the widget. If not provided, no comment
                count will be shown
              type: integer
              example: 2
    WidgetFooter:
      description: >-
        Contains the information to display a footer on the widget
      type: object
      properties:
        footer_type:
          description: The type of widget footer.
          type: string
          enum:
            - custom_text
            - updated
            - created
          example: 'custom_text'
        info:
          description: >-
            *Conditional* Only relevant for WidgetFooters of type `custom_text`.
            The text to show in the footer.
          type: string
          example: 'This is a custom footer message'
        icon_url:
          description: >-
            *Conditional* Only relevant for WidgetFooters of type `custom_text`.
            The icon to show in the footer next to the text. If not provided, no
            icon will be shown.
          type: string
          example: 'https://example-icon.png'
        last_updated_at:
          description: >-
            *Conditional* Only relevant for WidgetFooters of type `updated`.
            The time (in ISO-8601 date format) to show in the footer.
          type: string
          example: '2012-02-22T02:06:58.147Z'
        created_at:
          description: >-
            *Conditional* Only relevant for WidgetFooters of type `created`.
            The time (in ISO-8601 date format) to show in the footer.
          type: string
          example: '2012-02-22T02:06:58.147Z'
    WidgetField:
      description: >-
        Contains the information to display a field on the widget
      type: object
      properties:
        name:
          description: >-
            The text to show in the title of the field.
          type: string
          example: 'Status'
        type:
          description: The type of widget field.
          type: string
          enum:
            - pill
            - text_with_icon
            - datetime_with_icon
          example: 'pill'
        text:
          description: >-
            *Conditional*. Only relevant for WidgetFields of type
            `pill` and `text_with_icon`. The text to show in the field. Max size of 40 char.
          type: string
          example: 'To Do'
        color:
          description: >-
            *Conditional*. Only relevant for WidgetFields of type
            `pill`. The color of the pill.
          type: string
          enum:
            - none
            - red
            - orange
            - yellow-orange
            - yellow
            - yellow-green
            - green
            - blue-green
            - aqua
            - blue
            - indigo
            - purple
            - magenta
            - hot-pink
            - pink
            - cool-gray
          example: 'gray'
        icon_url:
          description: >-
            *Conditional*. Only relevant for WidgetFields of type
            `text_with_icon` and `datetime_with_icon`. The URL of the icon to
            display next to the text or time.
          type: string
          example: 'https://example-icon.png'
        timestamp:
          description: >-
            *Conditional*. Only relevant for WidgetFields of type `datetime_with_icon`.
            The time (in ISO-8601 date format) to display next to the icon.
          type: string
          example: '2012-02-22T02:06:58.147Z'
paths:
  /{widget_metadata_url}:
    parameters:
      - $ref: '#/components/parameters/resource_url'
      - $ref: '#/components/parameters/workspace'
      - $ref: '#/components/parameters/task'
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/attachment'
      - $ref: '#/components/parameters/expires_at'
    get:
      summary: Get widget metadata
      description: >-
        Get the metadata from the App Server to render a widget.
      tags:
        - App Widgets
      operationId: getWidgetMetadata
      responses:
        200:
          description: Successfully retrieved the metadata for a single widget.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WidgetMetadataResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        418:
          $ref: '#/components/responses/Unauthorized'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{resource_attach_url}:
    post:
      summary: Attach resource
      description: >-
        When the user attaches a resource URL to a task, Asana will make a signed request to the specified
        resource_attach_url in the capabilities. Information about the attached resource should be included in the
        response.
      tags:
        - App Widgets
      operationId: attachResource
      requestBody:
        description: >-
          Request to attach a resource.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachResourceRequest'
      responses:
        200:
          description: Successfully attached the resource to the given object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachedResourceResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{form_metadata_url}:
    parameters:
      - $ref: '#/components/parameters/workspace'
      - $ref: '#/components/parameters/task'
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/expires_at'
    get:
      summary: Get form metadata
      description: >-
        Get the metadata from the App Server to render a form.
      tags:
        - App Forms
      operationId: getFormMetadata
      responses:
        200:
          description: Successfully retrieved the metadata for a single form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{on_change_callback}:
    post:
      summary: On change callback
      description: >-
        The callback request made to an App Server when a watched field's value changes within a form.
      tags:
        - App Forms
      operationId: onFormChange
      requestBody:
        description: >-
          Request to notify of an on change event.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormOnChangeRequest'
      responses:
        200:
          description: Successfully returned the new state of the form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        400:
          description: Something was wrong with the form data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{on_submit_callback}:
    post:
      summary: On submit callback
      description: >-
        The callback request made to an App Server when a form is submitted.
      tags:
        - App Forms
      operationId: onFormSubmit
      requestBody:
        description: >-
          Request to notify of a form submission.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FormSubmissionRequest'
      responses:
        200:
          description: Successfully attached the resource created by the form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachedResourceResponse'
        400:
          description: Something was wrong with the form data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{resource_search_url}:
    post:
      summary: Resource Search
      description: >-
        The search request made to an App Server when the search field is submitted.
      tags:
        - App Resource Searching
      operationId: resourceSearch
      requestBody:
        description: >-
          Request to attach a resource with a user given `value`.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AttachResourceRequest'
      responses:
        200:
          description: Successfully attached the resource created by the form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachedResourceResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{run_action_url}:
    post:
      summary: Run action
      description: >-
        The request made when an action is triggered.
      tags:
        - App Rules
      operationId: runAction
      requestBody:
        description: >-
          Request to notify of an action running.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RunActionRequest'
      responses:
        200:
          description: Successfully attached the resource created by the form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RanActionResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        410:
          $ref: '#/components/responses/Gone'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{action.metadata_url}:
    parameters:
      - $ref: '#/components/parameters/action'
      - $ref: '#/components/parameters/action_type'
      - $ref: '#/components/parameters/project'
      - $ref: '#/components/parameters/workspace'
      - $ref: '#/components/parameters/user'
      - $ref: '#/components/parameters/expires_at'
    get:
      summary: Get action metadata
      description: >-
        When a user has navigated to the Custom Rule Builder UI and selected an App Action (either through the sidebar
        or via a Rule Preset), Asana will make a request to the app to get the configuration form definition
        for the chosen app action. This will initiate the flow to configure a new app action or edit the configuration
        of an existing app action. This is the endpoint and schema for updating app actions; app triggers (V2) will be
        analogous.
      tags:
        - App Rules
      operationId: getActionMetadata
      responses:
        200:
          description: Successfully retrieved the metadata for a single action.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        400:
          $ref: '#/components/responses/BadRequest'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{action.on_change_callback}:
    post:
      summary: On action change callback
      description: >-
        The callback request made to an App Server when a watched field's value changes within an action form.
      tags:
        - App Rules
      operationId: onActionFormChange
      requestBody:
        description: >-
          Request to notify of an on change event.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionFormOnChangeRequest'
      responses:
        200:
          description: Successfully returned the new state of the form.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        400:
          description: Something was wrong with the form data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'
  /{action.on_submit_callback}:
    post:
      summary: On action submit callback
      description: >-
        The form is submitted when the user chooses to create their Rule. Asana will create the app action data model
        object and make a signed request to the on_submit_callback specified in the form metadata returned from the
        fetch/update app rule form endpoints. Information about the created app action should be included in the
        response if it was successfully created. This is the endpoint and schema for updating app actions; app triggers
        (V2) will be analogous.
      tags:
        - App Rules
      operationId: onActionFormSubmit
      requestBody:
        description: >-
          Request to submit an action form.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActionFormSubmissionRequest'
      responses:
        200:
          description: Successfully handled form submission.
        400:
          description: Something was wrong with the form data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FormMetadataResponse'
        401:
          $ref: '#/components/responses/Unauthorized'
        403:
          $ref: '#/components/responses/Forbidden'
        404:
          $ref: '#/components/responses/NotFound'
        500:
          $ref: '#/components/responses/InternalServerError'