Project
Represents a project.
Related Help article: Project
Field | Data type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
|
|
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
|
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.
XML
JSON
<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 count="123">
<link>link...</link>
</links>
<parentProject 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>
</parentProject>
<readOnlyUI inherited="true" value="true"/>
<defaultTemplate 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>
<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>
</defaultTemplate>
<buildTypes count="123" href="string" nextHref="string" prevHref="string">
<buildType>buildType...</buildType>
</buildTypes>
<templates count="123" href="string" nextHref="string" prevHref="string">
<buildType>buildType...</buildType>
</templates>
<deploymentDashboards count="123" href="string" nextHref="string" prevHref="string">
<deploymentDashboard>deploymentDashboard...</deploymentDashboard>
</deploymentDashboards>
<parameters count="123" href="string">
<property>property...</property>
</parameters>
<vcsRoots count="123" href="string" nextHref="string" prevHref="string">
<vcs-root>vcs-root...</vcs-root>
</vcsRoots>
<projectFeatures count="123" href="string">
<projectFeature>projectFeature...</projectFeature>
</projectFeatures>
<projects count="123" href="string" nextHref="string" prevHref="string">
<project>project...</project>
</projects>
<cloudProfiles count="123" href="string" nextHref="string" prevHref="string">
<cloudProfile>cloudProfile...</cloudProfile>
</cloudProfiles>
<ancestorProjects count="123" href="string" nextHref="string" prevHref="string">
<project>project...</project>
</ancestorProjects>
</project>{
"virtual" : true,
"parentProjectName" : "parentProjectName",
"vcsRoots" : {
"count" : 2,
"vcs-root" : [ "vcs-root..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"projects" : {
"count" : 8,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"defaultTemplate" : {
"template" : "buildType...",
"paused" : true,
"description" : "description",
"project" : "project...",
"investigations" : "investigations...",
"templateFlag" : true,
"type" : "regular",
"uuid" : "uuid",
"projectInternalId" : "projectInternalId",
"internalId" : "internalId",
"features" : "features...",
"builds" : "builds...",
"links" : "links...",
"id" : "id",
"href" : "href",
"compatibleCloudImages" : "cloudImages...",
"settings" : "properties...",
"vcsRootInstances" : "vcs-root-instances...",
"templates" : "buildTypes...",
"artifact-dependencies" : "artifact-dependencies...",
"compatibleAgents" : "agents...",
"pauseComment" : "comment...",
"triggers" : "triggers...",
"branches" : "branches...",
"steps" : "steps...",
"externalStatusAllowed" : true,
"agent-requirements" : "agent-requirements...",
"webUrl" : "webUrl",
"inherited" : true,
"snapshot-dependencies" : "snapshot-dependencies...",
"name" : "name",
"vcs-root-entries" : "vcs-root-entries...",
"projectName" : "projectName",
"projectId" : "projectId",
"parameters" : "properties...",
"locator" : "locator"
},
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : {
"count" : 6,
"prevHref" : "prevHref",
"href" : "href",
"cloudProfile" : [ "cloudProfile..." ],
"nextHref" : "nextHref"
},
"internalId" : "internalId",
"archived" : true,
"parentProjectId" : "parentProjectId",
"deploymentDashboards" : {
"count" : 0,
"deploymentDashboard" : [ "deploymentDashboard..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"links" : {
"count" : 4,
"link" : [ "link..." ]
},
"id" : "id",
"href" : "href",
"parentProject" : {
"virtual" : true,
"parentProjectName" : "parentProjectName",
"vcsRoots" : "vcs-roots...",
"projects" : "projects...",
"defaultTemplate" : "buildType...",
"description" : "description",
"uuid" : "uuid",
"parentProjectInternalId" : "parentProjectInternalId",
"cloudProfiles" : "cloudProfiles...",
"internalId" : "internalId",
"archived" : true,
"parentProjectId" : "parentProjectId",
"deploymentDashboards" : "deploymentDashboards...",
"links" : "links...",
"id" : "id",
"href" : "href",
"parentProject" : "project...",
"templates" : "buildTypes...",
"readOnlyUI" : "StateField...",
"webUrl" : "webUrl",
"buildTypes" : "buildTypes...",
"name" : "name",
"ancestorProjects" : "projects...",
"parameters" : "properties...",
"projectFeatures" : "projectFeatures...",
"locator" : "locator"
},
"templates" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"readOnlyUI" : {
"inherited" : true,
"value" : true
},
"webUrl" : "webUrl",
"buildTypes" : {
"buildType" : [ "buildType..." ],
"count" : 3,
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"name" : "name",
"ancestorProjects" : {
"count" : 8,
"project" : [ "project..." ],
"prevHref" : "prevHref",
"href" : "href",
"nextHref" : "nextHref"
},
"parameters" : {
"count" : 1,
"property" : [ {
"inherited" : true,
"name" : "name",
"type" : "type...",
"value" : "value"
} ],
"href" : "href"
},
"projectFeatures" : {
"projectFeature" : [ "projectFeature..." ],
"count" : 1,
"href" : "href"
},
"locator" : "locator"
}Thanks for your feedback!
Was this page helpful?