REST API - Delete Artifact Request

api/v1/projects/{projectid}/artifacts/{artifactid} description deletes the specified artifact you can also delete all children of the specified artifact url structure \[blueprint uri]/api/v1/projects/{projectid}/artifacts/{artifactid} projectid the id of the project that contains the artifact you want to delete artifactid the id of the artifact you want to delete supported methods delete docid\ vnmdtbrg59iwf4suh4zey you can override the delete docid\ vnmdtbrg59iwf4suh4zey method and use the post docid\ hsi lzxs8g rx ydudzkg method instead request uri parameters recursively (optional) specifies whether or not to also delete all child artifacts of the specified artifact this parameter can be set to true or false the default is false if not specified if the parameter is false , the artifact can be deleted only if it does not have children the default is true if the parameter is included in the uri with no given value blueprint result codes your response may contain resultcode and message parameters if your request involves changes to blueprint data these parameters provide detailed information about the result of your request 200 (ok) the artifact updated successfully 401 (unauthorized) the user does not have edit permissions for the artifact 414 (locked by another user) artifact is locked by another user cannot check out the artifact 427 (has children) artifact has children and deletion is not recursive 500 (error) a system error has occurred 502 (concurrency exception) another operation is being executed on the artifact http status codes 200 ok 201 successfully created 206 partial content 400 bad request this error can occur for a variety of reasons at least one uri or request body parameter is invalid, such as one of the filter docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui request and have not added the x http method override parameter to your request header 401 unauthorized the blueprint token is missing, invalid or expired 403 forbidden the applicable permissions are needed for example, this error can occur when an author or collaborate license is needed for access comment permissions are needed on the artifact edit permissions are needed on the change summary job 404 notfound item is not found in the project for example, this error can occur when artifact not found artifact type not found project not found alm target not found change summary job not found user does not have edit permissions for this artifact, project or alm target 409 conflict reason for failure can be found in the response body additional information may also be found in the log 411 length required if the content length header is missing in the request 413 request entity too large if the provided file size is larger than allowed 415 unsupported media type if the provided media type is not of mime multipart content "form data " 416 request range not satisfiable if offset points to a part of a collection that is not available 500 internal server error 501 not implemented examples xml example request uri https //production blueprintcloud com/api/v1/projects/220870/artifacts/220914?recursively=true response body \<?xml version="1 0" ?>\<artifactdeleteresults xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<artifactdeleteresult> \<artifactid>1\</artifactid> \<message>success\</message> \<resultcode>200\</resultcode> \</artifactdeleteresult> \<artifactdeleteresult> \<artifactid>12\</artifactid> \<message>success\</message> \<resultcode>200\</resultcode> \</artifactdeleteresult>\</artifactdeleteresults> json example request uri https //production blueprintcloud com/api/v1/projects/220870/artifacts/220914?recursively=true response body \[ { "artifactid" 1, "message" "success", "resultcode" 200 }, { "artifactid" 12, "message" "success", "resultcode" 200 }]