API referansı İngilizce yayımlanır.

Preview an organization import (legacy route)

POST/api/companies/import/preview
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Preview an organization import (legacy route).

Accepts either the inline JSON body (application/json) or the raw organization package uploaded as a compressed zip (multipart/form-data with a package file field plus a JSON meta field carrying the other import fields, or a bare application/zip body with the meta JSON in the meta query parameter). The zip is unzipped server-side into the same { source: { type: "inline", ... } } bundle the JSON body carries.

Yetkilendirme

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Anahtarlar nasıl çalışır.

İstek gövdesi

application/json · zorunlu

sourceobjectZorunlu
includeobjectİsteğe bağlı
include.companybooleanİsteğe bağlı
include.agentsbooleanİsteğe bağlı
include.projectsbooleanİsteğe bağlı
include.issuesbooleanİsteğe bağlı
include.skillsbooleanİsteğe bağlı
targetobjectZorunlu
agentsstring | array<string>İsteğe bağlı
collisionStrategystringİsteğe bağlıone of: "rename", "skip", "replace"
nameOverridesobject<string, string>İsteğe bağlı
selectedFilesarray<string>İsteğe bağlı

Yanıtlar

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Organizations