REST API - List Unpublished Artifacts Request

Updated by Stefenie Stockbridge 

api/v1/vc/unpublishedArtifacts

Description

Retrieves a list of artifacts with unpublished changes. This service only returns artifacts in the list if the changes were made by the current user.

URL Structure

[Blueprint_URI]/api/v1/vc/unpublishedArtifacts

Supported Methods

Request URI Parameters

  • Offset (optional): Defines the paging offset (that is, index) at which the results start. Offset the default is 0.
  • Limit (optional): Defines the number of items (projects, artifacts, etc) to retrieve per query. This parameter can be set to an integer. The default is 100. The minimum value is 1 and the maximum value is 500.

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/unpublishedArtifacts?offset=3&limit=13

Response Body

<?xml version="1.0" ?>
<Artifacts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.blueprintsys.com/blueprint/api/v1">
  <Artifact>
    <ArtifactTypeId>1</ArtifactTypeId>
    <ArtifactTypeName>Actor</ArtifactTypeName>
    <BaseArtifactType>Actor</BaseArtifactType>
    <Id>1</Id>
    <Name>New Actor 1</Name>
    <ParentId>10</ParentId>
  </Artifact>
  <Artifact>
    <ArtifactTypeId>2</ArtifactTypeId>
    <ArtifactTypeName>Textual Requirement</ArtifactTypeName>
    <BaseArtifactType>TextualRequirement</BaseArtifactType>
    <Id>2</Id>
    <Name>New Textual Requirement 1</Name>
    <ParentId>10</ParentId>
  </Artifact>
</Artifacts>
JSON Example

Request URI

https://production.blueprintcloud.com/api/v1/vc/unpublishedArtifacts?offset=3&limit=13

Response Body

[
  {
    "Id": 1,
    "Name": "New Actor 1",
    "ParentId": 10,
    "ArtifactTypeId": 1,
    "ArtifactTypeName": "Actor",
    "BaseArtifactType": "Actor"
  },
  {
    "Id": 2,
    "Name": "New Textual Requirement 1",
    "ParentId": 10,
    "ArtifactTypeId": 2,
    "ArtifactTypeName": "Textual Requirement",
    "BaseArtifactType": "TextualRequirement"
  }
]

How did we do?