Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

limit Results limit per page, default 250
Term search
RequestGET /editor/plugins_termportal_data/search
Params

query * Required. Search query. Wildcard characters '*' and '?' are supported


language Required. ID of language which searched terms belong to.

start Required. Results offset, default 0

limit Requred. Results limit per page, default 250

clientIds Optional. Comma-separated list of integers, representing client IDs.


collectionIds Optional. Comma-separated list of integers, representing collection.

processStatus Optional. Comma-separated list of any of 'unprocessed', 'provisionallyProcessed', 'finalized' and 'rejected'.

noTermDefinedFor Optional. ID of language, that term is not yet defined for

attr-x Attribute search, where 'x' - is the key in filterWindow.attributes (see Client app setup data response structure). If param name is mentioned among request params but no param value given, the search will return the terms having such attributes defined even with despite having empty value. If param value is given, wildcard characters '*' and '?' are supported, first for multichar and second for single-char purpose. Multiple attributes search are supported, just use attr-x, attr-y etc

termEntryTbxId Optional. Partial Partially known tbx ids are supported


termTbxId Optional. Partial Partially known tbx ids are supported

tbxCreatedBy Optional. ID of person who was specified as creator in imported tbx data (see filterWindow.tbxCreatedBy array in Client app setup data response structure)

tbxCreatedGt Optional. Date Should be used to search terms created since certaing date, inclusively, according to imported tbx data. Value is expected in format yyyy-mm-dd is expected. Can be used with tbxCreatedLt if search by date range is needed.

tbxCreatedLt Optional. Date . Should be used to search terms created until certaing date, inclusively, according to imported tbx data. Value is expected in format yyyy-mm-dd is expected. Can be used with tbxCreatedGt if search by date range is needed.

tbxCreatedAt Optional. Exact date of creation specified in imported tbx data. Date in format yyyy-mm-dd is expected. This can only be used if none of tbxCreatedGt or tbxCreatedLt are given

tbxUpdatedBy Optional. ID of person who was specified as updater in imported tbx data (see filterWindow.tbxUpdatedBy array in Client app setup data response structure)

tbxUpdatedGt Optional. Date Should be used to search terms updated since certaing date, inclusively, according to imported tbx data. Value is expected in format yyyy-mm-dd is expected. Can be used with tbxUpdatedLt if search by date range is needed.

tbxUpdatedLt Optional. Date . Should be used to search terms updated until certaing date, inclusively, according to imported tbx data. Value is expected in format yyyy-mm-dd is expected. Can be used with tbxUpdatedGt if search by date range is needed.


tbxUpdatedAt Optional. Exact date of creation specified in imported tbx data. Date in format yyyy-mm-dd is expected

page Page number, default 1

start Results offset, default 0

. This can only be used if none of tbxUpdatedGt or tbxUpdatedLt are given


Provides access to the Term collections available in the application.

...