RightFind REST API v1

https://www.rightfind.com/restapi/v1/swagger/
Admin
The RightFind REST API v1 provides programmatic access to RightFind services and data, enabling...
Tokens:2,305
Snippets:16
Trust Score:7.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Platform Information Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Retrieves general platform information, including proxy settings.

```OpenAPI
GET /PlatformInfo
GET /PlatformInfo/proxySettings
```

--------------------------------

### CiteIt Global Storage Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Manages global storage for CiteIt data. Allows for retrieving, updating, and batch operations on stored items, including upsert functionality.

```OpenAPI
GET /CiteItGlobalStorage/{id}
PUT /CiteItGlobalStorage/{id}
GET /CiteItGlobalStorage/batch
POST /CiteItGlobalStorage/batch
POST /CiteItGlobalStorage
POST /CiteItGlobalStorage/upsert
```

--------------------------------

### Search API Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Provides access to various search functionalities within the RightFind API. This includes abstract, semantic, and citation searches, as well as keyword-based queries and content descriptor retrieval.

```OpenAPI
GET /Search/abstracts
GET /Search/semantic
GET /Search/citation
POST /Search/query
POST /Search/query-ext
GET /Search/contentDescriptors
GET /Search/collections
GET /Search/terms
GET /Search/term
POST /Search/term
GET /Search/suggestions
GET /Search/suggestions-ext
```

--------------------------------

### CSL Rendering and Lookup Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Handles rendering of bibliographies and citations using the Citation Style Language (CSL). Also provides functionality to look up available CSL styles.

```OpenAPI
POST /CSL/renderBibliography
POST /CSL/renderCitations
GET /CSL/lookup
```

--------------------------------

### Word Plugin Functionality Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Provides functionalities for the Word Plugin, including search, document searching, style management, custom styles, mappings, settings, logging, and version checking. Also includes title and author normalization.

```OpenAPI
GET /WordPlugin/search
GET /WordPlugin/searchDocuments
GET /WordPlugin/styles
POST /WordPlugin/styles
GET /WordPlugin/customStyles
GET /WordPlugin/mappings
GET /WordPlugin/settings
POST /WordPlugin/log
POST /WordPlugin/logCiteItEvent
GET /WordPlugin/libraries
GET /WordPlugin/checkVersion
GET /WordPlugin/normalizeTitle
POST /WordPlugin/normalizeTitles
POST /WordPlugin/normalizeAuthors
```

--------------------------------

### Order Management Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Facilitates the management of orders, including placing new orders, retrieving order details and status, canceling orders, and previewing orders. Also includes endpoints for order sources.

```OpenAPI
GET /Orders
GET /Orders/{orderId}
GET /Orders/{orderId}/status
GET /Orders/{orderId}/cancel
GET /Orders/{orderId}/continue
GET /Orders/sources
POST /Orders/placeOrderLink
POST /Orders/placeOrder
GET /Orders/preview
POST /Orders/preview
```

--------------------------------

### Genre Information Endpoint

Source: https://www.rightfind.com/restapi/v1/swagger/index

Retrieves a list of all available genres within the RightFind system.

```OpenAPI
GET /Genres
```

--------------------------------

### Rights Management Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Provides functionalities related to rights management, including retrieving rights aliases, summaries, requesting rights, and registering usage.

```OpenAPI
GET /Rights/aliases
POST /Rights/summary
POST /Rights/request
POST /Rights/usages/register
```

--------------------------------

### Library Management Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Provides comprehensive management of libraries, including shared libraries, documents, custom fields, and tags. Supports adding, retrieving, updating, deleting, and sharing documents.

```OpenAPI
GET /Library/shared
GET /Library/documents/{libraryDocumentId}
PUT /Library/documents/{libraryDocumentId}
DELETE /Library/documents/{libraryDocumentId}
GET /Library/documents
POST /Library/documents
POST /Library/documents/query
POST /Library/documents/match
POST /Library/documents/{libraryDocumentId}/tags
GET /Library/documents/{libraryDocumentId}/share
GET /Library/customfields
GET /Library/{libraryId}/tags
```

--------------------------------

### Order Delivery Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Manages the delivery of orders. Allows retrieval of order details and the content of an order.

```OpenAPI
GET /Delivery/{orderId}
GET /Delivery/{orderId}/file
```

--------------------------------

### Client Information Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Provides access to client-specific information, including user details, divisions, departments, locations, and user groups. Allows for retrieval of individual and collection data.

```OpenAPI
GET /Client/info
GET /Client/users
GET /Client/users/{userIdOrEmail}
GET /Client/divisions
GET /Client/divisions/{divisionId}
GET /Client/divisions/{divisionId}/departments
GET /Client/divisions/{divisionId}/departments/{departmentId}
GET /Client/locations
GET /Client/locations/{locationId}
GET /Client/userGroups
GET /Client/userGroups/{userGroupId}
```

--------------------------------

### Citation Parsing Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Enables parsing of citation data through different formats. Supports parsing standard citations, OpenURL citations, and OpenURL citations in XML format.

```OpenAPI
POST /Citations/parse
POST /Citations/parseOpenURL
POST /Citations/parseOpenURLXml
```

--------------------------------

### Chrome Extension Parsing Rules Endpoint

Source: https://www.rightfind.com/restapi/v1/swagger/index

Retrieves parsing rules specifically for the Chrome Extension.

```OpenAPI
GET /ChromeExtension/parsingRules
```

--------------------------------

### User Management Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Manages user information, including retrieval and updating of user details and status.

```OpenAPI
GET /Users
GET /Users/{email}
PUT /Users/{email}
GET /Users/{email}/status
PUT /Users/{email}/status
```

--------------------------------

### Token Endpoint

Source: https://www.rightfind.com/restapi/v1/swagger/index

Endpoint for token-related operations.

```OpenAPI
GET /token
```

--------------------------------

### Table of Contents (TOC) Endpoints

Source: https://www.rightfind.com/restapi/v1/swagger/index

Allows retrieval of table of contents information for content, including volumes, issues, years, and articles. Supports querying by content ID or alternate IDs.

```OpenAPI
GET /TOC/{contentId}/volumes
GET /TOC/{contentId}/issues
GET /TOC/{contentId}/years
GET /TOC/{contentId}/content
GET /TOC/by{altIdName}/{altIdValue}/volumes
GET /TOC/by{altIdName}/{altIdValue}/issues
GET /TOC/by{altIdName}/{altIdValue}/years
GET /TOC/by{altIdName}/{altIdValue}/content
```
Tokens:
Raw