Posted Jul 07 by Pete Oliver.
Updated Jul 07.

This is a listing of available REST API's for OpenText Core.

Last activity Jul 07 by Pete Oliver.
4941 views. 0 comments.

Search

GET /api/v1/search

Search all items.

GET /api/v1/advancedSearch/comments

Search for comments.

GET /api/v1/advancedSearch/resources

Search for resources.

GET /api/v1/advancedSearch/users

Search for users.

Email Attachments

Manage email attachments. Only valid for documents which are emails.

GET /api/v1/documents/:resourceId/attachments/:attachmentId/rendition

GET api/v1/documents/:resourceId/attachments/:attachmentId/rendition/status

POST api/v1/documents/:resourceId/attachments

Audit on Documents

GET api/v1/documents/:resourceId/audit

Sharing

Manage collaborators on documents and folders.

DELETE api/v1/documents/:resourceId/collaborators

GET api/v1/documents/:resourceId/collaborators

POST api/v1/documents/:resourceId/collaborators

DELETE api/v1/documents/:resourceId/collaborators/:userId

GET api/v1/documents/:resourceId/collaborators/:userId

PUT api/v1/documents/:resourceId/collaborators/:userId

DELETE api/v1/folders/:resourceId/collaborators

GET api/v1/folders/:resourceId/collaborators

POST api/v1/folders/:resourceId/collaborators

DELETE api/v1/folders/:resourceId/collaborators/:userId

GET api/v1/folders/:resourceId/collaborators/:userId

PUT api/v1/folders/:resourceId/collaborators/:userId

Comments

Manage comments on documents, folders, versions, and drafts.

GET api/v1/documents/:resourceId/comments/:commentId

GET api/v1/documents/:resourceId/comments

POST api/v1/documents/:resourceId/comments

GET api/v1/folders/:resourceId/comments/:commentId

GET api/v1/folders/:resourceId/comments

POST api/v1/folders/:resourceId/comments

GET api/v1/documents/:resourceId/versions/:versionId/comments/:commentId

GET api/v1/documents/:resourceId/versions/:versionId/comments

POST api/v1/documents/:resourceId/versions/:versionId/comments

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments/:commentId

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments

POST api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments

Likes

Manage likes on documents, folders, versions, drafts, and comments.

DELETE api/v1/documents/:resourceId/likes

GET api/v1/documents/:resourceId/likes

POST api/v1/documents/:resourceId/likes

DELETE api/v1/folders/:resourceId/likes

GET api/v1/folders/:resourceId/likes

POST api/v1/folders/:resourceId/likes

DELETE api/v1/documents/:resourceId/comments/:commentId/likes

GET api/v1/documents/:resourceId/comments/:commentId/likes

POST api/v1/documents/:resourceId/comments/:commentId/likes

DELETE api/v1/folders/:resourceId/comments/:commentId/likes

GET api/v1/folders/:resourceId/comments/:commentId/likes

POST api/v1/folders/:resourceId/comments/:commentId/likes

DELETE api/v1/documents/:resourceId/versions/:versionId/comments/:commentId/likes

GET api/v1/documents/:resourceId/versions/:versionId/comments/:commentId/likes

POST api/v1/documents/:resourceId/versions/:versionId/comments/:commentId/likes

DELETE api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments/:commentId/likes

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments/:commentId/likes

POST api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/comments/:commentId/likes

DELETE api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/likes

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/likes

POST api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/likes

DELETE api/v1/documents/:resourceId/versions/:versionId/likes

GET api/v1/documents/:resourceId/versions/:versionId/likes

POST api/v1/documents/:resourceId/versions/:versionId/likes

Documents, Versions, and Drafts

Manage documents, versions, drafts, and renditions.

POST api/v3/documents

upload a document synchronously or asynchronously (in which case you get a jobid back).

POST api/v3/documents/:resourceId/draft

upload a draft synchronously or asynchronously (in which case you get a jobid back).

POST api/v3/documents/:resourceId/versions

Promote a draft to a version.

GET api/v3/job/:jobId

Probe the status of an asynchronous upload (it is preferred to listen to websocket notifications instead of polling for status).

GET api/v1/documents/:resourceId/contents

Download document content.

DELETE api/v1/documents/:resourceId

GET api/v1/documents/:resourceId

PUT api/v1/documents/:resourceId

DELETE api/v1/documents/:resourceId/lock

POST api/v1/documents/:resourceId/lock

GET api/v1/documents/:resourceId/rendition

GET api/v1/documents/:resourceId/rendition/status

GET api/v1/documents/:resourceId/thumbnail

GET api/v1/documents/:resourceId/versions

GET api/v1/documents/:resourceId/versions/:versionId/contents

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/contents

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/rendition

GET api/v1/documents/:resourceId/versions/:versionId/drafts/:draftId/rendition/status

GET api/v1/documents/:resourceId/versions/:versionId/drafts

