List Artifact Types
/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.
Note: The IsUsedInThisProject, StandardPropertyTypeId, and StandardArtifactTypeId elements in the response body are only returned when using Blueprint 7.3 and later.
|
|
URL
Structure
|
[Blueprint_URI]/api/v1/projects/{projectId}/metadata/ArtifactTypes
|
|
Supported Methods
|
|
|
Request URI Parameters
|
- PropertyTypes : 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 : 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 : 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.
Note: This parameter is supported in Blueprint 6.1 and later.
-
Offset : Defines the paging offset (that is, index) at which the results start. Offset the default is 0.
-
Limit : 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
-
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
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>
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
}
]
XML Example