REST API - Update Artifacts Request

Updated 1 month ago by Stefenie Stockbridge

/api/v1/projects/{projectId}/artifacts

Description

Updates properties of the specified artifact(s).

You can update any artifact property that is not read-only. Typically, Name, Description and any custom properties are not read-only and can be modified.

You cannot, however, modify data that is always read-only, such as the date the artifact was last updated.

Reused artifacts may be read-only or contain read-only properties. Instance administrators can enable a setting that only allows you to modify certain properties, attachments or traces in a reused artifact.

URL Structure

[Blueprint_URI]/api/v1/projects/{ProjectId}/artifacts

ProjectId: The ID of the project that contains the artifact with the attachment you want to retrieve.

Supported Methods

PATCH
You can override the PATCH method and use the POST method instead.

Request Body

The list of artifacts that you want to publish must be included in the body of the request. Read more about how to specify a list of artifacts in the request body.

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.
404 (Not Found)
- Artifact not found in the project.
- Artifact type not found.
410 (Invalid Value)
This error can occur for a variety of reasons, such as:
- Some of artifact properties have invalid values. (The error is on the artifact level if any artifact properties have errors.)
- No properties are specified to be updated.
- The property value cannot be empty.
- Custom value and choices cannot be specified simultaneously.
- Property does not support custom values.
- Only single choice is allowed.
- Specified choice value does not exist.
- Value must be less than the maximum value.
- Value must be greater than the minimum value.
- Limited count of decimal places.
- Invalid rich text property value.
- Specified user or group does not exist.
411 (Newer Revision Exists)
- A newer artifact version exists.
414 (Locked by Another User)
- Artifact is locked by another user.
- Cannot check out the artifact.
416 (Cannot Update Read-Only Property)
- Read-only property cannot be changed.
- ID Property cannot be updated.
417 (Invalid Artifact Property Type)
- Unsupported artifact property type.
- Property not found.
- The property type has been removed.
- Image property update is not supported.
418 (Specified Version Exceeds the Latest One)
- The specified version is greater than the latest one.
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/?

Request Body

<?xml version="1.0" ?>
<Artifacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1">
  <Artifact>
    <Id>220914</Id>
    <Properties>
        <Property>
          <PropertyTypeId>9988</PropertyTypeId>
          <TextOrChoiceValue>Traveler Booking 1</TextOrChoiceValue>
        </Property>
    </Properties>
  </Artifact>
</Artifacts>

Response Header

{'content-length': '282', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 14:59:02 GMT', 'expires': '-1', 'content-type': 'application/xml; charset=utf-8', 'server': 'Blueprint'}

Response Body

<?xml version="1.0" ?>
<ArtifactUpdateResults xmlns="http://www.blueprintsys.com/blueprint/api/v1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ArtifactUpdateResult>
    <ArtifactId>220914</ArtifactId>
    <Message>Success</Message>
    <ResultCode>200</ResultCode>
  </ArtifactUpdateResult>
</ArtifactUpdateResults>

JSON Example