REST API - Listing Artifacts in the Request Body
8 min
you must list the artifacts you are changing in the request message body when making any of the following requests rest api update artifacts request docid ifyqewn9aefvmmfdsnvt rest api publish artifact request docid\ dxgsckqjzgoe9asmlf01b rest api publish artifact request docid\ dxgsckqjzgoe9asmlf01b method the list of artifacts must be submitted using the post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui 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 rest api get artifact type request docid\ ac1pmq7y4f9ibym0n1kpl and rest api list artifact types request docid vsdaxjklji3tk3sbr7jy 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 rest api list artifacts request docid\ iabyqhikpch2vzwbezcpy 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 rest api get artifact request docid\ wkudb4wm9kw7rqoykf hk 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" }]