TeamCity REST API Reference 2024.07 Help

RelatedEntity

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.html]]]</links> <buildType>[[[buildType...|buildtype.html]]]</buildType> <comment>[[[comment...|comment.html]]]</comment> <tags>[[[tags...|tags.html]]]</tags> <pinInfo>[[[comment...|comment.html]]]</pinInfo> <user>[[[user...|user.html]]]</user> <delayedByBuild>[[[build...|build.html]]]</delayedByBuild> <plannedAgent>[[[agent...|agent.html]]]</plannedAgent> <approvalInfo>[[[approvalInfo...|approvalinfo.html]]]</approvalInfo> <running-info>[[[progress-info...|progressinfo.html]]]</running-info> <canceledInfo>[[[comment...|comment.html]]]</canceledInfo> <triggered>[[[TriggeredBy...|triggeredby.html]]]</triggered> <lastChanges>[[[changes...|changes.html]]]</lastChanges> <changes>[[[changes...|changes.html]]]</changes> <revisions>[[[Revisions...|revisions.html]]]</revisions> <versionedSettingsRevision>[[[Revision...|revision.html]]]</versionedSettingsRevision> <artifactDependencyChanges>[[[buildChanges...|buildchanges.html]]]</artifactDependencyChanges> <agent>[[[agent...|agent.html]]]</agent> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages> <testOccurrences>[[[testOccurrences...|testoccurrences.html]]]</testOccurrences> <problemOccurrences>[[[problemOccurrences...|problemoccurrences.html]]]</problemOccurrences> <artifacts>[[[files...|files.html]]]</artifacts> <relatedIssues>[[[issuesUsages...|issuesusages.html]]]</relatedIssues> <properties>[[[properties...|properties.html]]]</properties> <resultingProperties>[[[properties...|properties.html]]]</resultingProperties> <originalProperties>[[[properties...|properties.html]]]</originalProperties> <startProperties>[[[properties...|properties.html]]]</startProperties> <attributes>[[[entries...|entries.html]]]</attributes> <statistics>[[[properties...|properties.html]]]</statistics> <metadata>[[[datas...|datas.html]]]</metadata> <snapshot-dependencies>[[[builds...|builds.html]]]</snapshot-dependencies> <artifact-dependencies>[[[builds...|builds.html]]]</artifact-dependencies> <custom-artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</custom-artifact-dependencies> <replacementIds>[[[items...|items.html]]]</replacementIds> <related>[[[related...|related.html]]]</related> <triggeringOptions>[[[buildTriggeringOptions...|buildtriggeringoptions.html]]]</triggeringOptions> <statusChangeComment>[[[comment...|comment.html]]]</statusChangeComment> <vcsLabels>[[[vcsLabel...|vcslabel.html]]]</vcsLabels> <customization>[[[customizations...|customizations.html]]]</customization> <queuedWaitReasons>[[[properties...|properties.html]]]</queuedWaitReasons> <downloadedArtifacts>[[[downloadedArtifacts...|downloadedartifacts.html]]]</downloadedArtifacts> <matrixConfiguration>[[[MatrixConfiguration...|matrixconfiguration.html]]]</matrixConfiguration> <firstBuildWithSameChanges>[[[build...|build.html]]]</firstBuildWithSameChanges> </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.html]]]</links> <project>[[[project...|project.html]]]</project> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <template>[[[buildType...|buildtype.html]]]</template> <vcs-root-entries>[[[vcs-root-entries...|vcsrootentries.html]]]</vcs-root-entries> <settings>[[[properties...|properties.html]]]</settings> <parameters>[[[properties...|properties.html]]]</parameters> <steps>[[[steps...|steps.html]]]</steps> <features>[[[features...|features.html]]]</features> <triggers>[[[triggers...|triggers.html]]]</triggers> <snapshot-dependencies>[[[snapshot-dependencies...|snapshotdependencies.html]]]</snapshot-dependencies> <artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</artifact-dependencies> <agent-requirements>[[[agent-requirements...|agentrequirements.html]]]</agent-requirements> <branches>[[[branches...|branches.html]]]</branches> <builds>[[[builds...|builds.html]]]</builds> <investigations>[[[investigations...|investigations.html]]]</investigations> <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents> <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> <pauseComment>[[[comment...|comment.html]]]</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.html]]]</links> <parentProject>[[[project...|project.html]]]</parentProject> <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI> <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate> <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes> <templates>[[[buildTypes...|buildtypes.html]]]</templates> <deploymentDashboards>[[[deploymentDashboards...|deploymentdashboards.html]]]</deploymentDashboards> <parameters>[[[properties...|properties.html]]]</parameters> <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots> <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures> <projects>[[[projects...|projects.html]]]</projects> <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles> <ancestorProjects>[[[projects...|projects.html]]]</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.html]]]</properties> <roles>[[[roles...|roles.html]]]</roles> <groups>[[[groups...|groups.html]]]</groups> <avatars>[[[userAvatars...|useravatars.html]]]</avatars> </user> <group description="string" href="string" key="string" name="string"> <parent-groups>[[[groups...|groups.html]]]</parent-groups> <child-groups>[[[groups...|groups.html]]]</child-groups> <users>[[[users...|users.html]]]</users> <roles>[[[roles...|roles.html]]]</roles> <properties>[[[properties...|properties.html]]]</properties> </group> <test href="string" id="string" locator="string" name="string"> <mutes>[[[mutes...|mutes.html]]]</mutes> <investigations>[[[investigations...|investigations.html]]]</investigations> <testOccurrences>[[[testOccurrences...|testoccurrences.html]]]</testOccurrences> <parsedTestName>[[[ParsedTestName...|parsedtestname.html]]]</parsedTestName> </test> <problem description="string" href="string" id="string" identity="string" locator="string" type="string"> <mutes>[[[mutes...|mutes.html]]]</mutes> <investigations>[[[investigations...|investigations.html]]]</investigations> <problemOccurrences>[[[problemOccurrences...|problemoccurrences.html]]]</problemOccurrences> </problem> <agent authorized="true" connected="true" cpuRank="123" currentAgentVersion="string" disconnectionComment="string" enabled="true" host="string" href="string" id="123" idleSinceTime="string" ip="string" javaOutdated="true" lastActivityTime="string" locator="string" name="string" outdated="true" pluginsOutdated="true" port="123" protocol="string" registrationTimestamp="string" typeId="123" uptodate="true" version="string" webUrl="string"> <build>[[[build...|build.html]]]</build> <links>[[[links...|links.html]]]</links> <enabledInfo>[[[enabledInfo...|enabledinfo.html]]]</enabledInfo> <authorizedInfo>[[[authorizedInfo...|authorizedinfo.html]]]</authorizedInfo> <properties>[[[properties...|properties.html]]]</properties> <cloudInstance>[[[cloudInstance...|cloudinstance.html]]]</cloudInstance> <cloudImage>[[[cloudImage...|cloudimage.html]]]</cloudImage> <environment>[[[environment...|environment.html]]]</environment> <pool>[[[agentPool...|agentpool.html]]]</pool> <compatibilityPolicy>[[[compatibilityPolicy...|compatibilitypolicy.html]]]</compatibilityPolicy> <compatibleBuildTypes>[[[buildTypes...|buildtypes.html]]]</compatibleBuildTypes> <incompatibleBuildTypes>[[[compatibilities...|compatibilities.html]]]</incompatibleBuildTypes> <builds>[[[builds...|builds.html]]]</builds> </agent> <vcsRoot href="string" id="string" internalId="string" locator="string" modificationCheckInterval="123" name="string" projectLocator="string" uuid="string" vcsName="string"> <project>[[[project...|project.html]]]</project> <properties>[[[properties...|properties.html]]]</properties> <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances> <repositoryIdStrings>[[[items...|items.html]]]</repositoryIdStrings> </vcsRoot> <change canEditComment="true" comment="string" date="string" href="string" id="123456789" internalVersion="string" locator="string" personal="true" registrationDate="string" storesProjectSettings="true" type="string" username="string" version="string" webUrl="string"> <user>[[[user...|user.html]]]</user> <snapshotDependencyLink>[[[SnapshotDependencyLink...|snapshotdependencylink.html]]]</snapshotDependencyLink> <files>[[[fileChanges...|filechanges.html]]]</files> <vcsRootInstance>[[[vcs-root-instance...|vcsrootinstance.html]]]</vcsRootInstance> <parentChanges>[[[changes...|changes.html]]]</parentChanges> <parentRevisions>[[[items...|items.html]]]</parentRevisions> <attributes>[[[properties...|properties.html]]]</attributes> <status>[[[ChangeStatus...|changestatus.html]]]</status> <commiter>[[[commiter...|commiter.html]]]</commiter> </change> <agentPool href="string" id="123" locator="string" maxAgents="123" name="string"> <ownerProject>[[[project...|project.html]]]</ownerProject> <projects>[[[projects...|projects.html]]]</projects> <agents>[[[agents...|agents.html]]]</agents> <agentTypes>[[[agentTypes...|agenttypes.html]]]</agentTypes> </agentPool> </relatedEntity>
{ "agent" : "[[[agent...|agent.html]]]", "vcsRoot" : "[[[vcs-root...|vcsroot.html]]]", "test" : "[[[test...|test.html]]]", "change" : "[[[change...|change.html]]]", "project" : "[[[project...|project.html]]]", "type" : "type", "unknown" : true, "internalId" : "internalId", "problem" : "[[[problem...|problem.html]]]", "build" : "[[[build...|build.html]]]", "buildType" : "[[[buildType...|buildtype.html]]]", "text" : "text", "agentPool" : "[[[agentPool...|agentpool.html]]]", "user" : "[[[user...|user.html]]]", "group" : "[[[group...|group.html]]]" }
Last modified: 04 July 2024