REST API Requests
1 min
the following are the requests that can be made with the blueprint rest api objective description authenticate # generates an authentication token for the specified user list projects # retrieves a list of projects get project # retrieves a project by id, and returns information about the project create project # creates an empty project from a template or without a template list artifacts types # retrieves all artifact types available in the specified project get artifact type # retrieves all artifact type objects from a project list artifacts # retrieves a list of artifacts it is also possible to filter # requested artifacts get artifact # retrieves a single artifact by project id and artifact id and returns information about the artifact get child artifacts of artifact # retrieves the child artifact(s) of the specified artifact get root artifacts of project # retrieves the artifact(s) at the root level of the project add artifact # adds a single artifact to the specified project update artifacts # updates properties of the specified artifact(s) publish artifacts # publishes changes of the specified artifact(s) discard artifacts # discards changes to the specified artifact(s) get group # retrieves the group by its id list groups # retrieves a list of all groups in this blueprint instance list users # retrieves all users in this blueprint instance get user # retrieves the user with the specified user id create user # creates a user with specific defined properties update user # updates the specified properties of a specific user delete user # deletes all specified users delete artifact # deletes the specified artifact you can also delete all children of the specified artifact add attachment # adds a single file attachment to the specified artifact add attachment to subartifact # adds a single file attachment to the specified subartifact delete attachment # deletes a single file attachment from an artifact get attachments # retrieves attachment content add comment # adds a single comment to the specified artifact delete comment # deletes the specified comment from an artifact update comment # updates the specified comment publish comments # publishes all unpublished comments associated with the specified artifact rate comment # rates a comment by specifying whether you like or dislike the comment reply to comment # reply to the specified comment rate reply # rates a reply by specifying whether you like or dislike the reply delete reply # deletes the specified reply from the specified artifact comment update reply # updates the specified reply get artifact image # retrieves the main image from the specified graphical artifact in png format get blueprint product version # retrieves the blueprint product version get project discussion status values # retrieves a list of discussion status values that are valid for the specified project add traces # adds trace(s) to the artifact you specify move artifact # 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 delete traces # deletes the specified trace(s) list unpublished artifacts # 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 list reviews # retrieves a list of reviews by project id get review # retrieves a review by project id and artifact id and returns information about the review list alm targets # retrieves a list of alm targets get alm job # retrieves an alm job by project id, target id and job id and returns information about the job add alm job # adds an alm job to the specified project using the specified target get collections # retrieves the collection in the specified project list collections # lists collections in the specified project