{
"opencollection": "1.0.0",
"info": {
"name": "qTest Manager API Version 3.0 Field API",
"version": "v3.0"
},
"items": [
{
"info": {
"name": "field",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets all site field of an object type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "By default the first page is returned but you can specify any page number to retrieve objects"
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To get all fields (at site level) for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Creates a Custom Site Field of an Object Type",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To create a new Site Field for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Gets a Custom Site Field of an Object Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To get a custom field (at site level) for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Updates a Custom Site Field of an Object Type",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To update a custom field (at site level) for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Deletes a Custom Site Field of an Object Type",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To delete a custom field (at site level) for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Gets all allowed values of a Site Field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId/allowed-values",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "By default the first page is returned but you can specify any page number to retrieve objects"
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To get all allowed values of a Site Field with Combo box/Multi selection combo box/Check box/User list data type"
},
{
"info": {
"name": "Creates allowed values of a Site Field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId/allowed-values",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Creates maximum 100 allowed values of a Site Field with Combo box/Multi selection combo box/Check box data type"
},
{
"info": {
"name": "Updates an allowed value of a Site Field",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId/allowed-values/:value",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "value",
"value": "",
"type": "path",
"description": "ID (property \"value\") of allowed value"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Update allowed values of a Site Field with Combo box/Multi selection combo box/Check box data type"
},
{
"info": {
"name": "Deletes an allowed value of a Site Field",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://apitryout.qtestnet.com/api/v3/fields/:objectType/:fieldId/allowed-values/:value",
"params": [
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "value",
"value": "",
"type": "path",
"description": "ID (property \"value\") of allowed value"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To delete an allowed value of a Site Field with Combo box/Multi selection combo box/Check box data type"
},
{
"info": {
"name": "Gets all Fields of an Object Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "includeInactive",
"value": "",
"type": "query",
"description": "By default inactive Fields are excluded from the response. Specify includeInactive=true to include inactive fields"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To retrieve Fields of an Object Type\n\nqTest Manager version: 4+"
},
{
"info": {
"name": "Creates a Custom Field of an Object Type",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To create a new custom Field for Release, Build, Requirement, Test Case, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Gets a Custom Field of an Object Type",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To get a custom field (at project level) for Release, Build, Requirement, Test Case, Test Step, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Updates a Custom Field of an Object Type",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To update a custom field (at project level) for Release, Build, Requirement, Test Case, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Deletes a Custom Field of an Object Type",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the custom field"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To delete a custom field (at project level) for Release, Build, Requirement, Test Case, Test Suite, Test Run, or Defect"
},
{
"info": {
"name": "Gets all allowed values of a Project Field",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId/allowed-values",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, test-steps, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "page",
"value": "",
"type": "query",
"description": "By default the first page is returned but you can specify any page number to retrieve objects"
},
{
"name": "pageSize",
"value": "",
"type": "query",
"description": "The result is paginated. By the default, the number of objects in each page is 100 if this is omitted. You can specify your custom number (up to 999) in this parameter"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To get all allowed values of a Project Field with Combo box/Multi selection combo box/Check box/User list data type"
},
{
"info": {
"name": "Creates allowed values of a Project Field",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId/allowed-values",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Creates maximum 100 allowed values of a Project Field with Combo box/Multi selection combo box/Check box data type"
},
{
"info": {
"name": "Updates an allowed value of a Project Field",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId/allowed-values/:value",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "value",
"value": "",
"type": "path",
"description": "ID (property \"value\") of allowed value"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "Update allowed values of a Project Field with Combo box/Multi selection combo box/Check box data type"
},
{
"info": {
"name": "Deletes an allowed value of a Project Field",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://apitryout.qtestnet.com/api/v3/projects/:projectId/settings/:objectType/fields/:fieldId/allowed-values/:value",
"params": [
{
"name": "projectId",
"value": "",
"type": "path",
"description": "ID of the project"
},
{
"name": "objectType",
"value": "",
"type": "path",
"description": "Valid values include releases, builds, requirements, test-cases, defects, test-suites and test-runs"
},
{
"name": "fieldId",
"value": "",
"type": "path",
"description": "ID of the field"
},
{
"name": "value",
"value": "",
"type": "path",
"description": "ID (property \"value\") of allowed value"
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "To delete an allowed value of a Field (at project level) with Combo box/Multi selection combo box/Check box data type"
}
]
}
],
"bundled": true
}