REST API - Delete Artifact Request

Updated by Stefenie Stockbridge 

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

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, Traces, Offset or Limit parameters.
    • A required value has not been provided.
    • If you are submitting a POST or PATCH 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
  }
]

How did we do?