REST API - Get Artifact Image Request
7 min
api/v1/projects/{projectid}/artifacts/{artifactid}/image description retrieves the main image from the specified graphical artifact in png format graphical artifacts include use case diagrams, generic diagrams, business process diagrams, domain diagrams, and ui mockups this is the main image from an example business process diagram url structure \[blueprint uri]/api/v1/projects/{projectid}/artifacts/{artifactid}/image projectid the id of the project that contains the artifact image you want to get artifactid the id of the artifact containing the image you want to get supported methods head docid\ eqnd3zptd6dwf3go3ufox get docid 7hm2r py7e84xk2msf11b 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/image response body the image data is contained in the response body the response header contains important information about the image, such as content length the size of the response content disposition the content type and the name of the file for example image; filename="new use case 1 png" content type the response content type, which is image/png in this case json example request uri https //production blueprintcloud com/api/v1/projects/220870/artifacts/220914/image response body the image data is contained in the response body the response header contains important information about the image, such as content length the size of the response content disposition the content type and the name of the file for example image; filename="new use case 1 png" content type the response content type, which is image/png in this case