logoBack to home screen

REST API

ADx functionality, apart from being exposed via the UI, is also available via REST API. This document describes available administration and repository endpoints using Open API and Swagger pages from the product itself as a base.

Accessing Open API/Swagger

You can access Open API and Swagger by clicking the API link ADx landing page. You can open a repository API or administrator API:

Depending on the link you select on the landing page, Swagger UI will display different endpoints. You can select the following endpoints:

  • ADx Administration API (/api/v1/access.adx.admin)
  • Repository API (../ADx_Content_Access/content_access.md) (/api/v1/access.adx.content.repositoryName)

Using Open API/Swagger

When you decide on what to display, the Swagger UI displays a list of items of your interest based on the URL you used.

List of Items

The list contains REST API endpoints sorted in alphabetical order. You can see the HTTP method and a quick description of the call directly in the list:

Check the sections below for a list of all endpoints available in Administrator and Repository APIs, along with their equivalent UI functionality (if available).

HTTP Codes

ADx REST API returns the following HTTP codes:

CodeContext
200Request evaluated successfully. Note that for asynchronous requests, such as conversions, this information only means that the operation has been successfully started and NOT that it has been successfully completed. Consequently, HTTP code does not correspond with the actual status of the started job.
400Invalid input was given
401Session ID was not found. See Authenticating to ADx for more details.
404Target resource not found
500Server error

ADx Administration API

When you enter the Administrator API (available only with adx-admin, adx-root or tf-admin role), the following endpoints are exposed via Swagger (note that the same functionality may be available in the UI):

Export/Import

These endpoints represent services related to the export and import of repository configuration data. This process is explained in more detail in Exporting and Importing Repository Configuration via REST.

MethodDescriptionEndpointRequest query parametersForm dataReturnsUI Equivalent
GETExport repository configuration by IDshttps://host:port/tribefire-services/api/v1/access.adx.admin/v1/export/configuration/sessionId, repositoryIds (array)none.zip file with repository configurationSee Exporting and Importing Repository Configuration via ADx UI
GETExport repository configuration by nameshttps://host:port/tribefire-services/api/v1/access.adx.admin/v1/export/configuration/by-namessessionId, repositoryNames (array)none.zip file with repository configurationSee Exporting and Importing Repository Configuration via ADx UI
GETExport repository configuration by technical namehttps://host:port/tribefire-services/api/v1/access.adx.admin/v1/export/configuration/by-technical-namesrepositoryTechnicalNames (array)none.zip file with repository configurationSee Exporting and Importing Repository Configuration via ADx UI
POSTImport repository configurationhttps://host:port/tribefire-services/api/v1/access.adx.admin/v1/import/configurationnoneautoSync, importRepositoryOption, importUsers, resource, useRuntimeValuesSee Exporting and Importing Repository Configuration via ADx UI

Repository Administration

These endpoints represent services related to repository administration.

MethodEndpointDescriptionUI Equivalent
DELETE/access.adx.admin/v1/repositoryDelete Repository By IdUse the Delete option in Administrator area
POST/access.adx.admin/v1/repository/activateActivate By IdUse the Activate option in Administrator area
POST/access.adx.admin/v1/repository/by-templateCreate Repository By TemplateAssign the template while creating a new repository in Administrator area
POST/access.adx.admin/v1/repository/cmisCreate Cmis RepositorySelect New/New CMIS Repository in Administrator area
POST/access.adx.admin/v1/repository/dctmCreate Dctm RepositorySelect New/New DCTM Repository in Administrator area
POST/access.adx.admin/v1/repository/deactivateDeactivate By IdUse the Deactivate option in Administrator area
POST/access.adx.admin/v1/repository/standard-db-storageCreate Standard Repository By Db StorageSelect New/New Standard Repository, then assign db as storage type in Administrator area
POST/access.adx.admin/v1/repository/standard-fs-storageCreate Standard Repository By Fs StorageSelect New/New Standard Repository, then assign fs as storage type in Administrator area
POST/access.adx.admin/v1/repository/synchronizeSynchronize Configuration RequestUse the Synchronize option in Administrator area

Repository Health

These endpoints represent activities related to checking repository health.

