--- title: REST API - Get Artifact Type Request slug: rm/rest-api-get-artifact-type-request docTags: createdAt: 2026-06-09T13:38:46.452Z --- ```bash /api/v1/projects/{projectId}/metadata/artifactTypes/{artifactTypeId}?richtextasplain={richtextasplain}&inlinecss={inlinecss} ``` # Description Retrieves all artifact type objects from a project. # URL Structure ```bash [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 `` 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** ```ruby https://production.blueprintcloud.com/api/v1/projects/220870/metadata/artifactTypes/11559? ``` **Response Header** ```rust {'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 TextualRequirement Epic is a large User Story 11559 true Epic(Agile Pack) EP(Agile Pack) Text false 434 true false ID false false Text false 435 false true Name false false Text true 436 false false Description

true true User false 474 true false Created By Date false 475 true false Created On false User false 476 true false Last Edited By Date false 477 true false Last Edited On false Choice true 3881 false false Tshirt(Agile Pack) 3878 false 0 false XS S M L XL Text false 4875 false false 22 4872 true true Text false 4905 false false Standard Property 6 4902 true true Text false 5036 false false Standard Property 7 5033 true true Text false 5099 false false Standard Property 9 5096 true true Text false 5130 false false Standard Property 10 5127 true true Text false 5298 false true Standard Property 12 5295 true true Choice true 6676 false false Standard Property 13 6673 true 0 false a b 4038 ``` ## JSON Example **Request URI** ```ruby https://production.blueprintcloud.com/api/v1/projects/220870/metadata/artifactTypes/11559? ``` **Response Header** ```rust {'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** ```json { "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 } ]} ```