Sign in
Engine Field

List engine fields

Retrieve all engine field objects.

get/api/v1/engine_fields

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

enginestring

Filter by engine URL or ID.

namestring

Object name filter

usedboolean

Filter engine fields used (or not used) in any schema in queues using this engine.

ordering'id' | '-id' | 'engine' | '-engine' | 'name' | '-name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "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