TeamCity REST API Reference
 
2025.03
  1. Autogenerated REST API Reference
  2. Models
  3. Other
  4. RelatedEntity

RelatedEntity

Last modified: 14 March 2025

Represents a related entity.

Properties

Field

Data type

type

string

unknown

boolean

internalId

string

text

string

build

Build

buildType

BuildType

project

Project

user

User

group

Group

test

Test

problem

Problem

agent

Agent

vcsRoot

VcsRoot

change

Change

agentPool

AgentPool

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.

<relatedEntity internalId="string" text="string" type="string" unknown="true">
  <build artifactsDirectory="/Users/John.Doe/.BuildServer/system/artifacts/ProjectName/ConfigName/1337" branchName="sandbox" buildTypeId="ProjectName_BuildConfName" buildTypeInternalId="string" chainModificationId="string" changesCollectingInProgress="false" composite="false" currentSettingsHash="string" customized="true" defaultBranch="true" detachedFromAgent="false" failedToStart="true" finishDate="20240408T162702+0200" finishEstimate="20240409T160130+0200" finishOnAgentDate="20240408T162702+0200" history="true" href="/app/rest/builds/id:8006" id="8134" limitedChangesCount="3" locator="string" modificationId="string" number="54" percentageComplete="123" personal="true" pinned="true" queuePosition="2" queuedDate="20240408T162059+0200" running="true" settingsHash="string" startDate="20240408T162559+0200" startEstimate="20240409T155123+0200" state="queued" status="SUCCESS" statusText="Tests passed: 5, muted: 1" taskId="123456789" unspecifiedBranch="false" usedByOtherBuilds="true" waitReason="There are no idle compatible agents which can run this build" webUrl="https://example.com/app/rest/builds/id:8006">
    <links>links...</links>
    <buildType>buildType...</buildType>
    <comment>comment...</comment>
    <tags>tags...</tags>
    <pinInfo>comment...</pinInfo>
    <user>user...</user>
    <delayedByBuild>build...</delayedByBuild>
    <plannedAgent>agent...</plannedAgent>
    <approvalInfo>approvalInfo...</approvalInfo>
    <running-info>progress-info...</running-info>
    <canceledInfo>comment...</canceledInfo>
    <triggered>TriggeredBy...</triggered>
    <lastChanges>changes...</lastChanges>
    <changes>changes...</changes>
    <revisions>Revisions...</revisions>
    <versionedSettingsRevision>Revision...</versionedSettingsRevision>
    <artifactDependencyChanges>buildChanges...</artifactDependencyChanges>
    <agent>agent...</agent>
    <compatibleAgents>agents...</compatibleAgents>
    <compatibleCloudImages>cloudImages...</compatibleCloudImages>
    <testOccurrences>testOccurrences...</testOccurrences>
    <problemOccurrences>problemOccurrences...</problemOccurrences>
    <artifacts>files...</artifacts>
    <relatedIssues>issuesUsages...</relatedIssues>
    <properties>properties...</properties>
    <resultingProperties>properties...</resultingProperties>
    <originalProperties>properties...</originalProperties>
    <startProperties>properties...</startProperties>
    <attributes>entries...</attributes>
    <statistics>properties...</statistics>
    <metadata>datas...</metadata>
    <snapshot-dependencies>builds...</snapshot-dependencies>
    <artifact-dependencies>builds...</artifact-dependencies>
    <custom-artifact-dependencies>artifact-dependencies...</custom-artifact-dependencies>
    <replacementIds>items...</replacementIds>
    <related>related...</related>
    <triggeringOptions>buildTriggeringOptions...</triggeringOptions>
    <statusChangeComment>comment...</statusChangeComment>
    <vcsLabels>vcsLabel...</vcsLabels>
    <customization>customizations...</customization>
    <queuedWaitReasons>properties...</queuedWaitReasons>
    <downloadedArtifacts>downloadedArtifacts...</downloadedArtifacts>
    <matrixConfiguration>MatrixConfiguration...</matrixConfiguration>
    <firstBuildWithSameChanges>build...</firstBuildWithSameChanges>
    <executor>BuildExecutor...</executor>
  </build>
  <buildType description="string" externalStatusAllowed="true" href="string" id="string" inherited="true" internalId="string" locator="string" name="string" paused="true" projectId="string" projectInternalId="string" projectName="string" templateFlag="true" type="string" uuid="string" webUrl="string">
    <links>links...</links>
    <project>project...</project>
    <templates>buildTypes...</templates>
    <template>buildType...</template>
    <vcs-root-entries>vcs-root-entries...</vcs-root-entries>
    <settings>properties...</settings>
    <parameters>properties...</parameters>
    <output-parameters>properties...</output-parameters>
    <steps>steps...</steps>
    <features>features...</features>
    <triggers>triggers...</triggers>
    <snapshot-dependencies>snapshot-dependencies...</snapshot-dependencies>
    <artifact-dependencies>artifact-dependencies...</artifact-dependencies>
    <agent-requirements>agent-requirements...</agent-requirements>
    <branches>branches...</branches>
    <builds>builds...</builds>
    <investigations>investigations...</investigations>
    <compatibleAgents>agents...</compatibleAgents>
    <compatibleCloudImages>cloudImages...</compatibleCloudImages>
    <vcsRootInstances>vcs-root-instances...</vcsRootInstances>
    <pauseComment>comment...</pauseComment>
  </buildType>
  <project archived="true" description="string" href="string" id="string" internalId="string" locator="string" name="string" parentProjectId="string" parentProjectInternalId="string" parentProjectName="string" uuid="string" virtual="true" webUrl="string">
    <links>links...</links>
    <parentProject>project...</parentProject>
    <readOnlyUI>StateField...</readOnlyUI>
    <defaultTemplate>buildType...</defaultTemplate>
    <buildTypes>buildTypes...</buildTypes>
    <templates>buildTypes...</templates>
    <deploymentDashboards>deploymentDashboards...</deploymentDashboards>
    <parameters>properties...</parameters>
    <vcsRoots>vcs-roots...</vcsRoots>
    <projectFeatures>projectFeatures...</projectFeatures>
    <projects>projects...</projects>
    <cloudProfiles>cloudProfiles...</cloudProfiles>
    <ancestorProjects>projects...</ancestorProjects>
  </project>
  <user email="string" enabled2FA="true" hasPassword="true" href="string" id="123456789" lastLogin="string" locator="string" name="string" password="string" realm="string" username="string">
    <properties>properties...</properties>
    <roles>roles...</roles>
    <groups>groups...</groups>
    <avatars>userAvatars...</avatars>
  </user>
  <group description="string" href="string" key="string" name="string">
    <parent-groups>groups...</parent-groups>
    <child-groups>groups...</child-groups>
    <users>users...</users>
    <roles>roles...</roles>
    <properties>properties...</properties>
  </group>
  <test href="string" id="string" locator="string" name="string">
    <mutes>mutes...</mutes>
    <investigations>investigations...</investigations>
    <testOccurrences>testOccurrences...</testOccurrences>
    <parsedTestName>ParsedTestName...</parsedTestName>
  </test>
  <problem description="string" href="string" id="string" identity="string" locator="string" type="string">
    <mutes>mutes...</mutes>
    <investigations>investigations...</investigations>
    <problemOccurrences>problemOccurrences...</problemOccurrences>
  </problem>
  <agent authorized="true" connected="true" cpuRank="396" currentAgentVersion="160569" disconnectionComment="Unregistered because of inactivity" enabled="true" host="ip-52-211-39-10.eu-west-1.compute.internal, localhost" href="/app/rest/agents/id:771" id="771" idleSinceTime="20240816T150655+0200" ip="52.211.39.100" javaOutdated="false" lastActivityTime="20240816T151123+0200" locator="string" name="Ubuntu-22.04-Large-i-045902939eae4af1a" outdated="true" pluginsOutdated="false" port="9090" protocol="string" registrationTimestamp="20240816T150655+0200" typeId="661" uptodate="false" version="156364" webUrl="https://example.com/agentDetails.html?id=771&amp;agentTypeId=11389&amp;realAgentName=db-win-2003">
    <build>build...</build>
    <links>links...</links>
    <enabledInfo>enabledInfo...</enabledInfo>
    <authorizedInfo>authorizedInfo...</authorizedInfo>
    <properties>properties...</properties>
    <cloudInstance>cloudInstance...</cloudInstance>
    <cloudImage>cloudImage...</cloudImage>
    <environment>environment...</environment>
    <pool>agentPool...</pool>
    <compatibilityPolicy>compatibilityPolicy...</compatibilityPolicy>
    <compatibleBuildTypes>buildTypes...</compatibleBuildTypes>
    <incompatibleBuildTypes>compatibilities...</incompatibleBuildTypes>
    <builds>builds...</builds>
  </agent>
  <vcsRoot href="string" id="string" internalId="string" locator="string" modificationCheckInterval="123" name="string" projectLocator="string" uuid="string" vcsName="string">
    <project>project...</project>
    <properties>properties...</properties>
    <vcsRootInstances>vcs-root-instances...</vcsRootInstances>
    <repositoryIdStrings>items...</repositoryIdStrings>
  </vcsRoot>
  <change canEditComment="true" comment="string" date="20240905T151059+0200" href="/app/rest/changes/id:704,personal:true" id="1190" internalVersion="c1046c4fa016a774253fb3b93e6cc8bd12c159e5" locator="null" personal="true" registrationDate="20240905T151115+0200" storesProjectSettings="true" type="VCS_CHANGE" username="string" version="c1046c4fa016a774253fb3b93e6cc8bd12c159e5, 05 09 2024 17:23" webUrl="string">
    <user>user...</user>
    <snapshotDependencyLink>SnapshotDependencyLink...</snapshotDependencyLink>
    <files>fileChanges...</files>
    <vcsRootInstance>vcs-root-instance...</vcsRootInstance>
    <parentChanges>changes...</parentChanges>
    <parentRevisions>items...</parentRevisions>
    <attributes>properties...</attributes>
    <status>ChangeStatus...</status>
    <commiter>commiter...</commiter>
  </change>
  <agentPool href="/app/rest/agentPools/id:82" id="31" locator="string" maxAgents="10" name="Kubernetes">
    <ownerProject>project...</ownerProject>
    <projects>projects...</projects>
    <agents>agents...</agents>
    <agentTypes>agentTypes...</agentTypes>
  </agentPool>
</relatedEntity>