Project

• postList parent projects
• postList sub projects
• postLoad project with version
• postLoad project setting
• postGet project detail
• postUpdate project detail
• postCreate new project version

API docs by Redocly

TMT API (1.0.0)

Download OpenAPI specification:Download

API for loading projects by tenant.

List parent projects

Return the parent projects that are being assigned to the calling user. A parent project can contain multiple sub projects, that can be queried via operation List sub projects

Authorizations:

bearerAuth

Request Body schema: application/json

required

Array

id required	string id of the operation
jsonrpc required	string must be 2.0
method	string LOAD_PROJECTS_BY_TENANT
params	object Empty

Responses

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

Request samples

• Payload

Content type

application/json

{

• "id": "RMProjectSubproject-rmRoleProjectSourceUnknown",
• "jsonrpc": "2.0",
• "method": "LOAD_PROJECTS_BY_TENANT",
• "params": { }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "RMProjectSubproject-rmRoleProjectSourceUnknown",
• "result": [

  • {

    • "linkRef": {

      • "linkDescriptor": {

        • "relationshipModel": "ProjectSubproject-rm",
        • "entities": [

          • {

            • "role": null,
            • "modelName": null,
            • "docRef": null

            },
          • {

            • "role": "Project",
            • "modelName": "Project-dm",
            • "docRef": "Project-dm/6300"

            }

          ],
        • "predecessorLinkRef": null,
        • "position": "TOP"

        },
      • "id": null

      },
    • "document": {

      • "Root": {

        • "General": {

          • "Title": "0_Trung.Phan",
          • "Id": "P_28",
          • "TechnicalId": "284a3939-a949-44b4-88e6-6336caa9dd49",
          • "TenantId": "T_1",
          • "ParentId": "_",
          • "Description": "new décription",
          • "TestSuites": 7,
          • "TestRuns": "1/3"

          },
        • "Metadata": {

          • "CreatedBy": "tmtdev",
          • "DisplayCreatedOn": "2023-03-14T03:05:26",
          • "CreatedOn": 1678763126588,
          • "EditedBy": "viethuynh",
          • "DisplayEditedOn": "2024-09-06T03:22:06",
          • "EditedOn": 1725592926737

          }

        },
      • "__meta": {

        • "creator": "tmtdev",
        • "modifier": "viethuynh",
        • "docRef": "Project-dm/6300",
        • "modelReference": "Project-dm",
        • "createdAt": "2023-03-14T03:05:26",
        • "modifiedAt": "2024-09-06T03:22:06",
        • "modelVersion": null

        },
      • "docRef": "Project-dm/6300"

      }

    },
  • {

    • "linkRef": {

      • "linkDescriptor": {

        • "relationshipModel": "ProjectSubproject-rm",
        • "entities": [

          • {

            • "role": null,
            • "modelName": null,
            • "docRef": null

            },
          • {

            • "role": "Project",
            • "modelName": "Project-dm",
            • "docRef": "Project-dm/332906"

            }

          ],
        • "predecessorLinkRef": null,
        • "position": "TOP"

        },
      • "id": null

      },
    • "document": {

      • "Root": {

        • "General": {

          • "Title": "Export QF",
          • "TenantId": "T_1",
          • "TechnicalId": "741a9cc2-4e91-447b-bab0-bf54b352e41b",
          • "Id": "P_186",
          • "ParentId": "_",
          • "TestSuites": 2,
          • "TestRuns": "3/3"

          },
        • "Metadata": {

          • "CreatedBy": "tmtdev",
          • "DisplayCreatedOn": "2024-06-04T03:53:52",
          • "CreatedOn": 1717473232892,
          • "EditedBy": "trung",
          • "DisplayEditedOn": "2024-11-07T09:02:50",
          • "EditedOn": 1730970170788

          },
        • "Attachments": [

          • {

            • "FileName": "Screenshot 2024-10-12 at 08.38.29.png",
            • "CreatedAt": "2024-11-07T09:02:47",
            • "UploadOn": "2024-11-07",
            • "OriginalFileName": "Screenshot 2024-10-12 at 08.38.29.png",
            • "UploadBy": "trung",
            • "Referenced": false,
            • "CopyNumber": 0,
            • "ThumbnailId": "5bc53f80-1b7d-43c1-86a8-d243ba6509a7",
            • "File": {

              • "content": null,
              • "attachment_id": "4ceb97fe-ce0f-499c-959b-dd0bf35da26d",
              • "internal_filename": "1730970164198-6bb49d5d-0d27-4f0e-96f2-56afaf62a498.png",
              • "original_filename": "Screenshot 2024-10-12 at 08.38.29.png",
              • "size": 302995,
              • "mime_type": "image/png"

              }

            }

          ]

        },
      • "__meta": {

        • "creator": "tmtdev",
        • "modifier": "trung",
        • "docRef": "Project-dm/332906",
        • "modelReference": "Project-dm",
        • "createdAt": "2024-06-04T03:53:52",
        • "modifiedAt": "2024-11-07T09:02:50",
        • "modelVersion": null

        },
      • "docRef": "Project-dm/332906"

      }

    },
  • {

    • "linkRef": {

      • "linkDescriptor": {

        • "relationshipModel": "ProjectSubproject-rm",
        • "entities": [

          • {

            • "role": null,
            • "modelName": null,
            • "docRef": null

            },
          • {

            • "role": "Project",
            • "modelName": "Project-dm",
            • "docRef": "Project-dm/26"

            }

          ],
        • "predecessorLinkRef": null,
        • "position": "TOP"

        },
      • "id": null

      },
    • "document": {

      • "Root": {

        • "General": {

          • "Title": "TN Project",
          • "Id": "P_2",
          • "TechnicalId": "6567d397-19f3-4b69-bc6b-233dcd6c2390",
          • "TenantId": "T_1",
          • "ParentId": "_",
          • "TestSuites": 10,
          • "TestRuns": "4/7"

          },
        • "Metadata": {

          • "CreatedBy": "tmtdev",
          • "DisplayCreatedOn": "2022-11-29T03:56:21",
          • "CreatedOn": 1669694181806,
          • "EditedBy": "tmtdev",
          • "DisplayEditedOn": "2022-11-29T03:56:21",
          • "EditedOn": 1669694181806

          }

        },
      • "__meta": {

        • "creator": "tmtdev",
        • "modifier": "tmtdev",
        • "docRef": "Project-dm/26",
        • "modelReference": "Project-dm",
        • "createdAt": "2022-11-29T03:56:21",
        • "modifiedAt": "2023-04-17T10:45:57",
        • "modelVersion": null

        },
      • "docRef": "Project-dm/26"

      }

    }

  ]

}

