PermissionAssignments

Represents a list of PermissionAssignment entities.

Properties

count

The current number of PermissionAssignment objects in this collection.

permissionAssignment

The list of PermissionAssignment objects in this collection.

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.

<permissionAssignments count="12">
  <permissionAssignment>[[[permissionAssignment...|permissionassignment.html]]]</permissionAssignment>
</permissionAssignments>

{
  "permissionAssignment" : [ {
    "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"
    },
    "permission" : {
      "name" : "Configure server data cleanup",
      "global" : true,
      "id" : "run_build, view_project, manage_build_problems"
    },
    "isGlobalScope" : true
  } ],
  "count" : 12
}

Last modified: 02 December 2025