Investigation

An investigation of a specific build problem (/app/rest/investigations?locator=type:problem), a failed test (/app/rest/investigations?locator=type:test), or an entire build configuration (/app/rest/investigations?locator=type:anyProblem)

Related Help article: Working with Build and Test Failures

Properties

id

The investigation locator.

state

The investigation state. Supported values:

TAKEN — the investigation is assigned to a TeamCity user who works on resolving the problem.
FIXED — the investigation was marked as fixed.
GIVEN_UP — the investigation is no longer active, the 'no investigation' option was selected.
NONE — unknown investigation status.

href

The short (without the TeamCity server address) link to this investigation.

assignee

The TeamCity user assigned to this investigation.

assignment

Stores information about a user who assigned this investigation to the assignee, and the time of this event.

scope

A ProblemScope object that specifies the problem scope: individual build configuration, multiple configurations, or the entire project.

target

Stores the list of build problems and failed tests that are being investigated. If this is a configuration-wide investigation that does not target any specific issue, the ProblemTarget has empty tests and problems properties and its anyProblem returns true.

resolution

Specifies whether or not this investigation is resolved, and the current resolution policy.

responsible

This property is deprecated, use assignee instead.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<investigation href="/app/rest/investigations/assignmentProject:(id:MyProj_InternalTeamBuilds),problem:(id:220)" id="buildType:(id:TeamcityMultibranchRepo_Build)" state="TAKEN">
  <assignee email="string" enabled2FA="false" hasPassword="true" href="/app/rest/users/id:11" id="1" lastLogin="20241001T155514+0200" locator="null" name="John Doe" password="foobar" realm="string" username="johndoe">
    <properties>[[[properties...|properties.html]]]</properties>
    <roles>[[[roleAssignments...|roleassignments.html]]]</roles>
    <groups>[[[groups...|groups.html]]]</groups>
    <avatars>[[[userAvatars...|useravatars.html]]]</avatars>
  </assignee>
  <assignment text="string" timestamp="string">
    <user>[[[user...|user.html]]]</user>
  </assignment>
  <scope>
    <project>[[[project...|project.html]]]</project>
    <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes>
    <buildType>[[[buildType...|buildtype.html]]]</buildType>
  </scope>
  <target anyProblem="true">
    <tests>[[[tests...|tests.html]]]</tests>
    <problems>[[[problems...|problems.html]]]</problems>
  </target>
  <resolution time="string" type="string"/>
  <responsible email="string" enabled2FA="false" hasPassword="true" href="/app/rest/users/id:11" id="1" lastLogin="20241001T155514+0200" locator="null" name="John Doe" password="foobar" realm="string" username="johndoe">
    <properties>[[[properties...|properties.html]]]</properties>
    <roles>[[[roleAssignments...|roleassignments.html]]]</roles>
    <groups>[[[groups...|groups.html]]]</groups>
    <avatars>[[[userAvatars...|useravatars.html]]]</avatars>
  </responsible>
</investigation>