List sub projects

Return the sub projects that are being assigned to the calling user for given parent projects

Authorizations:

bearerAuth

Request Body schema: application/json

required

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

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LIST_SUB_PROJECTS_2ddc679a-75c5-4981-b7e7-8f9f99c6f73c",
• "method": "LIST_SUB_PROJECTS",
• "params": {

  • "page": {

    • "offset": 0,
    • "limit": 2147483647

    },
  • "filter": { },
  • "sort": { },
  • "sources": [

    • {

      • "docRef": "Project-dm/6300",
      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project"

      },
    • {

      • "docRef": "Project-dm/332906",
      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project"

      },
    • {

      • "docRef": "Project-dm/26",
      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LIST_SUB_PROJECTS_2ddc679a-75c5-4981-b7e7-8f9f99c6f73c",
• "result": [

  • {

    • "source": {

      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project",
      • "docRef": "Project-dm/6300"

      },
    • "linkResultEntries": {

      • "fullSize": 1,
      • "page": {

        • "offset": 0,
        • "limit": 2147483647

        },
      • "entries": [

        • {

          • "linkRef": {

            • "linkDescriptor": {

              • "relationshipModel": "ProjectSubproject-rm",
              • "entities": [

                • {

                  • "role": "Project",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/6300"

                  },
                • {

                  • "role": "Subproject",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/66419"

                  }

                ],
              • "predecessorLinkRef": null,
              • "position": "TOP"

              },
            • "id": "65983"

            },
          • "document": {

            • "target": {

              • "Root": {

                • "General": {

                  • "ParentId": "P_28",
                  • "Title": "test",
                  • "TenantId": "T_1",
                  • "TechnicalId": "9dd88714-c335-4101-b4a2-4a2c1190ac28",
                  • "Id": "SP_1",
                  • "ParentDocRef": "Project-dm/6300",
                  • "TestSuites": 14,
                  • "TestRuns": "3/4"

                  },
                • "Metadata": {

                  • "CreatedBy": "sontrinh",
                  • "DisplayCreatedOn": "2023-11-27T07:56:59",
                  • "CreatedOn": 1701071819340,
                  • "EditedBy": "tmtdev",
                  • "DisplayEditedOn": "2024-03-12T09:24:18",
                  • "EditedOn": 1710235458578

                  }

                },
              • "__meta": {

                • "creator": "sontrinh",
                • "modifier": "sontrinh",
                • "docRef": "Project-dm/66419",
                • "modelReference": "Project-dm",
                • "createdAt": "2023-11-27T07:56:59",
                • "modifiedAt": "2024-03-12T09:24:26",
                • "modelVersion": null

                },
              • "docRef": "Project-dm/66419"

              }

            }

          }

        ]

      }

    },
  • {

    • "source": {

      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project",
      • "docRef": "Project-dm/332906"

      },
    • "linkResultEntries": {

      • "fullSize": 0,
      • "page": {

        • "offset": 0,
        • "limit": 2147483647

        },
      • "entries": [ ]

      }

    },
  • {

    • "source": {

      • "relationshipModel": "ProjectSubproject-rm",
      • "role": "Project",
      • "docRef": "Project-dm/26"

      },
    • "linkResultEntries": {

      • "fullSize": 3,
      • "page": {

        • "offset": 0,
        • "limit": 2147483647

        },
      • "entries": [

        • {

          • "linkRef": {

            • "linkDescriptor": {

              • "relationshipModel": "ProjectSubproject-rm",
              • "entities": [

                • {

                  • "role": "Project",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/26"

                  },
                • {

                  • "role": "Subproject",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/161"

                  }

                ],
              • "predecessorLinkRef": null,
              • "position": "TOP"

              },
            • "id": "189"

            },
          • "document": {

            • "target": {

              • "Root": {

                • "General": {

                  • "ParentId": "P_2",
                  • "Title": "TN subproject",
                  • "Id": "SP_1",
                  • "TechnicalId": "8a0995f0-6379-4e25-91fa-aefec5179581",
                  • "TenantId": "T_1",
                  • "TestSuites": 11,
                  • "TestRuns": "2/4"

                  },
                • "Metadata": {

                  • "CreatedBy": "tmtdev",
                  • "DisplayCreatedOn": "2022-11-29T06:54:07",
                  • "CreatedOn": 1669704847116,
                  • "EditedBy": "tmtdev",
                  • "DisplayEditedOn": "2022-11-29T06:54:07",
                  • "EditedOn": 1669704847116

                  }

                },
              • "__meta": {

                • "creator": "tmtdev",
                • "modifier": "tmtdev",
                • "docRef": "Project-dm/161",
                • "modelReference": "Project-dm",
                • "createdAt": "2022-11-29T06:54:07",
                • "modifiedAt": "2022-11-29T06:54:07",
                • "modelVersion": null

                },
              • "docRef": "Project-dm/161"

              }

            }

          },
        • {

          • "linkRef": {

            • "linkDescriptor": {

              • "relationshipModel": "ProjectSubproject-rm",
              • "entities": [

                • {

                  • "role": "Project",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/26"

                  },
                • {

                  • "role": "Subproject",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/165"

                  }

                ],
              • "predecessorLinkRef": null,
              • "position": "TOP"

              },
            • "id": "193"

            },
          • "document": {

            • "target": {

              • "Root": {

                • "General": {

                  • "ParentId": "P_2",
                  • "Title": "TN SJ2",
                  • "Id": "SP_2",
                  • "TechnicalId": "2358a5ec-255f-4790-b1ed-8d09e0814319",
                  • "TenantId": "T_1",
                  • "TestSuites": 3,
                  • "TestRuns": ""

                  },
                • "Metadata": {

                  • "CreatedBy": "tmtdev",
                  • "DisplayCreatedOn": "2022-11-29T06:54:19",
                  • "CreatedOn": 1669704859708,
                  • "EditedBy": "tmtdev",
                  • "DisplayEditedOn": "2022-11-29T06:54:19",
                  • "EditedOn": 1669704859708

                  }

                },
              • "__meta": {

                • "creator": "tmtdev",
                • "modifier": "tmtdev",
                • "docRef": "Project-dm/165",
                • "modelReference": "Project-dm",
                • "createdAt": "2022-11-29T06:54:19",
                • "modifiedAt": "2022-11-29T06:54:19",
                • "modelVersion": null

                },
              • "docRef": "Project-dm/165"

              }

            }

          },
        • {

          • "linkRef": {

            • "linkDescriptor": {

              • "relationshipModel": "ProjectSubproject-rm",
              • "entities": [

                • {

                  • "role": "Project",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/26"

                  },
                • {

                  • "role": "Subproject",
                  • "modelName": "Project-dm",
                  • "docRef": "Project-dm/545"

                  }

                ],
              • "predecessorLinkRef": null,
              • "position": "TOP"

              },
            • "id": "483"

            },
          • "document": {

            • "target": {

              • "Root": {

                • "General": {

                  • "ParentId": "P_2",
                  • "Title": "PJ error",
                  • "Id": "SP_3",
                  • "TechnicalId": "a57997a1-82ed-40bc-a975-238c9060fdca",
                  • "TenantId": "T_1",
                  • "TestSuites": 0,
                  • "TestRuns": ""

                  },
                • "Metadata": {

                  • "CreatedBy": "titnguyen",
                  • "DisplayCreatedOn": "2022-11-29T09:09:23",
                  • "CreatedOn": 1669712963556,
                  • "EditedBy": "titnguyen",
                  • "DisplayEditedOn": "2022-11-29T09:09:23",
                  • "EditedOn": 1669712963556

                  }

                },
              • "__meta": {

                • "creator": "titnguyen",
                • "modifier": "titnguyen",
                • "docRef": "Project-dm/545",
                • "modelReference": "Project-dm",
                • "createdAt": "2022-11-29T09:09:23",
                • "modifiedAt": "2022-11-29T09:09:23",
                • "modelVersion": null

                },
              • "docRef": "Project-dm/545"

              }

            }

          }

        ]

      }

    }

  ]

}

Load project with version

Return the project information along with its latest version info

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_PROJECT_WITH_VERSION
required	object (ProjectVersionSpec) project specification

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "ProjectWithVersionOperation",
• "method": "LOAD_PROJECT_WITH_VERSION",
• "params": {

  • "projectSpec": {

    • "projectId": "P_28",
    • "subProjectId": "_"

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "ProjectWithVersionOperation",
• "result": {

  • "docRef": "Project-dm/6300",
  • "documentModelName": "Project-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "Title": "Toy space",
        • "Id": "P_28",
        • "TechnicalId": "284a3939-a949-44b4-88e6-6336caa9dd49",
        • "TenantId": "T_1",
        • "ParentId": "_",
        • "Description": "everyone can play with this project"

        },
      • "Metadata": {

        • "CreatedBy": "tphan",
        • "DisplayCreatedOn": "2023-03-14T03:05:26",
        • "CreatedOn": 1678763126588,
        • "EditedBy": "viethuynh",
        • "DisplayEditedOn": "2024-09-06T03:22:06",
        • "EditedOn": 1725592926737

        },
      • "Version": {

        • "DocRef": "Version-dm/de0332f3-06ff-4ed4-a06e-2978d16b3ba6",
        • "General": {

          • "ProjectId": "P_28",
          • "SubprojectId": "_",
          • "VersionNumber": "2.0.0",
          • "DerivedVersionNumber": "1.0.0",
          • "DerivedVersionCreatedOn": 1678763129233,
          • "DerivedVersionTitle": "0_Trung.Phan",
          • "Status": "open",
          • "Title": "200",
          • "TenantId": "T_1",
          • "Id": "929e1fb7-4c44-4e05-afdc-03c6e6a3cfe2",
          • "TechnicalId": "56fb5a72-4ad4-46ba-a38c-c791d0c00b5f",
          • "WrapperNode": false,
          • "UseSubjectSpecificOrderForTestSuite": false,
          • "Ancestors": "|[1.0.0]|",
          • "IsLatestVersion": true

          },
        • "Metadata": {

          • "CreatedBy": "sontrinh",
          • "DisplayCreatedOn": "2024-10-18T03:17:54",
          • "CreatedOn": 1729221474841,
          • "EditedBy": "sontrinh",
          • "DisplayEditedOn": "2024-10-18T03:17:54",
          • "EditedOn": 1729221474841

          }

        }

      },
    • "__meta": {

      • "creator": "tphan",
      • "modifier": "viethuynh",
      • "docRef": "Project-dm/6300",
      • "modelReference": "Project-dm",
      • "createdAt": "2023-03-14T03:05:26",
      • "modifiedAt": "2024-09-06T03:22:06",
      • "modelVersion": null

      }

    }

  }

}

