SnapshotDependency

A snapshot dependency that specifies the relation between the current (dependent) downstream configuration of a build chain, and an upstream configuration on which the current configuration depends.

Related Help article: Snapshot Dependencies

Properties

id

The internal read-only ID of the object. This property is inherited from the base PropEntity class.

name

The public object name. Some objects, like build steps, support public names, while others, like build triggers, do not. This property is inherited from the base PropEntity class.

type

The object type. This property is inherited from the base PropEntity class.

disabled

Returns rue if the object is disabled and inactive; otherwise, false. This property is inherited from the base PropEntity class.

inherited

Returns rue if the object is inherited from another object; otherwise, false. This property is inherited from the base PropEntity class.

href

Returns the shortened (without the server URL) link to the current object. This property is inherited from the base PropEntity class.

properties

The list of main object settings. Each setting is a Property instance with name and value fields. This property is inherited from the base PropEntity class.

source-buildType

The upstream configuration of a build chain that must finish its build before the current downstream configuration can run.

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.

<snapshot-dependency disabled="false" href="string" id="TRIGGER_71" inherited="false" name="Py: Merge reports" type="simpleRunner, commit-status-publisher, vcsTrigger">
  <properties count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </properties>
  <source-buildType description="Deploys artifacts to the public registry" externalStatusAllowed="false" href="/app/rest/buildTypes/id:Deployments_DeployToGlobal" id="Deployments_DeployToGlobal" inherited="false" internalId="bt1057" locator="string" name="Deploy To Global" paused="false" projectId="Deployments" projectInternalId="project762" projectName="Deployments" templateFlag="false" type="regular" uuid="8e7eafb8-321b-456e-84db-e73714c8fa3f" webUrl="https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds">
    <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>
    <output-parameters>[[[properties...|properties.html]]]</output-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>
  </source-buildType>
</snapshot-dependency>

{
  "source-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"
  },
  "inherited" : false,
  "name" : "Py: Merge reports",
  "disabled" : false,
  "id" : "TRIGGER_71",
  "href" : "href",
  "type" : "simpleRunner, commit-status-publisher, vcsTrigger",
  "properties" : {
    "count" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  }
}

Last modified: 02 December 2025