REST API - List Artifact Types Request
9 min
/api/v1/projects/{projectid}/metadata/artifacttypes?propertytypes={boolean}\&richtextasplain={boolean}\&inlinecss={boolean}\&offset={offset}\&limit={limit} description retrieves all artifact types available in the specified project url structure \[blueprint uri]/api/v1/projects/{projectid}/metadata/artifacttypes supported methods head docid\ eqnd3zptd6dwf3go3ufox get docid 7hm2r py7e84xk2msf11b request uri parameters propertytypes (optional) defines whether or not to include property types 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 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 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 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?limit=5\&offset=0 response header {'content length' '1394', 'expires' ' 1', 'server' 'blueprint', 'content range' 'artifact types 0 4/22', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 14 59 12 gmt', 'content type' 'application/xml; charset=utf 8'} response body \<?xml version="1 0" ?> \<artifacttypes xmlns\ i="http //www w3 org/2001/xmlschema instance" xmlns="http //www blueprintsys com/blueprint/api/v1"> \<artifacttype> \<baseartifacttype>primitivefolder\</baseartifacttype> \<description>description\</description> \<id>551\</id> \<name>folder\</name> \<prefix>pf\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>glossary\</baseartifacttype> \<description>list of terms and definitions \</description> \<id>552\</id> \<name>glossary\</name> \<prefix>gl\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>a text based requirement that does not fit into any of the other textual requirement types \</description> \<id>553\</id> \<name>textual requirement\</name> \<prefix>rq\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>businessprocess\</baseartifacttype> \<description>a swimlane oriented process diagram depicting how business tasks relate one to another to accomplish an overall goal of the business \</description> \<id>554\</id> \<name>business process diagram\</name> \<prefix>bp dg\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>actor\</baseartifacttype> \<description>an actor is either a human or another system that interacts with the system under development for the purpose of accomplishing certain goals (use cases) with the system \</description> \<id>555\</id> \<name>actor\</name> \<prefix>actor\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>usecase\</baseartifacttype> \<description>describes the interaction between an actor and the system under development to accomplish a given goal \</description> \<id>556\</id> \<name>use case\</name> \<prefix>uc\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>uimockup\</baseartifacttype> \<description>a user interface mockup of a screen for the system under developlent \</description> \<id>557\</id> \<name>screen\</name> \<prefix>scrn\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>genericdiagram\</baseartifacttype> \<description>any diagram format that is not a business process or domain diagram \</description> \<id>558\</id> \<name>generic diagram\</name> \<prefix>gen dg\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>document\</baseartifacttype> \<description>description\</description> \<id>559\</id> \<name>document\</name> \<prefix>doc\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>storyboard\</baseartifacttype> \<description>a connected set of screens used to demonstrate screen to screen based navigation \</description> \<id>560\</id> \<name>storyboard\</name> \<prefix>sb\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>domaindiagram\</baseartifacttype> \<description>a diagram depicting how entities or classes relate to one another \</description> \<id>561\</id> \<name>domain diagram\</name> \<prefix>dom dg\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>describes a business need and is considered to answer the question "why" does the business need this \</description> \<id>565\</id> \<name>business requirement\</name> \<prefix>bus rq\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>describes a business constraint that the system under development must adhere to \</description> \<id>566\</id> \<name>business rule\</name> \<prefix>bus rl\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>defines the characteristics (type, length, etc ) of data elements \</description> \<id>567\</id> \<name>data definitions\</name> \<prefix>data def\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>describes the tasks that the system must perform in order to satisfy the tasks of the users typically answers the question "how" will the system meet the needs of the users \</description> \<id>568\</id> \<name>functional requirement\</name> \<prefix>func rq\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>describes the non functional characteristics of the system often referred to as the "ilities," e g scalability, reliability, usability, etc \</description> \<id>569\</id> \<name>quality of service requirement\</name> \<prefix>qs rq\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>defines the specific fields for a given screen \</description> \<id>570\</id> \<name>screen definitions\</name> \<prefix>scrn def\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>describes the tasks that a user needs to perform with the system in order to satisfy the needs of the business typically answers the question "what" must the user do with the system \</description> \<id>571\</id> \<name>user requirement\</name> \<prefix>user rq\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>used to document error messages and warnings \</description> \<id>572\</id> \<name>error messages\</name> \<prefix>err msg\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>usecasediagram\</baseartifacttype> \<description>description\</description> \<id>573\</id> \<name>use case diagram\</name> \<prefix>ucd\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>edit description\</description> \<id>574\</id> \<name>information\</name> \<prefix>info\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>process\</baseartifacttype> \<description>description\</description> \<id>3532\</id> \<name>process\</name> \<prefix>pro\</prefix> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>used for storyteller\</description> \<id>4019\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>st user story(6)\</name> \<prefix>stus(7)\</prefix> \<standardartifacttypeid>4016\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>epic is a large user story\</description> \<id>4041\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>epic(agile pack)\</name> \<prefix>ep(agile pack)\</prefix> \<standardartifacttypeid>4038\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>a process that adds value to a customer and it can be planned \</description> \<id>4063\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>feature(agile pack)\</name> \<prefix>ft(agile pack)\</prefix> \<standardartifacttypeid>4060\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>a real world example of how one or more people or organizations interact with a system \</description> \<id>4085\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>scenario(agile pack)\</name> \<prefix>sc(agile pack)\</prefix> \<standardartifacttypeid>4082\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>a grouping of stories \</description> \<id>4107\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>theme(agile pack)\</name> \<prefix>th(agile pack)\</prefix> \<standardartifacttypeid>4104\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>textualrequirement\</baseartifacttype> \<description>used in agile development to capture the description of a software feature from and end user perspective \</description> \<id>4129\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>st user story(agile pack)\</name> \<prefix>st us(agile pack)\</prefix> \<standardartifacttypeid>4126\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>usecase\</baseartifacttype> \<description> \</description> \<id>4538\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 1\</name> \<prefix>prefix 1\</prefix> \<standardartifacttypeid>4535\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>usecase\</baseartifacttype> \<description> \</description> \<id>4590\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 3\</name> \<prefix>prefix 3\</prefix> \<standardartifacttypeid>4587\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>document\</baseartifacttype> \<description> \</description> \<id>4616\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 4\</name> \<prefix>prefix 4\</prefix> \<standardartifacttypeid>4613\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>actor\</baseartifacttype> \<description> \</description> \<id>4642\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>custom v1 artifact\</name> \<prefix>cva\</prefix> \<standardartifacttypeid>4639\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>actor\</baseartifacttype> \<description> \</description> \<id>5176\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 5\</name> \<prefix>prefix 5\</prefix> \<standardartifacttypeid>5173\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>primitivefolder\</baseartifacttype> \<description> \</description> \<id>5207\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 6\</name> \<prefix>prefix 6\</prefix> \<standardartifacttypeid>5204\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>glossary\</baseartifacttype> \<description> \</description> \<id>5238\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 7\</name> \<prefix>prefix 7\</prefix> \<standardartifacttypeid>5235\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>actor\</baseartifacttype> \<description> \</description> \<id>5269\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>standard artifact type 8\</name> \<prefix>prefix 8\</prefix> \<standardartifacttypeid>5266\</standardartifacttypeid> \</artifacttype> \<artifacttype> \<baseartifacttype>process\</baseartifacttype> \<description> \</description> \<id>5380\</id> \<isusedinthisproject>true\</isusedinthisproject> \<name>process (std)\</name> \<prefix>pro std\</prefix> \<standardartifacttypeid>5377\</standardartifacttypeid> \</artifacttype> \</artifacttypes> json example request uri https //production blueprintcloud com/api/v1/projects/220870/metadata/artifacttypes?limit=5\&offset=0 response header {'content length' '944', 'expires' ' 1', 'server' 'blueprint', 'content range' 'artifact types 0 4/22', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 11 42 57 gmt', 'content type' 'application/json; charset=utf 8'} response body \[ { "id" 551, "name" "folder", "description" "description", "prefix" "pf", "baseartifacttype" "primitivefolder" }, "id" 552, "name" "glossary", "description" "list of terms and definitions ", "prefix" "gl", "baseartifacttype" "glossary" }, { "id" 553, "name" "textual requirement", "description" "a text based requirement that does not fit into any of the other textual requirement types ", "prefix" "rq", "baseartifacttype" "textualrequirement" }, { "id" 554, "name" "business process diagram", "description" "a swimlane oriented process diagram depicting how business tasks relate one to another to accomplish an overall goal of the business ", "prefix" "bp dg", "baseartifacttype" "businessprocess" }, { "id" 555, "name" "actor", "description" "an actor is either a human or another system that interacts with the system under development for the purpose of accomplishing certain goals (use cases) with the system ", "prefix" "actor", "baseartifacttype" "actor" }, { "id" 556, "name" "use case", "description" "describes the interaction between an actor and the system under development to accomplish a given goal ", "prefix" "uc", "baseartifacttype" "usecase" }, { "id" 557, "name" "screen", "description" "a user interface mockup of a screen for the system under developlent ", "prefix" "scrn", "baseartifacttype" "uimockup" }, { "id" 558, "name" "generic diagram", "description" "any diagram format that is not a business process or domain diagram ", "prefix" "gen dg", "baseartifacttype" "genericdiagram" }, { "id" 559, "name" "document", "description" "description", "prefix" "doc", "baseartifacttype" "document" }, { "id" 560, "name" "storyboard", "description" "a connected set of screens used to demonstrate screen to screen based navigation ", "prefix" "sb", "baseartifacttype" "storyboard" }, { "id" 561, "name" "domain diagram", "description" "a diagram depicting how entities or classes relate to one another ", "prefix" "dom dg", "baseartifacttype" "domaindiagram" }, { "id" 565, "name" "business requirement", "description" "describes a business need and is considered to answer the question "why" does the business need this ", "prefix" "bus rq", "baseartifacttype" "textualrequirement" }, { "id" 566, "name" "business rule", "description" "describes a business constraint that the system under development must adhere to ", "prefix" "bus rl", "baseartifacttype" "textualrequirement" }, { "id" 567, "name" "data definitions", "description" "defines the characteristics (type, length, etc ) of data elements ", "prefix" "data def", "baseartifacttype" "textualrequirement" }, { "id" 568, "name" "functional requirement", "description" "describes the tasks that the system must perform in order to satisfy the tasks of the users typically answers the question "how" will the system meet the needs of the users ", "prefix" "func rq", "baseartifacttype" "textualrequirement" }, { "id" 569, "name" "quality of service requirement", "description" "describes the non functional characteristics of the system often referred to as the "ilities," e g scalability, reliability, usability, etc ", "prefix" "qs rq", "baseartifacttype" "textualrequirement" }, { "id" 570, "name" "screen definitions", "description" "defines the specific fields for a given screen ", "prefix" "scrn def", "baseartifacttype" "textualrequirement" }, { "id" 571, "name" "user requirement", "description" "describes the tasks that a user needs to perform with the system in order to satisfy the needs of the business typically answers the question "what" must the user do with the system ", "prefix" "user rq", "baseartifacttype" "textualrequirement" }, { "id" 572, "name" "error messages", "description" "used to document error messages and warnings ", "prefix" "err msg", "baseartifacttype" "textualrequirement" }, { "id" 573, "name" "use case diagram", "description" "description", "prefix" "ucd", "baseartifacttype" "usecasediagram" }, { "id" 574, "name" "information", "description" "edit description", "prefix" "info", "baseartifacttype" "textualrequirement" }, { "id" 3532, "name" "process", "description" "description", "prefix" "pro", "baseartifacttype" "process" }, { "id" 4019, "name" "st user story(6)", "description" "used for storyteller", "prefix" "stus(7)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4016, "isusedinthisproject" true }, { "id" 4041, "name" "epic(agile pack)", "description" "epic is a large user story", "prefix" "ep(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4038, "isusedinthisproject" true }, { "id" 4063, "name" "feature(agile pack)", "description" "a process that adds value to a customer and it can be planned ", "prefix" "ft(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4060, "isusedinthisproject" true }, { "id" 4085, "name" "scenario(agile pack)", "description" "a real world example of how one or more people or organizations interact with a system ", "prefix" "sc(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4082, "isusedinthisproject" true }, { "id" 4107, "name" "theme(agile pack)", "description" "a grouping of stories ", "prefix" "th(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4104, "isusedinthisproject" true }, { "id" 4129, "name" "st user story(agile pack)", "description" "used in agile development to capture the description of a software feature from and end user perspective ", "prefix" "st us(agile pack)", "baseartifacttype" "textualrequirement", "standardartifacttypeid" 4126, "isusedinthisproject" true }, { "id" 4538, "name" "standard artifact type 1", "description" "", "prefix" "prefix 1", "baseartifacttype" "usecase", "standardartifacttypeid" 4535, "isusedinthisproject" true }, { "id" 4590, "name" "standard artifact type 3", "description" "", "prefix" "prefix 3", "baseartifacttype" "usecase", "standardartifacttypeid" 4587, "isusedinthisproject" true }, { "id" 4616, "name" "standard artifact type 4", "description" "", "prefix" "prefix 4", "baseartifacttype" "document", "standardartifacttypeid" 4613, "isusedinthisproject" true }, { "id" 4642, "name" "custom v1 artifact", "description" "", "prefix" "cva", "baseartifacttype" "actor", "standardartifacttypeid" 4639, "isusedinthisproject" true }, { "id" 5176, "name" "standard artifact type 5", "description" "", "prefix" "prefix 5", "baseartifacttype" "actor", "standardartifacttypeid" 5173, "isusedinthisproject" true }, { "id" 5207, "name" "standard artifact type 6", "description" "", "prefix" "prefix 6", "baseartifacttype" "primitivefolder", "standardartifacttypeid" 5204, "isusedinthisproject" true }, { "id" 5238, "name" "standard artifact type 7", "description" "", "prefix" "prefix 7", "baseartifacttype" "glossary", "standardartifacttypeid" 5235, "isusedinthisproject" true }, { "id" 5269, "name" "standard artifact type 8", "description" "", "prefix" "prefix 8", "baseartifacttype" "actor", "standardartifacttypeid" 5266, "isusedinthisproject" true }, { "id" 5380, "name" "process (std)", "description" "", "prefix" "pro std", "baseartifacttype" "process", "standardartifacttypeid" 5377, "isusedinthisproject" true }]