applyNgSchemaImport

Enqueue an ngSchema import (YAML/JSON/XML) as a background worker job. Returns the job id/name — track progress via the JobProgress subscription.

Type: JobResult!

Arguments

• awaitSearchIndex: Boolean! — default: false — Report the job as finished only once the imported objects are searchable. Off by default — the index catches up on its own and most imports do not wait for it.
• content: String! — Content for the operation.
• dryRun: Boolean! — default: false — Dry run for the operation.
• includeAccountingItems: Boolean! — default: false — Include accounting items for the operation.
• includeCategories: Boolean! — default: false — Include categories for the operation.
• includeCustomFields: Boolean! — default: false — Include custom fields for filtering or the operation.
• includeMembers: Boolean! — default: true — Include members for the operation.
• includeScalarFields: Boolean! — default: false — Include scalar fields for the operation.
• mode: NgSchemaImportModeEnum! — default: "SCHEMA" — Mode for the operation.
• namePrefix: String — Name prefix for the operation.
• targetParentID: UID — UID of the target parent to modify.

Example

mutation($awaitSearchIndex: Boolean!, $content: String!, $dryRun: Boolean!, $includeAccountingItems: Boolean!, $includeCategories: Boolean!, $includeCustomFields: Boolean!, $includeMembers: Boolean!, $includeScalarFields: Boolean!, $mode: NgSchemaImportModeEnum!, $namePrefix: String, $targetParentID: UID) {
  applyNgSchemaImport(awaitSearchIndex: $awaitSearchIndex, content: $content, dryRun: $dryRun, includeAccountingItems: $includeAccountingItems, includeCategories: $includeCategories, includeCustomFields: $includeCustomFields, includeMembers: $includeMembers, includeScalarFields: $includeScalarFields, mode: $mode, namePrefix: $namePrefix, targetParentID: $targetParentID) {
    errorData
    errorMessage
    errorType
    id
    message
    name
    status
  }
}