MethodEndpointDescriptionUI Equivalent
GET/access.adx.admin/v1/repository/connection-checkCheck RepositorySee Running Conversion and Platform Health Checks
GET/access.adx.admin/v1/repository/connection-check/by-nameCheck Repository By NameSee Running Conversion and Platform Health Checks
GET/access.adx.admin/v1/repository/connection-check/by-technical-nameCheck Repository By Technical NameSee Running Conversion and Platform Health Checks
GET/access.adx.admin/v1/repository/deep-checkDeep Health CheckSee Running Conversion and Platform Health Checks
GET/access.adx.admin/v1/repository/deep-check/by-nameDeep Health Check By NameSee Running Conversion and Platform Health Checks
GET/access.adx.admin/v1/repository/deep-check/by-technical-nameDeep Health Check By Technical NameSee Running Conversion and Platform Health Checks

User Administration

These endpoints represent activities related to user, group, and role management.

MethodEndpointDescriptionUI Equivalent
DELETE/access.adx.admin/v1/groupDelete Group By IdSee User Management
GET/access.adx.admin/v1/groupGet GroupSee User Management
POST/access.adx.admin/v1/groupCreate GroupSee User Management
GET/access.adx.admin/v1/group/by-nameGet Group By NameSee User Management
POST/access.adx.admin/v1/group/pictureAssign Picture By GroupSee User Management
GET/access.adx.admin/v1/group/searchSearch GroupsSee User Management
DELETE/access.adx.admin/v1/roleDelete Role By IdSee User Management
GET/access.adx.admin/v1/roleGet RoleSee User Management
POST/access.adx.admin/v1/roleCreate RoleSee User Management
GET/access.adx.admin/v1/role/by-nameGet Role By NameSee User Management
GET/access.adx.admin/v1/role/searchSearch RolesSee User Management
DELETE/access.adx.admin/v1/sessionClose SessionSee Session Monitoring
GET/access.adx.admin/v1/sessionGet SessionSee Session Monitoring
GET/access.adx.admin/v1/session/searchSearch SessionsSee Session Monitoring
DELETE/access.adx.admin/v1/userDelete User By IdSee User Management
GET/access.adx.admin/v1/userGet UserSee User Management
POST/access.adx.admin/v1/userCreate UserSee User Management
GET/access.adx.admin/v1/user/by-nameGet User By NameSee User Management
GET/access.adx.admin/v1/user/effective-rolesGet Effective RolesSee User Management
POST/access.adx.admin/v1/user/generateKeysGenerate Key PairSee User Management
GET/access.adx.admin/v1/user/getKeysGet Key PairSee User Management
POST/access.adx.admin/v1/user/pictureAssign Picture By UserSee User Management
GET/access.adx.admin/v1/user/searchSearch UsersSee User Management

Repository API

When you enter the Repository API, the following endpoints are exposed via Swagger (note that the same functionality may be available in the UI):

Access-Control

MethodEndpointDescriptionUI Equivalent
POST/access.adx.content.repository_name/v1/acl/denyDeny access by IdAccess Control
POST/access.adx.content.repository_name/v1/acl/grantGrant access by IdAccess Control

CRUD

Important: after creating a content, its version status is set to WORKING_COPY, which means it's checked out and can be updated. Only contents with this status can be updated, you will get an error otherwise. Delete operations should work regardless of the status. Remember to check in your contents when you're done updating them.

Use the endpoints described in Versioning to check out and check in contents.