Load project setting

Load setting of a project

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_PROJECT_SETTING
required	object (ProjectSpec) project specification

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LoadProjectSettingOperation",
• "method": "LOAD_PROJECT_SETTING",
• "params": {

  • "projectId": "P_28",
  • "subProjectId": "_"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LoadProjectSettingOperation",
• "result": {

  • "testSuiteSetting": {

    • "testSuiteOverview": [ ],
    • "testCaseOverview": [

      • "column-92b35",
      • "column-c5709",
      • "column-78bec",
      • "column-f4ffc",
      • "column-f73e5",
      • "column-50c55",
      • "column-2f15a",
      • "column-3bc42",
      • "column-860db",
      • "column-ea604",
      • "column-6369d",
      • "column-62746",
      • "column-ad8b3",
      • "column-f9bc0",
      • "column-fdde0",
      • "column-a2e75",
      • "column-c83ca",
      • "column-a6ce7",
      • "column-4b613",
      • "column-66b95"

      ],
    • "testCaseOverviewDisplayedFields": [

      • "Root.General.Title",
      • "Root.General.Id",
      • "Root.General.Status",
      • "Root.General.User",
      • "Root.General.Automation",
      • "Root.Risk.Likelihood",
      • "Root.Risk.Impact",
      • "Root.Criteria.Tags"

      ]

    },
  • "testRunSetting": {

    • "testRunOverview": [

      • "column-9a045",
      • "column-cf6d8",
      • "column-17b62"

      ],
    • "testSelection": [ ],
    • "testCaseOverview": [

      • "column-d68fa",
      • "column-092f0",
      • "column-7e7a3"

      ],
    • "testCaseOverviewDisplayedFields": [

      • "Root.General.Title",
      • "Root.General.Id",
      • "Root.General.User"

      ],
    • "testScope": [

      • "column-60fb2"

      ]

    },
  • "generalSetting": {

    • "jiraSetting": {

      • "DefaultUrl": "https://mgm.com/jira/browse/",
      • "AdditionalInstances": [

        • {

          • "Token": "TMT",
          • "Url": "https://jira.com/jira/browse/"

          }

        ]

      },
    • "azureDevOpsSetting": {

      • "defaultUrl": ""

      },
    • "testCaseTreeSetting": {

      • "lazyLoadingEnable": false,
      • "expandLevel": 2

      },
    • "tdsSetting": {

      • "inTdsTenant": false,
      • "tdsUrl": "http://localhost:3000/from-tmt",
      • "elster": false

      },
    • "riskBaseSetting": {

      • "TestHistoryFrequency": "20,40,60,80",
      • "TestHistorySeverity": "0.75,1.5,3.5,5",
      • "ClusterDefectWeightMapping": "{\n\t\t\"PriorityToDefectCluster\": {\n\t\t\t\"Blocker\": \"Blocker\",\n\n\t\t\t\"Critical\": \"Critical\",\n\t\t\t\"Highest\": \"Critical\",\n\n\t\t\t\"Major\": \"Major\",\n\t\t\t\"High\": \"Major\",\n\n\t\t\t\"Medium\": \"Normal\",\n\t\t\t\"Normal\": \"Normal\",\n\t\t\t\"NotPrioritized\": \"Normal\",\n\n\t\t\t\"Low\": \"Minor\",\n\t\t\t\"Minor\": \"Minor\",\n\t\t\t\"Trivial\": \"Minor\",\n\t\t\t\"Lowest\": \"Minor\"\n\t\t},\n\t\t\"DefectClusterToDefectWeight\": {\n\t\t\t\"Blocker\": 10,\n\t\t\t\"Critical\": 5,\n\t\t\t\"Major\": 2,\n\t\t\t\"Normal\": 1,\n\t\t\t\"Minor\": 0.5\n\t\t}\n\t}",
      • "testHistoryRiskLevelMatrixStr": "H,H,H,H,M;H,H,M,M,L;H,M,M,M,L;H,M,M,L,L;M,L,L,L,L"

      }

    }

  }

}

