REST API Overview

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 - /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.

Including Session ID in Open API Requests

To include the SessionId parameter in Open API requests, you must enable the Session ID option. To do that, on the go to your repository's API page, click the arrow under Simple View, and then check the Session-ID box.

The image below shows how to enable session IDs in Open API requests.

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:

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.

Policy Administration

These endpoints represent services related to policy administration, explained in more detail in Working with Policies with ADx REST API.

Repository Administration

These endpoints represent services related to repository administration.

Repository Health

These endpoints represent activities related to checking repository health.

User Administration

These endpoints represent activities related to user, group, and role 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

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.

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.

Versioning

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

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.