Import Documents From Source

Trigger a full import of every document under path for an existing GED connexion.

Plain one-off import by default (unchanged behavior). If schedules is provided, also creates/updates the DocumentSourceSync target for this source+path (with its whole schedule set replaced by what's submitted) and runs the first sync through it instead — reusing the same root folder incrementally on every later scheduled run.

Creating documents is admin/integrator-only — see require_document_org_manager.

Authorization

JwtAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

source_id*Source Id

Formatuuid

path?Path

Default"/"

parent_folder_name*Parent Folder Name

Name of the root GED folder for this import — always required.

Length1 <= length

selected_paths?array<string>|

Discovery paths (files and/or folders) to import — omit or leave empty to import everything found under path (existing behavior). A selected folder path brings in its whole subtree.

schedules?array<>|

Omit for a one-off import (existing ad-hoc behavior). Provide 1+ timing rules to set up (or replace) recurring sync for this source+path — e.g. daily at 10:00 AND weekly on Wednesday at 12:00.

Response Body

`application/json`

curl -X POST "https://example.com/documents/import-from-source" \  -H "Content-Type: application/json" \  -d '{    "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",    "parent_folder_name": "string"  }'

{  "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",  "correlation_id": "string",  "document_id": "b792e8ae-2cb4-4209-85b9-32be4c2fcdd6",  "sync_id": "15e7d8f3-40c7-475e-b8d4-500e21d28160",  "message": "string"}