Get project detail

Load project document

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 GET_DOCUMENT
required	object

Responses

https://q12-tmt.com/api/v2/rpc (GET_DOCUMENT for Project)

Request samples

• Payload

Content type

application/json

{

• "id": "TestSuites.DataProvider-98",
• "jsonrpc": "2.0",
• "method": "GET_DOCUMENT",
• "params": {

  • "docRef": "Project-dm/332906"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "TestSuites.DataProvider-98",
• "result": {

  • "docRef": "Project-dm/332906",
  • "documentModelName": "Project-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "Title": "Export QF",
        • "TenantId": "T_1",
        • "TechnicalId": "741a9cc2-4e91-447b-bab0-bf54b352e41b",
        • "Id": "P_186",
        • "ParentId": "_",
        • "Description": "This is a description"

        },
      • "Metadata": {

        • "CreatedBy": "tmtdev",
        • "DisplayCreatedOn": "2024-06-04T03:53:52",
        • "CreatedOn": 1717473232892,
        • "EditedBy": "trung",
        • "DisplayEditedOn": "2024-11-08T06:49:26",
        • "EditedOn": 1731048566538

        },
      • "Attachments": [

        • {

          • "FileName": "Screenshot 2024-10-12 at 08.38.29.png",
          • "CreatedAt": "2024-11-07T09:02:47",
          • "UploadOn": "2024-11-07",
          • "OriginalFileName": "Screenshot 2024-10-12 at 08.38.29.png",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "5bc53f80-1b7d-43c1-86a8-d243ba6509a7",
          • "File": {

            • "content": null,
            • "attachment_id": "4ceb97fe-ce0f-499c-959b-dd0bf35da26d",
            • "internal_filename": "1730970164198-6bb49d5d-0d27-4f0e-96f2-56afaf62a498.png",
            • "original_filename": "Screenshot 2024-10-12 at 08.38.29.png",
            • "size": 302995,
            • "mime_type": "image/png"

            }

          }

        ]

      },
    • "__meta": {

      • "creator": "tmtdev",
      • "modifier": "trung",
      • "docRef": "Project-dm/332906",
      • "modelReference": "Project-dm",
      • "createdAt": "2024-06-04T03:53:52",
      • "modifiedAt": "2024-11-08T06:49:26",
      • "modelVersion": null

      }

    }

  }

}

