Rename Workspace Endpoint

Renames an existing workspace.

Availability: Business Analyst Server.

URL Example

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/RenameWorkspace/execute

Parameters

Parameter	Description
WorkspaceName (required)	Workspace name. Type string.
NewWorkspaceName (required)	New workspace name. 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 source workspace is absent or the target workspace already exists, this method has no effect.

Example Usage

The example below renames a workspace of Business Analyst Server Repository. In order to demonstrate this method, a new workspace is created and then renamed.

STEP 1: Create a new workspace

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/CreateWorkspace/execute?
WorkspaceName=workspace_RenameWorkspace&
f=PJSON

STEP 2: Execute the RenameWorkspace request

http://localhost:6080/arcgis/rest/services/DefaultMap/MapServer/exts/BAServer/RenameWorkspace/execute?
WorkspaceName=workspace_RenameWorkspace&
NewWorkspaceName=workspace_renamed_RenameWorkspace&
f=PJSON

Response

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

In attempt to rename a workspace to already existing workspace, the false value is returned:

Response

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