Lightdash Move content API

The Move content API from Lightdash — 2 operation(s) for move content.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

lightdash-move-content-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Lightdash AiAgents Move content API
  version: 0.3156.1
  description: 'Open API documentation for all public Lightdash API endpoints. # Authentication Before you get started, you might need to create a Personal Access Token to authenticate via the API. You can create a token by following this guide: https://docs.lightdash.com/references/personal_tokens

    '
  license:
    name: MIT
  contact:
    name: Lightdash Support
    email: support@lightdash.com
    url: https://docs.lightdash.com/help-and-contact/contact/contact_info/
servers:
- url: /
tags:
- name: Move content
paths:
  /api/v2/content/{projectUuid}/move:
    post:
      operationId: Move content
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Move a single item (Chart, Dashboard, Space) to another space
      summary: Move content
      tags:
      - Move content
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiContentActionBody_ContentActionMove_'
  /api/v2/content/bulk-action/{projectUuid}/move:
    post:
      operationId: Bulk move content
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiSuccessEmpty'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorPayload'
      description: Move multiple items (Charts, Dashboards, Spaces) to another space
      summary: Bulk move content
      tags:
      - Move content
      security: []
      parameters:
      - in: path
        name: projectUuid
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiContentBulkActionBody_ContentActionMove_'
components:
  schemas:
    ContentActionMove:
      properties:
        targetSpaceUuid:
          type: string
          nullable: true
        type:
          type: string
          enum:
          - move
          nullable: false
      required:
      - targetSpaceUuid
      - type
      type: object
    ItemPayload:
      anyOf:
      - properties:
          source:
            $ref: '#/components/schemas/ChartSourceType'
          contentType:
            $ref: '#/components/schemas/ContentType.CHART'
          uuid:
            type: string
        required:
        - source
        - contentType
        - uuid
        type: object
      - properties:
          contentType:
            $ref: '#/components/schemas/ContentType.DASHBOARD'
          uuid:
            type: string
        required:
        - contentType
        - uuid
        type: object
      - properties:
          contentType:
            $ref: '#/components/schemas/ContentType.SPACE'
          uuid:
            type: string
        required:
        - contentType
        - uuid
        type: object
      - properties:
          contentType:
            $ref: '#/components/schemas/ContentType.DATA_APP'
          uuid:
            type: string
        required:
        - contentType
        - uuid
        type: object
    ApiContentBulkActionBody_ContentActionMove_:
      properties:
        action:
          $ref: '#/components/schemas/ContentActionMove'
        content:
          items:
            $ref: '#/components/schemas/ItemPayload'
          type: array
      required:
      - action
      - content
      type: object
    ContentType.DATA_APP:
      enum:
      - data_app
      type: string
    AnyType:
      description: 'This AnyType is an alias for any

        The goal is to make it easier to identify any type in the codebase

        without having to eslint-disable all the time

        These are only used on legacy `any` types, don''t use it for new types.

        This is added on a separate file to avoid circular dependencies.'
    ApiErrorPayload:
      properties:
        error:
          properties:
            data:
              $ref: '#/components/schemas/AnyType'
              description: Optional data containing details of the error
            message:
              type: string
              description: A friendly message summarising the error
            name:
              type: string
              description: Unique name for the type of error
            statusCode:
              type: number
              format: integer
              description: HTTP status code
          required:
          - name
          - statusCode
          type: object
        status:
          type: string
          enum:
          - error
          nullable: false
      required:
      - error
      - status
      type: object
      description: 'The Error object is returned from the api any time there is an error.

        The message contains'
    ApiSuccessEmpty:
      properties:
        results: {}
        status:
          type: string
          enum:
          - ok
          nullable: false
      required:
      - status
      type: object
    ContentType.CHART:
      enum:
      - chart
      type: string
    ContentType.SPACE:
      enum:
      - space
      type: string
    ChartSourceType:
      enum:
      - dbt_explore
      - sql
      type: string
    ContentType.DASHBOARD:
      enum:
      - dashboard
      type: string
    ApiContentActionBody_ContentActionMove_:
      properties:
        action:
          $ref: '#/components/schemas/ContentActionMove'
        item:
          $ref: '#/components/schemas/ItemPayload'
      required:
      - action
      - item
      type: object
  securitySchemes:
    session_cookie:
      type: apiKey
      in: cookie
      name: connect.sid
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: Value should be 'ApiKey <your key>'