Update project detail

Update project document

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 MODIFY_DOCUMENT
required	object

Responses

https://q12-tmt.com/api/v2/rpc (MODIFY_DOCUMENT for Project)

Request samples

• Payload

Content type

application/json

{

• "id": "update-project-dm-t1",
• "method": "MODIFY_DOCUMENT",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "Title": "Export QF edited",
        • "TenantId": "T_1",
        • "TechnicalId": "741a9cc2-4e91-447b-bab0-bf54b352e41b",
        • "Id": "P_186",
        • "ParentId": "_",
        • "Description": "This is new description"

        },
      • "Attachments": [

        • {

          • "FileName": "Screenshot 2024-10-12 at 08.38.29.png",
          • "CreatedAt": "2024-11-07T09:02:47",
          • "UploadOn": "2024-11-07",
          • "OriginalFileName": "Screenshot 2024-10-12 at 08.38.29.png",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "5bc53f80-1b7d-43c1-86a8-d243ba6509a7",
          • "File": {

            • "content": null,
            • "attachment_id": "4ceb97fe-ce0f-499c-959b-dd0bf35da26d",
            • "internal_filename": "1730970164198-6bb49d5d-0d27-4f0e-96f2-56afaf62a498.png",
            • "original_filename": "Screenshot 2024-10-12 at 08.38.29.png",
            • "size": 302995,
            • "mime_type": "image/png"

            }

          }

        ]

      }

    },
  • "locale": "en",
  • "docRef": "Project-dm/332906"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "update-project-dm-t1",
