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 Workspace Endpoint

Deletes a workspace.

 

Availability: Business Analyst Server.

 

URL Example

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

Parameters

Parameter

Description

WorkspaceName (required)

Name of workspace 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 workspace to delete is absent, this method has no effect. If the "Default Workspace" is deleted, all of its contents will be deleted and the workspace will be recreated on the next full reload.

Example Usage

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

 

STEP 1: Create a workspace to be deleted

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/CreateWorkspace/execute?
WorkspaceName=existingWorkspace_DeleteWorkspace&
f=PJSON

 

STEP 2: Execute the DeleteWorkspace request

http://localhost/ArcGIS/baserver/REST/services/DefaultMap/BAServer/DeleteWorkspace/execute?
WorkspaceName=existingWorkspace_DeleteWorkspace&
f=PJSON

 

Response

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

 

In attempt to delete a missing workspace, the false value is returned:

 

Response

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

 

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

 

See Also

Business Analyst Server REST API Reference