---
title: "POST /api/jobs/dictionary"
method: POST
path: "/api/jobs/dictionary"
tags: ["Job Manager APIs"]
---

# POST /api/jobs/dictionary

`POST /api/jobs/dictionary`

<b>Allowed user roles:</b><br/><ul><li>sdzAdmin</li></ul><br/><br/>load (upsert) a dictionary into the SDZ using 1) POST with JSON body with dictionary and emailResultsTo (optional); or 2) MULTIPART POST with dictionary file and emailResultsTo (optional) as form fields

## Query parameters

- `emailResultsTo` string[]

## Request body

- DictionaryUploadJobRequestPublic
  - `dictionary` DictionaryPublic, required
    - `name` string, required
    - `description` string
    - `displayName` string
    - `groupName` string
    - `layoutMetadata` object
    - `undefinedAttributesAction` 'KEEP' | 'REMOVE' | 'ERROR', required
    - `attributes` AttributeDefPublic[], required
      - `name` string, required
      - `description` string
      - `displayName` string
      - `datatype` 'STRING' | 'INTEGER' | 'LONG' | 'STRING_REFERENCE' | 'INTEGER_REFERENCE' | 'LONG_REFERENCE' | 'BOOLEAN' | 'DECIMAL' | 'DATE' | 'DATETIME' | 'ENUM' | 'FINGERPRINT' | 'CLOB' | 'BLOB' | 'OBJECT' | 'STRING_ARRAY' | 'INTEGER_ARRAY' | 'LONG_ARRAY' | 'STRING_REFERENCE_ARRAY' | 'INTEGER_REFERENCE_ARRAY' | 'LONG_REFERENCE_ARRAY' | 'BOOLEAN_ARRAY' | 'DECIMAL_ARRAY' | 'DATE_ARRAY' | 'DATETIME_ARRAY' | 'ENUM_ARRAY' | 'BLOB_ARRAY' | 'OBJECT_ARRAY' | 'VECTOR', required
      - `required` boolean
      - `precision` integer
      - `defaultValue` string
      - `min` number
      - `max` number
      - `regex` string
      - `enumValues` string[], required
      - `fingerprintAttributes` string[], required
      - `vectorAttributes` string[], required
      - `referenceDictionaryName` string
    - `indexes` IndexDefPublic[]
      - `name` string, required
      - `attributes` string[], required
      - `type` 'PRIMARY' | 'UNIQUE' | 'NORMAL' | 'KEYWORD' | 'FULL' | 'VECTOR', required
      - `numDimensions` integer, required
      - `partialFilterTql` string
    - `properties` object
  - `emailResultsTo` string[]

## Response `200`

OK

- DictionaryUploadJobPublic
  - `jobId` string, uuid, required
  - `name` string, required
  - `status` 'NEW' | 'QUEUED' | 'RUNNING' | 'CANCELLED' | 'COMPLETED_ERROR' | 'COMPLETED_SUCCESS' | 'INCOMPLETE_ERROR', required
  - `jobCreated` string, date-time, required
  - `jobQueued` string, date-time
  - `jobStarted` string, date-time
  - `jobCompleted` string, date-time
  - `emailRecipients` string[]
  - `timeout` integer
  - `timeoutUnit` 'NANOSECONDS' | 'MICROSECONDS' | 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS', required
  - `results` JobResultsPublic
    - `results` object
    - `error` unknown
    - `errorString` string
    - `errorStrings` string[]
  - `customerName` string, required
  - `sdzName` string, required
  - `effectiveId` string, uuid, required
  - `loggedInId` string, uuid, required
  - `mdc` object, required
  - `originalFilename` string
  - `key` string
  - `dictName` string

---

[API](https://skmtc.net/burstiq/apis/lifegraph-apis.md) · [All operations](https://skmtc.net/burstiq/apis/lifegraph-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/burstiq/lifegraph-apis/revisions/381306ef1fcd/schema)