Skip to content

nbtopics.md

Latest commit

 

History

History
59 lines (54 loc) · 1.68 KB

nbtopics.md

File metadata and controls

59 lines (54 loc) · 1.68 KB

Main Endpoint

GET /api/integration/nbtopics

Provide access to the OpenAIRE Broker topics. It returns the list of the OpenAIRE Broker topics.

[

  {
    "id": "ENRICH!MORE!PID",
    "type": "nbtopic",
    "uniqueType": "integration.nbtopic",
    "name": "ENRICH/MORE/PID",
    "lastEvent": "2020/10/09 10:11 UTC",
    "totalSuggestions": "33"
  },
  {
    "id": "ENRICH!MISSING!ABSTRACT",
    "type": "nbtopic",
    "uniqueType": "integration.nbtopic",
    "name": "ENRICH/MISSING/ABSTRACT",
    "lastEvent": "2020/10/09 10:11 UTC",
    "totalSuggestions": "21"
  },
  ...
]

Attributes:

  • name: the name of the topic to display on the frontend user interface
  • lastEvent: the date of the last update from OpenAIRE
  • totalEvents: the total number of suggestions provided by OpenAIRE for this topic
  • id: is the identifier to use in GET Single Topic

Return codes:

  • 200 OK - if the operation succeed
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged in with sufficient permissions, only system administrators can access

GET Single Topic

GET /api/integration/nbtopics/<:nbtopic-id> ​ Provide detailed information about a specific OpenAIRE Broker topic. The JSON response document is as follow ​

{
  "id": "ENRICH!MORE!PID",
  "type": "nbtopic",
  "uniqueType": "integration.nbtopic",
  "name": "ENRICH/MORE/PID",
  "lastEvent": "2020/10/09 10:11 UTC",
  "totalEvents": 33
}

​ Return codes:

  • 200 OK - if the operation succeed
  • 401 Unauthorized - if you are not authenticated
  • 403 Forbidden - if you are not logged in with sufficient permissions, only system administrators can access
  • 404 Not found - if the topic doesn't exist