Update Artifacts
/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. Note: 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 |
[Blueprint_URI]/api/v1/projects/{ProjectId}/artifacts
|
Supported Methods |
|
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:
-
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.
- The applicable permissions are needed. For example, this error can occur when:
-
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.
- If
-
501: Not Implemented
500: Internal Server Error
Examples
XML Example
JSON Example