REST API - Move Artifact Request
11 min
api/v1/projects/{projectid}/artifacts/{artifactid}/traces description 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 artifacts with read only traces cannot be moved url structure \[blueprint uri]/api/v1/projects/{projectid}/artifacts/{artifactid}/traces projectid the id of the project that contains the artifact you want to move artifactid the id of the artifact you want to move supported methods patch # request body the new parent artifact must be specified in the request body read more about how to specify the parent artifact in the request body docid 5qd6 fuzdothy7 mrc1t1 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 400 (bad request) 414 (locked by another user) artifact is locked by another user cannot check out the artifact 428 (new parent is current one) the newly specified parent is already the current parent 429 (new parent not found for user) the newly specified parent cannot be found for the user 430 (new parent not in project) the newly specified parent is from another project moving the artifact across projects is not supported 431 (no edit permission on new parent) cannot make the specified artifact the new parent the user does not have edit permissions for the new parent 432 (new parent is descendent or itself) the newly specified parent is either a descendent of the artifact or is the same artifact id that was specified in the url 500 internal server error 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 //blueprintcloud com/api/v1/projects/847739/artifacts/888020/traces request body \<?xml version="1 0" ?> \<traces xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<trace> \<artifactid>999666\</artifactid> \<type>parent\</type> \</trace>\</traces> response body \<?xml version="1 0" ?>\<traceupdateresults xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<traceupdateresult> \<artifactid>999666\</artifactid> \<message>the parent of the artifact has been successfully updated \</message> \<resultcode>200\</resultcode> \<type>parent\</type> \</traceupdateresult>\</traceupdateresults> json example request uri https //blueprintcloud com/api/v1/projects/847739/artifacts/888020/traces request body \[ { "type" "parent", "artifactid" 999666 }] response body \[ { "artifactid" 999666, "type" "parent", "message" "the parent of the artifact has been successfully updated ", "resultcode" 200 }]