entities

Returns a list of entity types

Returns list of supported entity types in the model. If you provide a profileId, it returns the list of entity types in the model used by the profileId. By default, the response lists all entity types by processor type.

get/entities/info

Request

  • Base URL: https://api.rosette.com/rest/v1
  • URL: https://api.rosette.com/rest/v1/entities/info
  • Auth: API key in header X-RosetteAPI-Key

Query parameters

profileIdstring

The id of the custom profile you are querying. This parameter is optional and for on-premise installations only.

perSubsourceSupportedEntityTypesboolean

When set to true returns the entity types by subsource in addition to by processor.

Response

OK

Changes

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