• "result": null

}

Create new project version

Trigger a task request to create new project version. Task request will then run on background. When done, the new version should have test suites and test cases of the derived version. Please refer to Get task request to check the progress of the process

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 MODIFY_DOCUMENT
required	object

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "CREATE_PROJECT_VERSION_3edca49d-5d1e-47b8-b40d-b89d726797f4",
• "method": "CREATE_PROJECT_VERSION",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_186",
        • "SubprojectId": "_",
        • "VersionNumber": "1.0.1",
        • "DerivedVersionNumber": "1.0.0",
        • "DerivedVersionCreatedOn": 1717473233273,
        • "DerivedVersionTitle": "2_Export QF",
        • "Status": "open",
        • "Title": "Version 1.0.1",
        • "KeyPoints": "this is the keypoints",
        • "Description": "this is the description"

        },
      • "Attachments": [

        • {

          • "FileName": "Screenshot 2024-11-06 at 15.43.34.png",
          • "File": {

            • "content": null,
            • "attachment_id": "17779c20-8c31-4502-8d20-1de4b3028ee4",
            • "internal_filename": "1731055890896-d57cd3f6-a4b3-4a78-ae46-4a54381b48b9.png",
            • "original_filename": "Screenshot 2024-11-06 at 15.43.34.png",
            • "size": 183806,
            • "mime_type": "image/png"

            },
          • "CreatedAt": "2024-11-08T08:51:32",
          • "UploadOn": "2024-11-08",
          • "OriginalFileName": "Screenshot 2024-11-06 at 15.43.34.png",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "7b81f0ae-b402-49f7-982f-58ba868a70b3"

          }

        ]

      }

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "CREATE_PROJECT_VERSION_3edca49d-5d1e-47b8-b40d-b89d726797f4",
• "result": {

  • "docRef": "TaskRequest-dm/484103c3-b70a-42c4-b4d9-2b0e5369cdcb"

  }

}