Remove Project | ArcGIS REST APIs

URL:: https://<root>/<serviceName>/TopographicProductionServer/workflows/projects/removeProject
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 removeProject operation removes all of the records related to a project from the topographic production server database.

Request parameters

Parameter Details

Parameter	Details
`projectId` (Required)	The ID of the existing project that you want to remove.
`force` (Required)	Enables the `removeProject` operation to delete a project that has any jobs running. A value of `false` means the operation cannot delete a project if it has jobs running. This is the default. A value of `true` cancels all of the project's jobs that are running on the geoprocessing service or in ArcGIS Workflow Manager. 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`

projectId

(Required)

The ID of the existing project that you want to remove.

force

(Required)

Enables the removeProject operation to delete a project that has any jobs running.

A value of false means the operation cannot delete a project if it has jobs running. This is the default.

A value of true cancels all of the project's jobs that are running on the geoprocessing service or in ArcGIS Workflow Manager. 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
{
  "projectId": "<the ID of the project>",
  "success": <true | false>
}

Example usage

Use the removeTaskGroup operation to remove records related to a project from the topographic production server database.

Request URL and parameters:

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

Use dark colors for code blocksCopy
projectId=370201AE-7D79-4337-AFCF-F9811BDB40E3,
force=false,
f=json

JSON Response example

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

Use dark colors for code blocksCopy
{
 "projectId": "370201AE-7D79-4337-AFCF-F9811BDB40E3",
 "success": true
}