Skip to main content
Version: TMT v5 (latest)

Project

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

Request samples

Content type
application/json
{
  • "id": "RMProjectSubproject-rmRoleProjectSourceUnknown",
  • "jsonrpc": "2.0",
  • "method": "LOAD_PROJECTS_BY_TENANT",
  • "params": { }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "RMProjectSubproject-rmRoleProjectSourceUnknown",
  • "result": {
    }
}

List sub projects Deprecated

DROPPED in 5.0. Use List parent projects instead. Subprojects are now returned in the links array of the LOAD_PROJECTS_BY_TENANT response. The sourceDocRef in each link item is the parent project's document reference.

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

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "LIST_SUB_PROJECTS_2ddc679a-75c5-4981-b7e7-8f9f99c6f73c",
  • "method": "LIST_SUB_PROJECTS",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "LIST_SUB_PROJECTS_2ddc679a-75c5-4981-b7e7-8f9f99c6f73c",
  • "result": [
    ]
}

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

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ProjectWithVersionOperation",
  • "method": "LOAD_PROJECT_WITH_VERSION",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ProjectWithVersionOperation",
  • "result": {
    }
}

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

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "LoadProjectSettingOperation",
  • "method": "LOAD_PROJECT_SETTING",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "LoadProjectSettingOperation",
  • "result": {
    }
}

Get project detail

Get a project document by its document reference using the GET_TMT_DOCUMENT operation.

Authorizations:
bearerAuth
Request Body schema: application/json
required
id
required
string

id of the operation

jsonrpc
required
string

must be 2.0

method
required
string

GET_TMT_DOCUMENT

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "GET_TMT_DOCUMENT-1",
  • "method": "GET_TMT_DOCUMENT",
  • "jsonrpc": "2.0",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "GET_TMT_DOCUMENT-1",
  • "result": {
    }
}

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

Request samples

Content type
application/json
{
  • "id": "update-project-dm-t1",
  • "method": "MODIFY_DOCUMENT",
  • "params": {
    }
}

Response samples

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

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "CREATE_PROJECT_VERSION_3edca49d-5d1e-47b8-b40d-b89d726797f4",
  • "method": "CREATE_PROJECT_VERSION",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "CREATE_PROJECT_VERSION_3edca49d-5d1e-47b8-b40d-b89d726797f4",
  • "result": {
    }
}

Delete project

Only for Tenant Admin role or above. Trigger a task request to delete a project. The task runs in the background. Please refer to Get task request API 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
Array
id
required
string

id of the operation

jsonrpc
required
string

must be 2.0

method
required
string

DELETE_PROJECT

required
object

Responses

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "DELETE_PROJECT_randomId",
  • "method": "DELETE_PROJECT",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "DELETE_PROJECT_randomId",
  • "result": "TaskRequest-dm/b0abc12e-70e7-49fb-8554-40e7b74963cb"
}