REST API Requests
The following are the requests that can be made with the Storyteller REST API:
Generates an authentication token for the specified user.
Retrieves a list of projects.
Retrieves a project by ID, and returns information about the project.
Creates an empty project from a template or without a template.
Retrieves all artifact types available in the specified project.
Retrieves all artifact type objects from a project.
Retrieves a list of artifacts. It is also possible to filter requested artifacts.
Retrieves a single artifact by Project ID and Artifact ID and returns information about the artifact.
Retrieves the child artifact(s) of the specified artifact.
Retrieves the artifact(s) at the root level of the project.
Adds a single artifact to the specified project.
Updates properties of the specified artifact(s).
Publishes changes of the specified artifact(s).
Discards changes to the specified artifact(s).
Retrieves the group by its ID.
Retrieves a list of all groups in this Storyteller instance.
Retrieves all users in this Storyteller instance.
Retrieves the user with the specified user ID.
Creates a user with specific defined properties.
Updates the specified properties of a specific user.
Deletes all specified users.
Deletes the specified artifact. You can also delete all children of the specified artifact.
Adds a single file attachment to the specified artifact.
Adds a single file attachment to the specified subartifact.
Deletes a single file attachment from an artifact.
Retrieves attachment content.
Adds a single comment to the specified artifact.
Deletes the specified comment from an artifact.
Updates the specified comment.
Publishes all unpublished comments associated with the specified artifact.
Rates a comment by specifying whether you like or dislike the comment.
Reply to the specified comment.
Rates a reply by specifying whether you like or dislike the reply.
Deletes the specified reply from the specified artifact comment.
Updates the specified reply.
Retrieves the main image from the specified graphical artifact in PNG format.
Retrieves the Storyteller product version.
Retrieves a list of discussion status values that are valid for the specified project.
Adds trace(s) to the artifact you specify.
In order to move an artifact, you must change the parent of the artifact. By changing the parent, you are effectively moving the specified artifact and its descendants to a new location in the hierarchy.
Deletes the specified trace(s).
Retrieves a list of artifacts with unpublished changes. This service only returns artifacts in the list if the changes were made by the current user.
Retrieves a list of reviews by Project ID.
Retrieves a review by Project ID and Artifact ID and returns information about the review.
Retrieves a list of ALM targets.
Retrieves an ALM job by Project ID, Target ID and Job ID and returns information about the job.
Adds an ALM job to the specified project using the specified target.
Retrieves the collection in the specified project.
Lists collections in the specified project.