Opendock Nova (Neutron) API

Production REST API at https://neutron.opendock.com (staging neutron.staging.opendock.com) powering the Opendock Nova warehouse dock-scheduling platform. 151 endpoints covering warehouses, docks, loadtypes, appointments, carriers, users, organizations, custom-forms and custom-tags, gates, yards, hours of operation, ETAs, reports, billing, asset tracking, and integrations. Authenticated with JWT bearer tokens in the Authorization header; complementary Subspace WebSocket API streams Created/Updated/Deleted events for near-real-time integrations.

Opendock Nova (Neutron) API is one of 2 APIs that Loadsmart publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Dock Scheduling, Warehouse, Appointments, Yard Management, and Carriers. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

OpenAPI Specification

loadsmart-opendock-openapi.yml Raw ↑
openapi: 3.0.0
paths:
  /:
    get:
      operationId: AppController_getBase
      summary: Shows a greeting message.
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: string
      tags:
      - General
  /version:
    get:
      operationId: AppController_getVersion
      summary: Shows the current Nova version.
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VersionDto'
      tags:
      - General
  /app-environment:
    get:
      operationId: AppController_getAppEnvironment
      summary: Gets public environment data for the app.
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppEnvironmentDto'
      tags:
      - General
  /warehouse/{id}:
    get:
      operationId: getOneBaseWarehouseControllerWarehouse
      summary: Retrieve a single Warehouse
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Warehouse'
      tags:
      - Warehouses
      security:
      - bearer: []
    patch:
      operationId: updateOneBaseWarehouseControllerWarehouse
      summary: Update a single Warehouse
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWarehouseDto'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Warehouse'
      tags:
      - Warehouses
      security:
      - bearer: []
    delete:
      operationId: deleteOneBaseWarehouseControllerWarehouse
      summary: Delete a single Warehouse
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Delete one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Warehouse'
      tags:
      - Warehouses
      security:
      - bearer: []
  /warehouse:
    get:
      operationId: getManyBaseWarehouseControllerWarehouse
      summary: Retrieve multiple Warehouses
      parameters:
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: s
        description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: string
      - name: filter
        description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: or
        description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: sort
        description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: limit
        description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: page
        description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedDto'
                - properties:
                    entity:
                      type: string
                      example: Warehouse
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Warehouse'
      tags:
      - Warehouses
      security:
      - bearer: []
    post:
      operationId: createOneBaseWarehouseControllerWarehouse
      summary: Create a single Warehouse
      description: '**This is a billable event.** Creating a new warehouse implies additional subscription costs. Please reach
        out to your CSA for more information.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateWarehouseDto'
      responses:
        '201':
          description: Get create one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Warehouse'
      tags:
      - Warehouses
      security:
      - bearer: []
  /warehouse/{id}/custom-forms:
    patch:
      operationId: WarehouseController_updateLoadTypesCustomForms
      summary: Update custom forms for load types
      description: "Updates existing custom forms' names and their associations with load types.\n\n    This endpoint allows\
        \ you to:\n    - Modify the display name of custom forms\n    - Change which load types trigger these forms\n    -\
        \ Update form visibility settings\n\n    For Delete a loadtype custom form, please refer to custom-forms/flow endpoint\
        \ sending the flowId to delete all related flows/forms.\n    Note: To modify the fields within forms, use the '/custom-forms/form-field'\
        \ endpoint."
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLoadTypesCustomFormsDto'
      responses:
        '200':
          description: Custom forms successfully updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/'
      tags:
      - Warehouses
      - Custom Forms - Triggers
      security:
      - bearer: []
    post:
      operationId: WarehouseController_createLoadTypesCustomForms
      summary: Create custom forms for load types
      description: "This endpoint creates custom forms that are triggered when appointments are booked with specific load\
        \ types.\n\n    The system will generate three forms:\n    - One for the Warehouse App\n    - One for the Carrier\
        \ App\n    - One for all platforms, including API integrations\n\n    Initially, forms are created without fields.\
        \ After creation, you must configure the form fields using the '/custom-forms/form-field' endpoint.\n\n    For complete\
        \ form management, refer to the Custom Forms section, starting with the '/custom-forms/trigger' endpoint."
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLoadTypesCustomFormsDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/'
      tags:
      - Warehouses
      - Custom Forms - Triggers
      security:
      - bearer: []
  /warehouse/{id}/get-hours-of-operation:
    post:
      operationId: WarehouseController_getHOOPs
      summary: Get open hours for set of docks in the warehouse
      description: "This endpoint will return an array of docks and their computed open hours taking into consideration\n\
        \    closed days and the warehouse hours. <br /><br />\n    If dockIds are supplied, then it will filter the returned\
        \ array down to those docks. <br /><br />\n    This will always return a full weeks worth of hours around the start/end\
        \ dates provided."
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetHoursOfOperationDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DockHoursOfOperation'
      tags:
      - Warehouses
      security:
      - bearer: []
  /user/invite:
    post:
      operationId: UserController_invite
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
  /user/{id}:
    get:
      operationId: getOneBaseUserControllerUser
      summary: Retrieve a single User
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
    delete:
      operationId: deleteOneBaseUserControllerUser
      summary: Delete a single User
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
    patch:
      operationId: updateOneBaseUserControllerUser
      summary: Update a single User
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
  /user:
    get:
      operationId: getManyBaseUserControllerUser
      summary: Retrieve multiple Users
      parameters:
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: s
        description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: string
      - name: filter
        description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: or
        description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: sort
        description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: limit
        description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: page
        description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedDto'
                - properties:
                    entity:
                      type: string
                      example: User
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
  /user/email-available/{email}:
    get:
      operationId: UserController_isEmailAvailable
      parameters:
      - name: email
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: boolean
      tags:
      - Users
      security:
      - bearer: []
  /user/change-password:
    post:
      operationId: UserController_changePassword
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePasswordDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Users
      security:
      - bearer: []
  /user/accept-tc:
    post:
      operationId: UserController_acceptTC
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Users
      security:
      - bearer: []
  /carrier:
    get:
      operationId: getManyBaseCarrierControllerUser
      summary: Retrieve multiple Users
      parameters:
      - name: onlyIncludeFavorites
        required: false
        in: query
        description: Filters returned carriers to only include "Favorite" carriers.
        schema:
          type: boolean
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: s
        description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: string
      - name: filter
        description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: or
        description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: sort
        description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: limit
        description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: page
        description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedDto'
                - properties:
                    entity:
                      type: string
                      example: User
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/User'
      tags:
      - Carrier Users
      security:
      - bearer: []
    post:
      operationId: createOneBaseCarrierControllerUser
      summary: Create a single User
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCarrierDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedDto'
                - properties:
                    entity:
                      type: string
                      example: User
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/User'
        '201':
          description: Get create one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/booked:
    get:
      operationId: CarrierController_getManyBooked
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/{id}/org-carrier-settings:
    get:
      operationId: CarrierController_getOrgCarrierSettingsOrg
      summary: ''
      deprecated: true
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgCarrierSettingsDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
    patch:
      operationId: CarrierController_updateOrgCarrierSettings
      summary: ''
      deprecated: true
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgCarrierSettingsDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgCarrierSettingsDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/org-carrier-settings/{id}:
    get:
      operationId: CarrierController_getOrgCarrierSettingsCarrier
      summary: ''
      deprecated: true
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgCarrierSettingsDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/preview:
    post:
      operationId: CarrierController_getCarrierPreviewToken
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewAsCarrierResponseDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/settings:
    get:
      operationId: CarrierController_getCarrierSettings
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewAsCarrierResponseDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/settings/favorite-warehouses:
    get:
      operationId: CarrierController_getFavoriteWarehouses
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewAsCarrierResponseDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
    post:
      operationId: CarrierController_addFavoriteWarehouse
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCarrierFavoriteWarehouseDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewAsCarrierResponseDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
    delete:
      operationId: CarrierController_removeFavoriteWarehouse
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveCarrierFavoriteWarehouseDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPreviewAsCarrierResponseDto'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /carrier/{id}:
    get:
      operationId: getOneBaseCarrierControllerUser
      summary: Retrieve a single User
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
      tags:
      - Carrier Users
      security:
      - bearer: []
  /org/{id}:
    get:
      operationId: getOneBaseOrgControllerOrg
      summary: Retrieve a single Org
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Org'
      tags:
      - Orgs
      security:
      - bearer: []
    patch:
      operationId: updateOneBaseOrgControllerOrg
      summary: Update a single Org
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrgDto'
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Org'
      tags:
      - Orgs
      security:
      - bearer: []
  /org/{orgId}/report-search:
    post:
      operationId: OrgController_createReportSearch
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReportSearchDto'
      responses:
        '201':
          description: ''
      tags:
      - Orgs
      security:
      - bearer: []
    get:
      operationId: OrgController_getAllReportSearches
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportSearchResponseDto'
      tags:
      - Orgs
      security:
      - bearer: []
  /org/{orgId}/report-search/{reportSearchKey}:
    patch:
      operationId: OrgController_updateReportSearch
      parameters:
      - name: reportSearchKey
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReportSearchDto'
      responses:
        '200':
          description: ''
      tags:
      - Orgs
     

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