API Documentation
Welcome to the webserver for Mendeley Cite User Help. Use this API to access and update online help content.
- Download the API in JSON format (OpenAPI 3.0.1).
- Find out more about Mendeley Cite.
- Access the server.
- Contact the API team.
Methods for: topic
Definition: A help topic for using the Mendeley Cite plugin. See the user guide for examples.
Note: Example requests and responses are shown in JSON below, but XML is also accepted.
Post /topic
Definition: Adds a new topic to the help site.
Parameters: No parameters.
Request body (required): The topic that needs to be added to the site.
Example Value (json) | Schema
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
Extensions
Field: x-codegen-request-body-name Value: "body"
Put /topic
Definition: Updates a help topic.
Parameters: No parameters.
Request body (required): The topic on the user help site that needs updating.
Example Value (json) | Schema
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
Responses
- Code 400—Invalid topic supplied
- Code 404—Topic not found
- Code 405—Validation exception
Extensions
Field: x-codegen-request-body-name Value: "body"
Get /topic/findByPage
Definition: Find topics by the help site page they're on. Muliple pages can be provided with comma separated strings. Use page1, page2, page3 for testing.
Parameters
- Name: page (required)
- Description: Pages to filter by.
- Query: array[string]
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
[
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
]
Get /topic/findByType
Definition: Find topics by topic-based classification. Multiple topic type values can be provided with comma separated strings.
Parameters
- Name: topictype (required)
- Description: Topic types to filter by.
- Query: array[string]
Available values: task, concept, reference
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
[
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
]
Get /topic/findByKeywords
Definition: Find topics by keywords. Muliple keywords can be provided with comma separated strings. Use kw1, kw2, kw3 for testing.
Parameters
- Name: keywords (required)
- Description: Keywords to filter by.
- Query: array[string]
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
[
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
]
Get /topic/{topicHeading}
Definition: Find topic by heading. Returns a single topic.
Parameters
- Name: topicHeading (required)
- Description: Heading of the topic to return.
- Query: string
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
Get /topic/{topicId}
Definition: Find topic by ID. Returns a single topic.
Parameters
- Name: topicId (required)
- Description: ID of the topic to return.
- Query: integer($int64)
Responses
- Code 200—Successful Operation
Example Value (json) | Schema
{
"id": 0,
"h2": "Inserting an in-text citation",
"page": {
"id": 0,
"name": "bibliography.html",
"folder": "guide"
},
"keywords": [
{
"id": 0,
"name": "string"
}
],
"topictype": "task"
}
Schemas
Page:
{
id integer($int64)
name string
example: bibliography.html
Which page the topic is on
folder string
Which folder the page is in
Enum: [ guide, support ]
}
Keyword:
{
id integer($int64)
name string
}
Topic:
{
id integer($int64)
h2* string
Topic heading
example: Inserting an in-text citation
page Page{...}
keywords [
xml: OrderedMap { "name": "keywords", "wrapped": true }
Keyword{...} ]
topictype string
topic-based classification
Enum: [ task, concept, reference ]
}