Common Use Cases for REST Web Services
This article describes common use cases for utilizing Documoto's REST Web Services.
Article Topics
Common Use Cases
Documoto's REST Web Services allow customers to:
- Automate content creation
- Automate content distribution
- Automate content enrichment, augmentation & maintenance
- Automate exporting of content in the Documoto format
- Automate user management
- Automate user group creation & management
- Automate organization creation & management
Each use case is detailed below.
Automate Content Creation
Once content has been created in the Documoto format (XML), you can automate the publishing and processing of your content using the following REST Web Services:
| Web Service | Web Service Description |
|
POST /publishing/upload/v1 |
Upload a file to Documoto and conditionally submit the file for processing |
|
PUT /publishing/publish/v1{file} |
Starts an asynchronous job to process a file that was uploaded to Documoto |
NOTE: for more information about creating content in the
Documoto format, please refer to: How to Create XML-Formatted
Content
To fetch publishing job information, leverage the following REST Web Services:
| Web Service | Web Service Description |
|
GET /publishing/upload/v1 |
Gets list of all the file names that have been uploaded to Documoto and are ready for processing |
|
GET /publishing/job-status/v1/{jobID} |
Gets the status of a submitted job by job ID |
Automate Content Distribution
To fetch access controls information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /authorization/access-privilege/organization/v1 | Fetches valid organization access privilege names |
| GET /authorization/access-privilege/user-group/v1 | Fetches valid user group access privilege names |
| GET /media/media-category/v1 | Fetches media category information for a tenant |
To distribute content via access controls, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT / authorization/media/access-controls/v1 | Updates the associated organizations or media categories for a specified media identifier |
To validate access controls for content, leverage the following REST Web Services:
| Web Service | Web Service Description |
|
GET / authorization/media/organization-access/v1 |
Fetches the associated organization names and organization access privileges for a specified media identifier |
| GET /media/media-shelf/v1 | Fetches media category information associated with a specified media identifier |
Automate Content Enrichment, Augmentation & Maintenance
Media
To fetch media information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /media/v1 | Fetches media information for a specified media identifier |
| GET /tag/for-media/v1 | Fetches tags by media identifier |
| GET /tag/for-media-and-tag-name/v1 | Fetches tags by media identifier and tag name |
To update media information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT /media/v1 | Updates media information for a specified media identifier and returns the updated media information |
| PUT /media/no-return/v1 | Updates media information for a specified media identifier without returning the updated media information |
To delete media tag information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /tag/for-media/v1 | Fetches tags by media identifier |
| GET /tag/for-media-and-tag-name/v1 | Fetches tags by media identifier and tag name |
| DELETE /tag/for-media-and-tag-name/v1 | Deletes specified tag value(s) or ALL tag value(s) for specified tag name |
Pages
To validate page information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /media/validate/page-file/v1/{pageFile} | Performs validation on a page filename |
Parts
To fetch part information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /part/v1 | Fetches part information for the part(s) identified |
| GET /part/supplier/v1 | Fetches a list of supplier keys available for a tenant |
To update part information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT /part/v1 | Updates or replaces part information for the part identified |
To supersede a part, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT /part/supersede/v1 | Supersedes a part with one, or more, existing parts |
Automate Content Exports
To export content in the source Documoto format (XML), leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /media/export-async/v1/{identifier} |
Starts an asynchronous export operation of the book archive associated with the specified identifier and returns the request ID |
| GET /media/export-async-poll/v1/{requestID} |
Returns the status of an asynchronous export operation using a specified request ID |
| GET /media/export-async-result/v1/{requestID} |
Downloads the book archive file from a completed export operation using a specified request ID |
Automate User Management
To fetch user information for an organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /user/v1 |
Fetches a paginated list of user data for an organization |
To add an existing user to an organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| POST /user/v1 | Add a user to an organization |
To add a user to a user group, leverage the following REST Web Services:
| Web Service | Web Service Description |
| POST /user-group/user/v1 | Adds a user to a user group |
To remove a user from a user group, leverage the following REST Web Services:
| Web Service | Web Service Description |
| DELETE /user-group/user/v1 | Removes a user from a user group |
To update an existing user's information, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT / user/v1 | Updates a user's information |
To delete a user, leverage the following REST Web Services:
| Web Service | Web Service Description |
| DELETE / user/v1 | Delete a user |
Automate User Group Creation & Management
To create a new user group and assign the permissions and media categories, leverage the following REST Web Services:
| Web Service | Web Service Description |
| POST /user-group/v1 |
Creates a new user group, assigns the permissions and media categories |
To update the user group permissions or media categories for a user group, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT /user-group/v1 |
Updates user group permissions and media categories for a user group |
To fetch all user groups for an organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET / user-group/v1 |
Fetches all user groups for an organization |
To delete a user group, leverage the following REST Web Services:
| Web Service | Web Service Description |
| DELETE /user-group/v1 | Deletes a user group |
Automate Organization Creation & Management
To add an organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| POST /organization/v1 | Creates an organization |
To fetch the access controls and/or child organization(s) names for a specific organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| GET /organization/v1 | Fetches access controls and/or child organization names for a specified organization |
To update the name or access controls for an organization, leverage the following REST Web Services:
| Web Service | Web Service Description |
| PUT /organization/v1 | Updates the name or access controls for a specified organization |