API referansı İngilizce yayımlanır.

Preview a completed organization import transfer

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

Preview a completed organization import transfer.

Runs the import preview against the assembled spool without consuming the transfer: the ledger run stays open and the parts stay spooled, so the subsequent apply reuses them instead of re-uploading. The JSON body carries the same fields as the multipart preview route's meta field (include, target, collisionStrategy, ...).

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.

Yol parametreleri

transferIdstringZorunluThe transfer's id.

İstek gövdesi

application/json · zorunlu

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.
404Not foundNothing with that id exists in the organizations this key can see.
409Parts are still missing, an apply is in progress, or the transfer was already appliedThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
410The transfer expired and its spooled parts were deleted
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