REST API - Listing Artifacts in the Request Body

Updated by Stefenie Stockbridge

You must list the artifacts you are changing in the request message body when making any of the following requests:

Method

The list of artifacts must be submitted using the HTTP POST method or HTTP PATCH method depending on the type of request you are submitting.

Parameters

The following parameters can be specified within the Artifact element:

  • Id: (Required.) Identifies the artifact numerically
  • ArtifactTypeId: Numerically identifies the type of artifact. The identifier can be obtained via the Get Artifact Type and List Artifact Types requests.
  • Name: If you want to change the name of the artifact using the UpdateArtifacts call, you can specify a value
  • ProjectId: Identifies the project the artifact belongs to
  • Any required values for the property type of the artifact, if you are specifying the property type.
Properties Element
When adding a new artifact, you must specify values for all required properties.

If you want to specify a property type for your artifact, include a Properties parameter within the Artifact element.

Among others, the Properties element can contain the following elements:

  • Property: (Required) The element containing the property specifications.
  • PropertyTypeId: The corresponding elements, which can be populated in the Get Artifact call.

Examples

UpdateArtifacts Example

Here is an example of a request body in XML format:

<?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>

Here is an example of a request body in JSON format:

[
  {
    "Id": 220914, 
	"Properties": [ 
	  { 
	    "PropertyTypeId": 9988, 
		"TextOrChoiceValue": "Traveler Booking 1" 
	  }
	]
  }
]
PublishArtifacts Example

Here is an example of a request body in XML format:

<?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>

Here is an example of a request body in JSON format:

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

Here is an example of a request body in XML format:

<?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>

Here is an example of a request body in JSON format:

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

How did we do?