Attachment

• postUpload attachment
• postLoad thumbnails
• postLoad attachment

API docs by Redocly

TMT API (1.0.0)

Download OpenAPI specification:Download

API working with Test folders in TMT

Upload attachment

Upload attachment to TMT
Notice: For attachments of types: JPEG, PNG, BMP, WBMP , GIF or SVG, thumbnails will be generated with .png extension in 2 configurable sizes: small thumbnal and big thumbnail. Only images has smallThumbnailUrl and bigThumbnailUrl in the response
This attachment response then can be used to build the document content during the add/modify document operation

Authorizations:

bearerAuth

path Parameters

filename required	string Example: image.png s not only attachment identifier the user knows but also with correct file extension might be a hint for supporting attachment mime type detection more precisely, therefore it is vital for attachment handling.
documentModelName required	string Example: TestSuite-dm is needed for security purposes. The user of this endpoint must have the read access to this document.
pathToField	string Example: /Root/Attachments reserved for future, but it is mandatory parameter. Empty string could be used.

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Responses

https://q12-tmt.com/api/v2/attachment?filename={filename}&documentModelName={documentName}&pathToField={path}

Response samples

• 200

Content type

application/json

{

• "attachmentId": "60b87e2a-f5b5-4540-8335-4f2e4d58b0e0",
• "filename": "1700559417826-8a9fca09-5dd3-4bf8-9bba-093ac730772e.png",
• "mimeType": "image/png",
• "smallThumbnailUrl": "https://q12-tmt.com/cs/download/ad6be8d7-aa40-45c9-8ea9-2620077319a8",
• "bigThumbnailUrl": "https://q12-tmt.com/cs/download/2d10c4ff-3d39-4c9d-8468-0c04b7dbafe7",
• "size": 4952,
• "annotations": [ ]

}

Load thumbnails

Load a thumbnail by given attachment id

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string LOAD_THUMBNAIL_URL
required	object

Responses

https://q12-tmt.com/api/v2/rpc (LOAD_THUMBNAIL_URL)

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LOAD_THUMBNAIL_URL_f7a4cb03-0e73-4843-8c85-42fc58373f76",
• "method": "LOAD_THUMBNAIL_URL",
• "params": {

  • "attachmentId": "111c7b20-60aa-44b4-b8df-667fe0dfacac"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LOAD_THUMBNAIL_URL_f7a4cb03-0e73-4843-8c85-42fc58373f76",
• "result": {

  • "smallThumbnailUrl": "https://demo.q12-tmt.com/cs/download/9c01be12-01ff-4173-9403-6edf670dca50",
  • "bigThumbnailUrl": "https://demo.q12-tmt.com/cs/download/644ee139-4a02-424e-8549-a0f54f4571f2"

  }

}

Load attachment

Generate expirable public URLs (no security will be applied during download) with instruction for the browser not to cache. The expiration time is 5 minutes

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string LOAD_ATTACHMENT_URL
required	object

Responses

https://q12-tmt.com/api/v2/rpc (LOAD_ATTACHMENT_URL)

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "7292c210-c779-44da-a803-925e7211f13c",
• "method": "LOAD_ATTACHMENT_URL",
• "params": {

  • "attachmentId": "7292c210-c779-44da-a803-925e7211f13c",
  • "docRef": "TestCase-dm/656241"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "7292c210-c779-44da-a803-925e7211f13c",
• "result": {

  • "location": "https://demo.q12-tmt.com/cs/download/fb2568f6-ea18-4c37-9956-f7cb0923245e?filename=1731919495027-30b37cef-cb96-4879-a893-c93055a02294.json"

  }

}