MethodEndpointDescriptionUI Equivalent
DELETE/access.adx.content.repository_name/v1/contentDelete Content By IdDeleting Content
GET/access.adx.content.repository_name/v1/contentGet Contentn/a
PATCH/access.adx.content.repository_name/v1/contentUpdate Content By IdModifying Content
POST/access.adx.content.repository_name/v1/contentCreate ContentAdding Content
POST/access.adx.content.repository_name/v1/content-by-uriCreate Content By Urin/a
POST/access.adx.content.repository_name/v1/contentsCreate multiple contentsAdding Content, see also Creating Contents with REST.
POST/access.adx.content.repository_name/v1/content/copyCopy Content By Idn/a
GET/access.adx.content.repository_name/v1/content/downloadDownload Content By IdUse the download button in ADx Repository Explorer
PUT/access.adx.content.repository_name/v1/content/moveMove Content By Idn/a
DELETE/access.adx.content.repository_name/v1/content/representationsDelete representations by IdSee Representations
GET/access.adx.content.repository_name/v1/content/representationsGet representations by IdSee Representations
GET/access.adx.content.repository_name/v1/content/representations/downloadDownload representations by IdSee Representations
GET/access.adx.content.repository_name/v1/content/searchSearch ContentsUse the search bar in Explorer. For details, see Searching for Contents.
GET/access.adx.content.repository_name/v1/content/search-by-conditionSearch Contents By ConditionUse the advanced features of the search bar in ADx Repository Explorer.
GET/access.adx.content.repository_name/v1/content/search-by-textSearch Content By TextUse the search bar in ADx Repository Explorer. For details, see Searching for Contents.
POST/access.adx.content.repository_name/v1/content/signature/signSign Content By Idsee Signing Documents with Digital Signature
POST/access.adx.content.repository_name/v1/content/signature/verifyVerify Content Signature By Idsee Signing Documents with Digital Signature (step 4)
POST/access.adx.content.repository_name/v1/content/transferTransfer Content By Idn/a
DELETE/access.adx.content.repository_name/v1/entryDelete Entry By Idn/a
GET/access.adx.content.repository_name/v1/entryGet Entryn/a
PATCH/access.adx.content.repository_name/v1/entryUpdate Entry By Idn/a
PUT/access.adx.content.repository_name/v1/entry/moveMove Entry By Idn/a
GET/access.adx.content.repository_name/v1/entry/searchSearch Entriesn/a
GET/access.adx.content.repository_name/v1/entry/search-by-conditionSearch Entries By Conditionn/a
DELETE/access.adx.content.repository_name/v1/entry/tagsDelete Tagsn/a
PATCH/access.adx.content.repository_name/v1/entry/tagsAdd Tagsn/a
POST/access.adx.content.repository_name/v1/entry/tagsSet Tagsn/a
DELETE/access.adx.content.repository_name/v1/folderDelete Folder By IdWorking with Folders.
GET/access.adx.content.repository_name/v1/folderGet FolderWorking with Folders.
PATCH/access.adx.content.repository_name/v1/folderUpdate Folder By IdWorking with Folders.
POST/access.adx.content.repository_name/v1/folderCreate FolderWorking with Folders.
PUT/access.adx.content.repository_name/v1/folder/moveMove Folder By Idn/a
GET/access.adx.content.repository_name/v1/folder/searchSearch FoldersUse the search bar when in folder menu.
GET/access.adx.content.repository_name/v1/folder/search-by-conditionSearch Folders By ConditionUse the advanced search bar when in folder menu.

Conversion

These endpoints relate to the document conversion operations available from within an ADx repository. Conversion requests are asynchronous - ADx will only return the job ID with code 200 (success), but this does NOT imply that the job itself was successful.

Important: do not confuse these endpoints with internal conversion operations available from the Conversion API.

Note that you can define content specification in the body of a request - see Sending Conversion Requests with New Content Specification. This option is NOT exposed via Swagger form.

MethodEndpointDescriptionUI Equivalent
POST/access.adx.content.repository_name/v1/convert/apply-templateApply template to documentsSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/documentCreate Document Representation By IdSee Representations
POST/access.adx.content.repository_name/v1/convert/extractExtract Text By IdSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/imageConvert To Image By IdSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/mergeMerge By IdsSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/merge-templatesMerge Templates By IdsSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/pdfConvert To Pdf By IdSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/splitSplit By IdSee Conversion Access and Conversion (cache)
GET/access.adx.content.repository_name/v1/convert/statusGet Job StatusSee Conversion Access and Conversion (cache)
POST/access.adx.content.repository_name/v1/convert/watermarkApply Watermark By IdSee Conversion Access and Conversion (cache)

Versioning

These endpoints relate to the content versioning ADx functionality. See Versioning for more details on content versions.

MethodEndpointDescriptionUI Equivalent
POST/access.adx.content.repository_name/v1/content/cancel-checkoutCancel Checkout By IdSee Versioning
POST/access.adx.content.repository_name/v1/content/checkinCheckin By Id - sets status to CURRENT and updates the version numberSee Versioning
POST/access.adx.content.repository_name/v1/content/checkoutCheckout By Id - sets status to WORKING_COPYSee Versioning

Try it Out in Open API/Swagger

When you click on an entry and expand its details, you can click the Try it out button to test the REST call. Clicking this button enables you to fill in all the parameters, execute the query, and inspect the outcome in the Responses section directly in your browser.

If you try out the endpoints for REST calls which require a body to be passed, the body is already pre-populated with the resource's properties and their placeholder values.

When you tried out a REST call and you're satisfied with the result, you can copy the exact URL or Curl you need for this operation from the Responses section.