REST API - Get Artifact Type Request
9 min
/api/v1/projects/{projectid}/metadata/artifacttypes/{artifacttypeid}?richtextasplain={richtextasplain}\&inlinecss={inlinecss} description retrieves all artifact type objects from a project url structure \[blueprint uri]/api/v1/projects/{projectid}/metadata/artifacttypes/{artifacttypeid} projectid the id of the project that contains the artifacts you want to get artifacttypeid the id of the artifact types you want to get supported methods head docid\ eqnd3zptd6dwf3go3ufox get docid 7hm2r py7e84xk2msf11b request uri parameters richtextasplain (optional) defines whether or not to retrieve all rich text properties as plain text instead of html 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 inlinecss (optional) defines whether or not to retrieve all rich text properties with locally defined or inline styles 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 when this parameter is set to false , rich text properties return internal styles that are defined within the \<head> section of the html 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 docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui 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/projects/220870/metadata/artifacttypes/11559? response header {'content length' '4336', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 14 59 14 gmt', 'expires' ' 1', 'content type' 'application/xml; charset=utf 8', 'server' 'blueprint'} response body \<?xml version="1 0" ?>\<artifacttype xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>epic is a large user story\</description> \<id>11559\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>epic(agile pack)\</name> \<prefix>ep(agile pack)\</prefix> \<propertytypes> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>434\</id> \<isreadonly>true\</isreadonly> \<isrequired>false\</isrequired> \<name>id\</name> \<ismultiline>false\</ismultiline> \<isrichtext>false\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>435\</id> \<isreadonly>false\</isreadonly> \<isrequired>true\</isrequired> \<name>name\</name> \<ismultiline>false\</ismultiline> \<isrichtext>false\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>true\</hasdefaultvalue> \<id>436\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>description\</name> \<defaultvalue>\<html>\<head>\</head>\<body style="padding 1px 0px 0px; font family 'portable user interface'; font size 10 67px">\<div style="padding 0px">\<p style="margin 0px">\​\</p>\</div>\</body>\</html>\</defaultvalue> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="userpropertytype"> \<basepropertytype>user\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>474\</id> \<isreadonly>true\</isreadonly> \<isrequired>false\</isrequired> \<name>created by\</name> \</propertytype> \<propertytype i\ type="datepropertytype"> \<basepropertytype>date\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>475\</id> \<isreadonly>true\</isreadonly> \<isrequired>false\</isrequired> \<name>created on\</name> \<isvalidated>false\</isvalidated> \</propertytype> \<propertytype i\ type="userpropertytype"> \<basepropertytype>user\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>476\</id> \<isreadonly>true\</isreadonly> \<isrequired>false\</isrequired> \<name>last edited by\</name> \</propertytype> \<propertytype i\ type="datepropertytype"> \<basepropertytype>date\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>477\</id> \<isreadonly>true\</isreadonly> \<isrequired>false\</isrequired> \<name>last edited on\</name> \<isvalidated>false\</isvalidated> \</propertytype> \<propertytype i\ type="choicepropertytype"> \<basepropertytype>choice\</basepropertytype> \<hasdefaultvalue>true\</hasdefaultvalue> \<id>3881\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>tshirt(agile pack)\</name> \<standardpropertytypeid>3878\</standardpropertytypeid> \<allowmultiple>false\</allowmultiple> \<defaultvalueindex>0\</defaultvalueindex> \<iscustomvalueallowed>false\</iscustomvalueallowed> \<validvalues> \<validvalue>xs\</validvalue> \<validvalue>s\</validvalue> \<validvalue>m\</validvalue> \<validvalue>l\</validvalue> \<validvalue>xl\</validvalue> \</validvalues> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>4875\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>22\</name> \<standardpropertytypeid>4872\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>4905\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>standard property 6\</name> \<standardpropertytypeid>4902\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>5036\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>standard property 7\</name> \<standardpropertytypeid>5033\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>5099\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>standard property 9\</name> \<standardpropertytypeid>5096\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>5130\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>standard property 10\</name> \<standardpropertytypeid>5127\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="textpropertytype"> \<basepropertytype>text\</basepropertytype> \<hasdefaultvalue>false\</hasdefaultvalue> \<id>5298\</id> \<isreadonly>false\</isreadonly> \<isrequired>true\</isrequired> \<name>standard property 12\</name> \<standardpropertytypeid>5295\</standardpropertytypeid> \<ismultiline>true\</ismultiline> \<isrichtext>true\</isrichtext> \</propertytype> \<propertytype i\ type="choicepropertytype"> \<basepropertytype>choice\</basepropertytype> \<hasdefaultvalue>true\</hasdefaultvalue> \<id>6676\</id> \<isreadonly>false\</isreadonly> \<isrequired>false\</isrequired> \<name>standard property 13\</name> \<standardpropertytypeid>6673\</standardpropertytypeid> \<allowmultiple>true\</allowmultiple> \<defaultvalueindex>0\</defaultvalueindex> \<iscustomvalueallowed>false\</iscustomvalueallowed> \<validvalues> \<validvalue>a\</validvalue> \<validvalue>b\</validvalue> \</validvalues> \</propertytype> \</propertytypes> \<standardartifacttypeid>4038\</standardartifacttypeid>\</artifacttype> json example request uri https //production blueprintcloud com/api/v1/projects/220870/metadata/artifacttypes/11559? response header {'content length' '2240', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 11 42 58 gmt', 'expires' ' 1', 'content type' 'application/json; charset=utf 8', 'server' 'blueprint'} response body { "id" 11559, "name" "epic(agile pack)", "description" "epic is a large user story", "prefix" "ep(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4038, "isusedinthisproject" true, "propertytypes" \[ { "basepropertytype" "text", "isrichtext" false, "ismultiline" false, "id" 434, "name" "id", "isrequired" false, "hasdefaultvalue" false, "isreadonly" true }, { "basepropertytype" "text", "isrichtext" false, "ismultiline" false, "id" 435, "name" "name", "isrequired" true, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "defaultvalue" "?", "id" 436, "name" "description", "isrequired" false, "hasdefaultvalue" true, "isreadonly" false }, { "basepropertytype" "user", "id" 474, "name" "created by", "isrequired" false, "hasdefaultvalue" false, "isreadonly" true }, { "basepropertytype" "date", "isvalidated" false, "id" 475, "name" "created on", "isrequired" false, "hasdefaultvalue" false, "isreadonly" true }, { "basepropertytype" "user", "id" 476, "name" "last edited by", "isrequired" false, "hasdefaultvalue" false, "isreadonly" true }, { "basepropertytype" "date", "isvalidated" false, "id" 477, "name" "last edited on", "isrequired" false, "hasdefaultvalue" false, "isreadonly" true }, { "basepropertytype" "choice", "iscustomvalueallowed" false, "allowmultiple" false, "validvalues" \[ "", "xs", "s", "m", "l", "xl" ], "defaultvalueindex" 0, "id" 3881, "name" "tshirt(agile pack)", "standardpropertytypeid" 3878, "isrequired" false, "hasdefaultvalue" true, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 4875, "name" "22", "standardpropertytypeid" 4872, "isrequired" false, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 4905, "name" "standard property 6", "standardpropertytypeid" 4902, "isrequired" false, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 5036, "name" "standard property 7", "standardpropertytypeid" 5033, "isrequired" false, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 5099, "name" "standard property 9", "standardpropertytypeid" 5096, "isrequired" false, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 5130, "name" "standard property 10", "standardpropertytypeid" 5127, "isrequired" false, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "text", "isrichtext" true, "ismultiline" true, "id" 5298, "name" "standard property 12", "standardpropertytypeid" 5295, "isrequired" true, "hasdefaultvalue" false, "isreadonly" false }, { "basepropertytype" "choice", "iscustomvalueallowed" false, "allowmultiple" true, "validvalues" \[ "a", "b" ], "defaultvalueindex" 0, "id" 6676, "name" "standard property 13", "standardpropertytypeid" 6673, "isrequired" false, "hasdefaultvalue" true, "isreadonly" false } ]}