A generated flowground connector for the CORE API v2 API (version 2.0).
Generated from: https://api.apis.guru/v2/specs/core.ac.uk/2.0/swagger.json
Generated at: 2019-07-08T14:13:32+03:00
You can use the CORE API to access the resources harvested and enriched by CORE. If you encounter any problems with the API, please report them to us.
The API is organised by resource type. The resources are articles, journals and repositories and are represented using JSON data format. Furthermore, each resource has a list of methods. The API also provides two global methods for accessing all resources at once.
Response for each query contains two fields: status and data. In case of an error status, the data field is empty. The data field contains a single object in case the request is for a specific identifier (e.g. CORE ID, CORE repository ID, etc.), or contains a list of objects, for example for search queries. In case of batch requests, the response is an array of objects, each of which contains its own status and data fields. For search queries the response contains an additional field totalHits, which is the total number of items which match the search criteria.
Complex search queries can be used in all of the API search methods. The query can be a simple string or it can be built using terms and operators described in Elasticsearch documentation. The usable field names are title, description, fullText, authors, publisher, repositories.id, repositories.name, doi, oai, identifiers (which is a list of article identifiers including OAI, URL, etc.), language.name and year. Some example queries:
title:psychology and language.name:English
repositories.id:86 AND year:2014
identifiers:"oai:aura.abdn.ac.uk:2164/3837" OR identifiers:"oai:aura.abdn.ac.uk:2164/3843"
doi:"10.1186/1471-2458-6-309"
You can retrieve the harvested items since specific dates using the following queries:
repositoryDocument.metadataUpdated:>2017-02-10
repositoryDocument.metadataUpdated:>2017-03-01 AND repositoryDocument.metadataUpdated:<2017-03-31
For search queries, the results are ordered by relevance score. For batch requests, the results are retrieved in the order of the requests.
The API methods allow different parameters to be passed. Additionally, there is an API key parameter which is common to all API methods. For all API methods the API key can be provided either as a query parameter or in the request header. If the API key is not provided, the API will return HTTP 401 error. You can register for an API key here.
Supported authorization schemes:
- API Key
Method accepts values for several parameters and retrieves a JSON array of articles which have near duplicate content matching the input parameters' values. The response array contains ids of the near duplicate articles along with their relevance scores.
Tags: articles
doi- optional - The DOI for which the duplicates will be identifiedtitle- optional - Title to match when looking for duplicate articles. Only useful when either value for @year or @description is supplied.year- optional - Year the article was published. Only useful when value for @title is supplied.description- optional - Abstract for an article based on which its duplicates will be found. Only useful when value for @title is supplied.fulltext- optional - Full text for an article based on which its duplicates will be found.identifier- optional - Article identifier for which the duplicates will be identified. Only useful when either values for @doi or (@title and @year) or (@title and @abstract) or @fulltext are supplied.repositoryId- optional - Limit the duplicates search to particular repository id.
Method accepts a JSON array of CORE IDs and retrieves a list of articles. The response array is ordered based on the order of the IDs in the request array.
Tags: articles
metadata- optional - Whether to retrieve the full article metadata or only the IDs. The default value is truefulltext- optional - Whether to retrieve fulltexts of the articles. The default value is falsecitations- optional - Whether to retrieve citations found in the articles. The default value is falsesimilar- optional - Whether to retrieve lists of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response timeduplicate- optional - Whether to retrieve CORE IDs of different versions of the articles. The default value is falseurls- optional - Whether to retrieve lists of URLs of the article fulltexts. The default value is falsefaithfulMetadata- optional - Returns the records raw XML metadata from the original repository. The default value is false
Method will retrieve an article based on given CORE ID.
Tags: articles
coreId- required - CORE ID of the article that needs to be fetched.metadata- optional - Whether to retrieve the full article metadata or only the ID. The default value is true.fulltext- optional - Whether to retrieve full text of the article. The default value is falsecitations- optional - Whether to retrieve citations found in the article. The default value is falsesimilar- optional - Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response timeduplicate- optional - Whether to retrieve a list of CORE IDs of different versions of the article. The default value is falseurls- optional - Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is falsefaithfulMetadata- optional - Returns the records raw XML metadata from the original repository. The default value is false
Method will retrieve an article based on given CORE ID.
Tags: articles
coreId- required - ID of article history that needs to be fetched
Method accepts a single CORE ID and returns a list of all historical versions of the article, which are stored in CORE database. The results are ordered from the newest one to the oldest one.
Tags: articles
coreId- required - CORE ID of the article which history should be fetchedpage- optional - Which page of the history results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).pageSize- optional - The number of results to return per page. Can be any number between 10 and 100, default is 10.
Method accepts a JSON array of search queries and parameters. It then searches through all articles and returns a JSON array of search results for each of the queries. Method searches through all article fields (title, authors, subjects, identifiers, etc.).
Tags: articles
metadata- optional - Whether to retrieve the full article metadata or only the ID. The default value is true.fulltext- optional - Whether to retrieve full text of the article. The default value is falsecitations- optional - Whether to retrieve citations found in the article. The default value is falsesimilar- optional - Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response timeduplicate- optional - Whether to retrieve a list of CORE IDs of different versions of the article. The default value is falseurls- optional - Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is falsefaithfulMetadata- optional - Whether to retrieve the raw XML metadata of the article. The default value is false
Searches through all articles and returns a JSON array with search results. Method searches through all article fields.
Tags: articles
query- required - The search querypage- optional - Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).pageSize- optional - The number of results to return per page. Can be any number between 10 and 100, default is 10.metadata- optional - Whether to retrieve the full article metadata or only the ID. The default value is true.fulltext- optional - Whether to retrieve full text of the article. The default value is falsecitations- optional - Whether to retrieve citations found in the article. The default value is falsesimilar- optional - Whether to retrieve a list of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response timeduplicate- optional - Whether to retrieve a list of CORE IDs of different versions of the article. The default value is falseurls- optional - Whether to retrieve a list of URLs from which the article can be downloaded. This can include links to PDFs as well as HTML pages. The default value is falsefaithfulMetadata- optional - Returns the records raw XML metadata from the original repository. The default value is false
Method accepts a text and retrieves a JSON array of articles which are similar to the given text. The response array is ordered based on similarity score, starting from the most similar.
Tags: articles
limit- optional - How many similar articles to retrieve at most. Can be any number betwen 1 and 100, default is 10metadata- optional - Whether to retrieve the full article metadata or only the IDs of the similar articles. The default value is truefulltext- optional - Whether to retrieve fulltexts of the similar articles. The default value is falsecitations- optional - Whether to retrieve citations found in the articles. The default value is falsesimilar- optional - Whether to retrieve lists of similar articles. The default value is false. Because the similar articles are calculated on demand, setting this parameter to true might slightly slow down the response timeduplicate- optional - Whether to retrieve CORE IDs of different versions of the articles. The default value is falseurls- optional - Whether to retrieve lists of URLs of the article fulltexts. The default value is falsefaithfulMetadata- optional - Whether to retrieve the raw XML metadata of the articles. The default value is false
Method accepts a JSON array of ISSNs and retrieves a list of journals.
Tags: journals
Returns a journal with given ISSN identifier.
Tags: journals
issn- required - ISSN identifier of journal that needs to be fetched.
Method accepts a JSON array of search queries and parameters. It then searches through all journals and returns a JSON array of search results for each of the queries. Method searches through all journal fields (title, identifiers, subjects, language, rights and publisher).
Tags: journals
Searches through all journals and returns a JSON array of search results. Method searches through all journal fields (title, identifiers, subjects, language, rights and publisher).
Tags: journals
query- required - Search querypage- optional - Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).pageSize- optional - The number of results to return per page. Can be any number between 10 and 100, default is 10.
Method accepts a JSON array of CORE repository IDs and retrieves a list of repositories. The response array is ordered based on the order of the IDs in the request array. The maximum number of IDs in request is 100.
Tags: repositories
stats- optional - Whether to retrieve statistics about the repository. The default value is false
Method will retrieve a repository based on given CORE repository ID.
Tags: repositories
repositoryId- required - CORE repository ID of the article that needs to be fetched.stats- optional - Whether to retrieve statistics about the repository. The default value is false
Method accepts a JSON array of search queries and parameters. It then searches through all repositories and returns a JSON array of search results for each of the queries. Method searches through all repository fields.
Tags: repositories
stats- optional - Whether to retrieve statistics about the repository. The default value is false
Searches through all repositories and returns a JSON array with search results. Method searches through all repository fields.
Tags: repositories
query- required - The search querypage- optional - Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).pageSize- optional - The number of results to return per page. Can be any number between 10 and 100, default is 10.stats- optional - Whether to retrieve statistics about the repository. The default value is false
Method accepts a JSON array of search queries. It searches through all resources and returns a JSON array with search results for each of the queries. Method searches through all resources and all fields. The results are ordered by relevance score and contain type of the relevant resource and its ID. Furthermore, the responses are oredered based on the order of the request items. The metadata of each resource need to be obtained through an appropriate method.
Tags: all
Searches through all resources and returns a JSON array with search results. Method searches through all resources and all fields. The results are ordered by relevance score and contain type of the relevant resource and its ID. The metadata of each resource need to be obtained through an appropriate method.
Tags: all
query- required - The search querypage- optional - Which page of the search results should be retrieved. Can be any number betwen 1 and 100, default is 1 (first page).pageSize- optional - The number of results to return per page. Can be any number between 10 and 100, default is 10.
flowground :- Telekom iPaaS / core-ac-uk-connector
Copyright © 2019, Deutsche Telekom AG
contact: flowground@telekom.de
All files of this connector are licensed under the Apache 2.0 License. For details see the file LICENSE on the toplevel directory.