Sign in
Engine Field

Update engine field

Update engine field object.

put/api/v1/engine_fields/{engineFieldID}

Path parameters

engineFieldIDinteger required

Engine field ID

Request body

idinteger

Engine Field object ID.

urlstring uri

Engine Field object URL.

enginestring uri

Engine object URL.

namestring

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

labelstring

Human readable name of the field.

type'string' | 'number' | 'date' | 'enum'

Type of the field.

subtypestring nullable

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

  • null: Plain text without any constraints
  • alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
  • numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
  • country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
  • currency_code: Three-letter currency code (ISO 4217). Example: USD.
  • iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
  • vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

  • null: Plain number
  • integer: Whole number. Example: 10.0 → 10.
  • rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
  • amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

  • null: Plain date
  • period_begin: Beginning of date period (fallback to first day of month)
  • period_end: End of date period (fallback to last day of month)
pre_trained_field_idstring nullable

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabularboolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

multiline'true' | 'false'

Multiline configuration. Allowed values are:

  • true: Field's parent is of type tuple
  • false: Header field

Example request

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engine_fields/3",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "document_id",
  "label": "Document ID",
  "type": "string",
  "subtype": "string",
  "pre_trained_field_id": "document_id",
  "multiline": "false"
}

Response

OK

idinteger required

Engine Field object ID.

urlstring uri required

Engine Field object URL.

enginestring uri required

Engine object URL.

namestring required

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

labelstring required

Human readable name of the field.

type'string' | 'number' | 'date' | 'enum' required

Type of the field.

subtypestring nullable required

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

  • null: Plain text without any constraints
  • alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
  • numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
  • country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
  • currency_code: Three-letter currency code (ISO 4217). Example: USD.
  • iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
  • vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

  • null: Plain number
  • integer: Whole number. Example: 10.0 → 10.
  • rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
  • amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

  • null: Plain date
  • period_begin: Beginning of date period (fallback to first day of month)
  • period_end: End of date period (fallback to last day of month)
pre_trained_field_idstring nullable required

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabularboolean required

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

multiline'true' | 'false' required

Multiline configuration. Allowed values are:

  • true: Field's parent is of type tuple
  • false: Header field

Example response

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engine_fields/3",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "document_id",
  "label": "Document ID",
  "type": "string",
  "subtype": "string",
  "pre_trained_field_id": "document_id",
  "multiline": "false"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.