Update Project | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/projects/updateProject
Methods:: GETPOST
Required Capability:: Requires a Professional or Professional Plus user type account and a Topographic Mapping server extension license.
Version Introduced:: 12.0

Description

The updateProject operation updates the properties of a project.

Request parameters

Parameter	Details
`projectId` (Required)	The ID associated with the project to update.
`project` (Required)	The JSON object that defines the properties of a project including phases. Syntax: Use dark colors for code blocksCopy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { name: “<String name of the project>”, description: “<String description of the project>”, startDate: “<Project starting UTC date in ISO 8601 format>”, endDate: “<Project ending UTC date in ISO 8601 format>”, phases: [ { updateType: "<create \| modify \| delete>", phaseId: "<String ID of the phase to update>", name: “<String name of phase>”, description: “<String description of phase>”, startDate: “<Phase starting UTC date in ISO 8601 format>”, endDate: “<Phase ending UTC date in ISO 8601 format>”, taskGroupIds: [ <taskgroupId>, ... ] }, … ] } Example: Use dark colors for code blocksCopy 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 { name: "Project CA", description: "Mapping California", startDate: "2018-01-01T00:00:00", endDate: "2018-12-12T00:00:00", phases: [ { updateType: "modify", phaseId: "6BDFB0E4-2B21-40D0-B7E4-18328863B88F", name: "A", description: "Northern California", startDate: "2018-01-01T00:00:00", endDate: "2018-12-12T00:00:00" }, { updateType: "modify", phaseId: "2C443857-E035-4994-A644-F12537BE00C8", name: "B", description: "Central California", startDate: "2018-01-10T00:00:00", endDate: "2018-12-12T00:00:00" }, { updateType: "modify", phaseId: "9E3A032F-6733-472B-8836-4922FC8D5F06", name: "C", description: "Southern California", startDate: "2018-01-20T00:00:00", endDate: "2018-12-12T00:00:00", taskGroupIds: [ "5F109F09-DF73-4A82-A5B9-0FAACF8206F5" ] } ] }
`force` (Required)	Enables the `updateProject` operation to delete a phase or unlink a task group when updating a project that has any jobs running. A value of `false` means the operation cannot perform those updates to a project if it has jobs running. This is the default. A value of `true` updates all of the project's jobs that are running on the geoprocessing service or in ArcGIS Workflow Manager. If the updates resulted in canceled jobs, related entries in the TM Server database will be removed. Values: `true` \| `false`
`f` (Required)	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

JSON Response syntax

The following is the syntax of a response:

Use dark colors for code blocksCopy
{
 "project": "<Name of the project>",
 "success": <true | false>
}

Example usage

Update the properties of a project on the topographic production server using the updateProject operation.

Request URL and parameters:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/<SampleService>/TopographicProductionServer/workflows/projects/updateProject

Use dark colors for code blocksCopy
projectId=61EAB79B-6FC0-433A-9954-FDD619D0CCEE
project={
  name: "Weapon X",
  description: "Confidential",
  startDate: "1882-01-01T00:00:00Z",
  endDate: "2023-01-01T00:00:00Z",
  phases: [
    {
      updateType: "modify",
      phaseId: "6BDFB0E4-2B21-40D0-B7E4-18328863B88F",
      name: "James Howlett",
      description: "Discovery phase",
      startDate: "1882-01-01T00:00:00Z",
      endDate: "1900-01-01T00:00:00Z"
    },
    {
      updateType: "modify",
      phaseId: "2C443857-E035-4994-A644-F12537BE00C8",
      name: "Logan",
      description: "Development",
      startDate: "1900-01-01T00:00:00Z",
      endDate: "1941-01-01T00:00:00Z"
    },
    {
      updateType: "modify",
      phaseId: "9E3A032F-6733-472B-8836-4922FC8D5F06",
      name: "Wolverine",
      description: "Fruition",
      startDate: "1941-01-01T00:00:00Z",
      endDate: "2023-01-01T00:00:00Z"
    }
  ]
  },
force=false,
f=json

JSON Response example

The following is an example of a successful response to update a project that did not have any jobs running:

Use dark colors for code blocksCopy
{
 "project": "Weapon X",
 "success": true
}