{
  "assignment" : {
    "text" : "text",
    "user" : "[[[user...|user.html]]]",
    "timestamp" : "timestamp"
  },
  "scope" : {
    "buildTypes" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 30,
      "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
      "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
      "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
    },
    "buildType" : {
      "template" : "[[[buildType...|buildtype.html]]]",
      "paused" : false,
      "output-parameters" : "[[[properties...|properties.html]]]",
      "description" : "Deploys artifacts to the public registry",
      "project" : "[[[project...|project.html]]]",
      "investigations" : "[[[investigations...|investigations.html]]]",
      "templateFlag" : false,
      "type" : "regular",
      "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
      "projectInternalId" : "project762",
      "internalId" : "bt1057",
      "features" : "[[[features...|features.html]]]",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : "Deployments_DeployToGlobal",
      "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
      "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
      "settings" : "[[[properties...|properties.html]]]",
      "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
      "compatibleAgents" : "[[[agents...|agents.html]]]",
      "pauseComment" : "[[[comment...|comment.html]]]",
      "triggers" : "[[[triggers...|triggers.html]]]",
      "branches" : "[[[branches...|branches.html]]]",
      "steps" : "[[[steps...|steps.html]]]",
      "externalStatusAllowed" : false,
      "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
      "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
      "inherited" : false,
      "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
      "name" : "Deploy To Global",
      "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
      "projectName" : "Deployments",
      "projectId" : "Deployments",
      "parameters" : "[[[properties...|properties.html]]]",
      "locator" : "locator"
    },
    "project" : {
      "virtual" : false,
      "parentProjectName" : "S3 Buckets Test",
      "vcsRoots" : {
        "count" : 10,
        "vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ],
        "prevHref" : "/app/rest/vcs-roots?locator=count:10,start:90",
        "href" : "/app/rest/vcs-roots?locator=count:10,start:100",
        "nextHref" : "/app/rest/vcs-roots?locator=count:10,start:110"
      },
      "projects" : {
        "count" : 39,
        "project" : [ "[[[project...|project.html]]]" ],
        "prevHref" : "/app/rest/projects?locator=count:10,start:0",
        "href" : "/app/rest/projects?locator=count:30,start:10",
        "nextHref" : "/app/rest/projects?locator=count:30,start:40"
      },
      "defaultTemplate" : {
        "template" : "[[[buildType...|buildtype.html]]]",
        "paused" : false,
        "output-parameters" : "[[[properties...|properties.html]]]",
        "description" : "Deploys artifacts to the public registry",
        "project" : "[[[project...|project.html]]]",
        "investigations" : "[[[investigations...|investigations.html]]]",
        "templateFlag" : false,
        "type" : "regular",
        "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
        "projectInternalId" : "project762",
        "internalId" : "bt1057",
        "features" : "[[[features...|features.html]]]",
        "builds" : "[[[builds...|builds.html]]]",
        "links" : "[[[links...|links.html]]]",
        "id" : "Deployments_DeployToGlobal",
        "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
        "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
        "settings" : "[[[properties...|properties.html]]]",
        "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
        "templates" : "[[[buildTypes...|buildtypes.html]]]",
        "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
        "compatibleAgents" : "[[[agents...|agents.html]]]",
        "pauseComment" : "[[[comment...|comment.html]]]",
        "triggers" : "[[[triggers...|triggers.html]]]",
        "branches" : "[[[branches...|branches.html]]]",
        "steps" : "[[[steps...|steps.html]]]",
        "externalStatusAllowed" : false,
        "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
        "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
        "inherited" : false,
        "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
        "name" : "Deploy To Global",
        "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
        "projectName" : "Deployments",
        "projectId" : "Deployments",
        "parameters" : "[[[properties...|properties.html]]]",
        "locator" : "locator"
      },
      "description" : "This subproject contains configurations that carry out delivery jobs",
      "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
      "parentProjectInternalId" : "project82",
      "cloudProfiles" : {
        "count" : 4,
        "prevHref" : "/app/rest/cloud/profiles?locator=count:50,start:0",
        "href" : "/app/rest/cloud/profiles",
        "cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ],
        "nextHref" : "/app/rest/cloud/profiles?locator=count:200,start:250"
      },
      "internalId" : "project302",
      "archived" : false,
      "parentProjectId" : "S3BucketsTest",
      "deploymentDashboards" : {
        "count" : 7,
        "deploymentDashboard" : [ "[[[deploymentDashboard...|deploymentdashboard.html]]]" ],
        "prevHref" : "prevHref",
        "href" : "href",
        "nextHref" : "nextHref"
      },
      "links" : {
        "link" : [ "[[[link...|link.html]]]" ],
        "count" : 4
      },
      "id" : "BuildCacheNodeJS",
      "href" : "/app/rest/projects/id:BuildCacheNodeJS",
      "parentProject" : {
        "virtual" : false,
        "parentProjectName" : "S3 Buckets Test",
        "vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]",
        "projects" : "[[[projects...|projects.html]]]",
        "defaultTemplate" : "[[[buildType...|buildtype.html]]]",
        "description" : "This subproject contains configurations that carry out delivery jobs",
        "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
        "parentProjectInternalId" : "project82",
        "cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]",
        "internalId" : "project302",
        "archived" : false,
        "parentProjectId" : "S3BucketsTest",
        "deploymentDashboards" : "[[[deploymentDashboards...|deploymentdashboards.html]]]",
        "links" : "[[[links...|links.html]]]",
        "id" : "BuildCacheNodeJS",
        "href" : "/app/rest/projects/id:BuildCacheNodeJS",
        "parentProject" : "[[[project...|project.html]]]",
        "templates" : "[[[buildTypes...|buildtypes.html]]]",
        "readOnlyUI" : "[[[StateField...|statefield.html]]]",
        "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
        "buildTypes" : "[[[buildTypes...|buildtypes.html]]]",
        "name" : "Build Cache — NodeJS",
        "ancestorProjects" : "[[[projects...|projects.html]]]",
        "parameters" : "[[[properties...|properties.html]]]",
        "projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]",
        "locator" : "locator"
      },
      "templates" : {
        "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
        "count" : 30,
        "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
        "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
        "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
      },
      "readOnlyUI" : {
        "inherited" : true,
        "value" : true
      },
      "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
      "buildTypes" : {
        "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
        "count" : 30,
        "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
        "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
        "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
      },
      "name" : "Build Cache — NodeJS",
      "ancestorProjects" : {
        "count" : 39,
        "project" : [ "[[[project...|project.html]]]" ],
        "prevHref" : "/app/rest/projects?locator=count:10,start:0",
        "href" : "/app/rest/projects?locator=count:30,start:10",
        "nextHref" : "/app/rest/projects?locator=count:30,start:40"
      },
      "parameters" : {
        "count" : 1,
        "property" : [ {
          "inherited" : true,
          "name" : "name",
          "type" : "[[[type...|type.html]]]",
          "value" : "value"
        } ],
        "href" : "href"
      },
      "projectFeatures" : {
        "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
        "count" : 9,
        "href" : "href"
      },
      "locator" : "locator"
    }
  },
  "responsible" : {
    "lastLogin" : "20241001T155514+0200",
    "roles" : {
      "role" : [ "[[[roleAssignment...|roleassignment.html]]]" ]
    },
    "groups" : {
      "count" : 2,
      "group" : [ "[[[group...|group.html]]]" ]
    },
    "hasPassword" : true,
    "password" : "foobar",
    "enabled2FA" : false,
    "name" : "John Doe",
    "realm" : "realm",
    "id" : 1,
    "href" : "/app/rest/users/id:11",
    "locator" : "null",
    "email" : "email",
    "properties" : {
      "count" : 1,
      "property" : [ {
        "inherited" : true,
        "name" : "name",
        "type" : "[[[type...|type.html]]]",
        "value" : "value"
      } ],
      "href" : "href"
    },
    "username" : "johndoe",
    "avatars" : {
      "urlToSize80" : "/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize28" : "/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize40" : "/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize32" : "/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize20" : "/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize64" : "/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize56" : "/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png"
    }
  },
  "id" : "buildType:(id:TeamcityMultibranchRepo_Build)",
  "state" : "TAKEN",
  "href" : "/app/rest/investigations/assignmentProject:(id:MyProj_InternalTeamBuilds),problem:(id:220)",
  "assignee" : {
    "lastLogin" : "20241001T155514+0200",
    "roles" : {
      "role" : [ "[[[roleAssignment...|roleassignment.html]]]" ]
    },
    "groups" : {
      "count" : 2,
      "group" : [ "[[[group...|group.html]]]" ]
    },
    "hasPassword" : true,
    "password" : "foobar",
    "enabled2FA" : false,
    "name" : "John Doe",
    "realm" : "realm",
    "id" : 1,
    "href" : "/app/rest/users/id:11",
    "locator" : "null",
    "email" : "email",
    "properties" : {
      "count" : 1,
      "property" : [ {
        "inherited" : true,
        "name" : "name",
        "type" : "[[[type...|type.html]]]",
        "value" : "value"
      } ],
      "href" : "href"
    },
    "username" : "johndoe",
    "avatars" : {
      "urlToSize80" : "/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize28" : "/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize40" : "/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize32" : "/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize20" : "/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize64" : "/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png",
      "urlToSize56" : "/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png"
    }
  },
  "resolution" : {
    "time" : "time",
    "type" : "manually"
  },
  "target" : {
    "tests" : {
      "test" : [ {
        "testOccurrences" : "[[[testOccurrences...|testoccurrences.html]]]",
        "name" : "name",
        "investigations" : "[[[investigations...|investigations.html]]]",
        "parsedTestName" : "[[[ParsedTestName...|parsedtestname.html]]]",
        "id" : "id",
        "href" : "href",
        "mutes" : "[[[mutes...|mutes.html]]]",
        "locator" : "locator"
      } ],
      "count" : 0,
      "myTestCounters" : {
        "all" : 4,
        "duration" : 8,
        "ignored" : 9,
        "newFailed" : 6,
        "success" : 5,
        "failed" : 0,
        "muted" : 7
      },
      "prevHref" : "prevHref",
      "nextHref" : "nextHref"
    },
    "anyProblem" : true,
    "problems" : {
      "problem" : [ {
        "problemOccurrences" : "[[[problemOccurrences...|problemoccurrences.html]]]",
        "identity" : "identity",
        "description" : "description",
        "investigations" : "[[[investigations...|investigations.html]]]",
        "id" : "id",
        "href" : "href",
        "type" : "type",
        "mutes" : "[[[mutes...|mutes.html]]]",
        "locator" : "locator"
      } ],
      "count" : 4,
      "prevHref" : "prevHref",
      "nextHref" : "nextHref"
    }
  }
}

Last modified: 02 December 2025