GET api/v1/documents/:resourceId/versions/:versionId

GET api/v1/documents/:resourceId/versions/:versionId/rendition

GET api/v1/documents/:resourceId/versions/:versionId/rendition/status

Folders

Manage folders.

POST api/v1/folders

GET api/v3/folders/:resourceId

PUT api/v1/folders/:resourceId

DELETE api/v1/folders/:resourceId

GET api/v1/folders/:resourceId/children

Root Folder/Home Folder

Get the root folder combining incoming shares and root resources.

GET api/v1/home

Public Short Links

Manage public links.

POST api/v1/s

POST api/v1/s/:code/access

GET api/v1/s/:code/attachments/:attachmentId/rendition

GET api/v1/s/:code/attachments/:attachmentId/rendition/status

GET api/v1/s/:code/contents

DELETE api/v1/s/:code

POST api/v1/s/:code/emails

GET api/v1/s/:code

GET api/v1/s/:code/options

PUT api/v1/s/:code

GET api/v1/s/:code/rendition

GET api/v1/s/:code/rendition/status

GET api/v1/users/:userId/links

Auth and Session Managment

Authenticate and logout. Deprecated in favour of using OAuth2 flows and treating apis as OAuth2 resource servers.

DELETE api/v1/sessions

POST api/v1/sessions

DELETE api/v1/users/:userId/sessions

GET api/v1/users/:userId/sessions

DELETE api/v1/users/:userId/sessions/:sessionId

DELETE api/v1/users/:userId/active-tokens/:clientId

GET api/v1/users/:userId/active-tokens

Tags

Manage tags on resources.

GET api/v1/tags/:resourceId

POST api/v1/tags/:resourceId

DELETE api/v1/tags/:resourceId/taggedItems/:tag

Tenant Information

Get information about your tenant.

PUT api/v1/tenants/:tenantId

GET api/v1/tenants/:tenantId/usage

Schema Management

Manage schemas for this tenant. Schemas must exist in order for them to be associated with documents that have metadata attached to them.

GET api/v1/tenants/:tenantId/schemas

POST api/v1/tenants/:tenantId/schemas

GET api/v1/tenants/:tenantId/schemas/:schemaId

GET api/v1/tenants/:tenantId/schemas/:schemaId/history

PUT api/v1/tenants/:tenantId/schemas/:schemaId

GET api/v1/tenants/:tenantId/schemas/:schemaId/usage

GET api/v1/tenants/:tenantId/schemas/:schemaId/versions

POST api/v1/tenants/:tenantId/schemas/:schemaId/versions

GET api/v1/tenants/:tenantId/schemas/:schemaId/versions/:schemaVersionId

Schemas Applied to Resources

Associate existing metadata schema with resources.

DELETE api/v1/documents/:resourceId/applied-schemas

POST api/v1/documents/:resourceId/applied-schemas

DELETE api/v1/folders/:resourceId/applied-schemas

POST api/v1/folders/:resourceId/applied-schemas

Metadata on Resources

Associate metadata with a resource. The Metadata will be valid against a schema associated with the resource.

GET api/v1/documents/:resourceId/metadata

DELETE api/v1/documents/:resourceId/metadata/:metadataId

PUT api/v1/documents/:resourceId/metadata/:metadataId

POST api/v1/documents/:resourceId/metadata

GET api/v1/folders/:resourceId/metadata

DELETE api/v1/folders/:resourceId/metadata/:metadataId

PUT api/v1/folders/:resourceId/metadata/:metadataId

POST api/v1/folders/:resourceId/metadata

User Information

Manage user information, photos, and settings.

GET api/v1/users/self

GET api/v1/users/:userId

PUT api/v1/users/:userId

DELETE api/v1/users/:userId/photo

GET api/v1/users/:userId/photo

POST api/v3/users/:userId/photo

GET api/v1/users/:userId/photo/:photoId

GET api/v1/users/:userId/settings

PUT api/v1/users/:userId/settings

GET api/v1/users/:userId/usage

A User’s Shares

Manage a user’s shares.

DELETE api/v1/users/:userId/shares/external

GET api/v1/users/:userId/shares/incoming

GET api/v1/users/:userId/shares/outgoing

Statistics an a User’s Usage

Get the dashboard information on the user’s usage.

GET api/v1/users/:userId/stats/collaborators

GET api/v1/users/:userId/stats/comments

GET api/v1/users/:userId/stats

GET api/v1/users/:userId/stats/likes

GET api/v1/users/:userId/stats/shares

GET api/v1/users/:userId/stats/timelines

User’s Terms of Service

View the terms of service agreed to by the user.

GET api/v1/users/:userId/tos

GET api/v1/users/:userId/tos/state

Asynchronous Download of Zipped Resources

Zip and download.

POST api/v1/zip

GET api/v1/zip/:zipId/contents


Table of Contents