ROrossum
Engine Field

List engine fields

Changed on

Retrieve all engine field objects.

get/api/v1/engine_fields

Request

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",
      "created_by": "https://example.rossum.app/api/v1/users/10775",
      "created_at": "2021-04-26T10:08:03.856648Z",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

  • e050e5c8602cRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • f1b5a910991dRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added subschema #2 to the / response property allOf list for the response status