FRAMES | NO FRAMES

 

B U S I N E S S   A N A L Y S T   10.0   R E S T   A P I   R E P O S I T O R Y   U T I L I T Y

Delete Project Endpoint

Deletes a project.

 

Availability: Business Analyst Server.

 

URL Example

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/DeleteProject/execute

Parameters

Parameter

Description

WorkspaceName (required)

Workspace name. Type string.

ProjectName (required)

Name of project to delete. Type string.

f (optional)

Response format. Type string. Available formats: HTML, JSON, PJSON, XML.

Default: HTML.

token

Authentication token. This parameter is required if your Business Analyst Server is secured. Type string.

Returns

Variable of type boolean

Remarks

If the project is absent, this endpont returns an error. Additionally, if the "Default Project" is deleted, all of its contents (folder items, etc.) will be deleted and this project will be recreated on the next full reload.

Example Usage

The example below demonstrates the deletion of an existing project in the Business Analyst Server Repository.

 

STEP 1: Create a project to be deleted

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/CreateProject/execute?
WorkspaceName=Default Workspace&
ProjectName=existingProject_DeleteProject&
f=PJSON

 

STEP 2: Execute the DeleteProject request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/DeleteProject/execute?
WorkspaceName=Default Workspace&
ProjectName=existingProject_DeleteProject&
f=PJSON

 

Response

{
  "results":
  [
    {
      "paramName":"OutputStatus",
      "dataType":"GPBoolean",
      "value":true
    }
  ],
  "messages":
  [
  ]
}

 

In attempt to delete a missing project, an error message is returned:

 

Error Response

{
  "error":
  {
    "code":-2147467259,
    "message":"Failed to delete project.",
    "details":
    [
      "Error code: 0x80004005\n...\n"
    ]
  },
  "messages":
  [
  ]
}

 

NOTE: The response has been abbreviated where "..." is noted.

 

See Also

Business Analyst Server REST API Reference