---
title: "Import a project document from a JSON document"
method: POST
path: "/automation-studio/projects/import"
tags: ["Automation Studio"]
---

# Import a project document from a JSON document

`POST /automation-studio/projects/import`

## Request

- Base URL: `https://example.itential.io`
- URL: `https://example.itential.io/automation-studio/projects/import`
- Auth: none declared

Imports a project document from a JSON document.

## Request body

- object
  - `project` AutomationStudioProjectsExportV1: An exported project document
    - `_id` string, required: A string representation of a MongoDB ObjectId
    - `iid` integer, required: Incrementing integer ID
    - `name` string, required: Project name
    - `description` string, required: A free-form block of text for describing project intent and function
    - `thumbnail` string, required: Base64 string encoding binary image data for project thumbnail
    - `backgroundColor` string, required: Thumbnail background color
    - `components` AutomationStudioProjectsExportV1ComponentsItems[], required
      - `iid` integer, required: Incrementing integer ID
      - `type` 'workflow' | 'jsonForm' | 'mopAnalyticTemplate' | 'mopCommandTemplate' | 'template' | 'transformation', required: String denoting the type of component
      - `reference` string, required
      - `folder` string, required
      - `document` AutomationStudioProjectsExportV1ComponentsItemsDocument, required: Full component document
    - `referencedComponentHashes` AutomationStudioProjectsExportV1ReferencedComponentHashesItems[], nullable
      - `type` string, required
      - `reference` string, required
      - `name` string, required: The last known name of the exported document
      - `hash` string, required
      - `query` AutomationStudioProjectsExportV1ReferencedComponentHashesItemsQuery
    - `referencedComponents` AutomationStudioProjectsExportV1ReferencedComponentsItems[], nullable
      - `type` string, required
      - `reference` string, required
      - `document` AutomationStudioProjectsExportV1ReferencedComponentsItemsDocument, required: Full referenced component document
    - `folders` AutomationStudioProjectsExportV1FoldersItems[]
      - union
        - AutomationStudioProjectsExportV1FoldersItems0
          - `nodeType` 'folder' | 'component', required: String denoting the nodeType of the folder node
          - `name` string, required: Folder name
          - `children` AutomationStudioProjectsExportV1FoldersItemsOneOf0ChildrenItems[], required
            - union
              - …
        - AutomationStudioProjectsExportV1FoldersItems1
          - `iid` integer, required: Incrementing integer ID
          - `nodeType` 'folder' | 'component', required: String denoting the nodeType of the folder node
          - `type` 'workflow' | 'jsonForm' | 'mopAnalyticTemplate' | 'mopCommandTemplate' | 'template' | 'transformation': String denoting the type of component
          - `reference` string
    - `created` string, date-time, required: ISO Date String
    - `createdBy` unknown, required
    - `lastUpdated` string, date-time, required: ISO Date String
    - `lastUpdatedBy` unknown, required
    - `versionHistory` AutomationStudioProjectsExportV1VersionHistoryItems[]
      - `versionNumber` integer, required
      - `commitMessage` string, required
      - `author` string, required
      - `branchName` string, required
  - `conflictMode` 'overwrite' | 'insert-new'
  - `skipReferenceValidation` boolean: If true, validations will not be run against references.
  - `assignNewReferences` boolean: This being true would indicate that the imported project is part of a clone action.

## Response `200`

Import result

- AutomationStudioImportProjectResponse200
  - `message` string
  - `data` AutomationStudioProjectsHttp: Project data as it is sent back from get and search endpoints
    - `_id` string: A string representation of a MongoDB ObjectId
    - `iid` integer: Incrementing integer ID
    - `name` string: Project name
    - `description` string: A free-form block of text for describing project intent and function
    - `members` AutomationStudioProjectsHttpMembersItems[]
      - `type` 'account' | 'group', required
      - `reference` string, required: A string representation of a MongoDB ObjectId
      - `role` 'owner' | 'editor' | 'operator' | 'viewer', required
      - `missing` boolean
      - `username` string
      - `name` string
      - `provenance` string
    - `accessControl` AutomationStudioProjectsHttpAccessControl
      - `read` string[], required
      - `execute` string[], required
      - `write` string[], required
      - `manage` string[], required
    - `componentIidIndex` integer: Read-only property providing incrementing integer ID values for child components within a project
    - `components` AutomationStudioProjectsHttpComponentsItems[]: A list of member components in the project
      - `iid` integer: Incrementing integer ID
      - `type` 'workflow' | 'jsonForm' | 'mopAnalyticTemplate' | 'mopCommandTemplate' | 'template' | 'transformation': String denoting the type of component
      - `reference` string
      - `folder` string
    - `folders` AutomationStudioProjectsHttpFoldersItems[]: A list of folders and their members
      - union
        - AutomationStudioProjectsHttpFoldersItems0
          - `nodeType` 'folder' | 'component', required: String denoting the nodeType of the folder node
          - `name` string, required: Folder name
          - `children` AutomationStudioProjectsHttpFoldersItemsOneOf0ChildrenItems[], required
            - union
              - …
        - AutomationStudioProjectsHttpFoldersItems1
          - `iid` integer, required: Incrementing integer ID
          - `nodeType` 'folder' | 'component', required: String denoting the nodeType of the folder node
          - `type` 'workflow' | 'jsonForm' | 'mopAnalyticTemplate' | 'mopCommandTemplate' | 'template' | 'transformation': String denoting the type of component
          - `reference` string
    - `created` string, date-time: ISO Date String
    - `createdBy` unknown
    - `lastUpdated` string, date-time: ISO Date String
    - `lastUpdatedBy` unknown
    - `versionHistory` AutomationStudioProjectsHttpVersionHistoryItems[]
      - `versionNumber` integer, required
      - `commitMessage` string, required
      - `author` string, required
      - `branchName` string, required
    - `gitConfiguration` AutomationStudioProjectsHttpGitConfiguration
      - `connectionType` 'GitHub' | 'GitLab', required
      - `repositoryPath` string, required
      - `branchName` string, required
      - `projectPath` string, required
  - `metadata` AutomationStudioProjectsImportPostResponsesContentApplicationJsonSchemaMetadata

## Other responses

- `500`: Error response from API

## Changes

- **2026-10-31** `2095cc90e583`: 2 info
  - api tag `Automation Studio` added
  - api tag `automationStudio` removed

[Operation history](https://skmtc.dev/itential/apis/itential-2/changes/automation-studio/projects/import/post.md)

---

[API](https://skmtc.dev/itential/apis/itential-2.md) - [All operations](https://skmtc.dev/itential/apis/itential-2/llms.txt) - [OpenAPI document](https://skmtc.dev/itential/apis/itential-2/revisions/2095cc90e583?raw)