wcmc-its / ReCiter

ReCiter: an enterprise open source author disambiguation system for academic institutions
Apache License 2.0
46 stars 25 forks source link

Feature Generator by Group API should accept input of an array of person IDs #482

Closed paulalbert1 closed 3 years ago

paulalbert1 commented 3 years ago

Background

The existing Feature Generator by Group API /reciter/feature-generator/by/group currently returns a group of users according to these characteristics:

We need to allow curators the ability to return publications for an arbitrary, delimited list of person IDs independent of this list.

This will be used in Publication Manager so curators can input a group of person IDs (CWIDs), and curate those users' publications / report on them.

Requirement

We need three new fields:

UIDs

Authorized users can use Feature Generator by Group API to input a list of person IDs (uids). The IDs would be delimited.

The most common delimiters we can expect users to enter are: space, line break, tab, and comma. We can enforce the use of a particular delimiter if you wish, but it would be nice, if not required, to accommodate all of these. Note that for the Publication Manager use case, this could also be handled on the application side.

When the uids field is populated, all other fields are ignored – except maxArticlesPerPerson and totalStandardizedArticleScore.

Offset and limit

In addition, this API should be able to support OFFSET, LIMIT in the way that a SQL database does.

Offset is the count of the first record, and limit is the number of results returned.

sarbajitdutta commented 3 years ago

This is done - 3fb0e7ce8206590576e7fd2f7a4d588b296f5d8c

sarbajitdutta commented 3 years ago

Offset and limit is not required now and will revisit later.