REST API - Publish Artifact Request

/api/v1/vc/publish

Description

Publishes changes of the specified artifact(s).

URL Structure

[Blueprint_URI]/api/v1/vc/publish

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.

Request URI Parameters

  • KeepLock (optional): Defines the whether or not to keep the lock after publishing the artifacts. This parameter can be set to true or false. The default is false if not specified. The default is true if the parameter is included in the URI with no given value.

Storyteller 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.
  • 404 (Not Found)
    • Artifact not found in the project.
    • Artifact type not found.
  • 412 (Nothing to Publish)
    • The artifact does not have any changes to publish.
  • 415 (Not All Dependent Artifacts Included)
    • This operation does not include all dependent artifacts to be published or discarded.
  • 500 (Error)
    • A system error has occurred.

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/vc/publish?

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>
<ProjectId>220870</ProjectId>
</Artifact>
</Artifacts>

Response Header

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

Response Body

<?xml version="1.0" ?>
<PublishResultLog xmlns="http://www.blueprintsys.com/blueprint/api/v1" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<PublishResultLogEntry>
<ArtifactId>220914</ArtifactId>
<Message>Published Successfully</Message>
<ProjectId>220870</ProjectId>
<ResultCode>200</ResultCode>
</PublishResultLogEntry>
</PublishResultLog>
JSON Example

Request URI

https://production.blueprintcloud.com/api/v1/vc/publish?

Request Body

[
{
"Id": "220914",
"ProjectId": "220870"
}
]

Response Header

{'content-length': '94', 'pragma': 'no-cache', 'cache-control': 'no-cache', 'date': 'Sat, 04 May 2013 10:47:50 GMT', 'expires': '-1', 'content-type': 'application/json; charset=utf-8', 'server': 'Blueprint'}

Response Body

[
{
"ProjectId": 220870,
"ResultCode": 200,
"Message": "Published Successfully",
"ArtifactId": 220914
}
]