Jump to

• Request
• Response

View the ID for a File or Folder by Path

get

/api/restapi/document/workspace/{workspaceCode}/{type}/search

Send a request to this endpoint to get the ID of a file or folder by it's path from the root folder.

Request

Path Parameters

• type(required): string
  The object name where the file or folder is created.
  Allowed Values: [ "TEMPLATE", "PROJECT", "GENERIC_PORTFOLIO", "IDEA", "PROGRAM", "STRATEGY" ]
• workspaceCode(required): string
  The user-specified identifier of a workspace.

Query Parameters

• path(required): string
  The path of the file or folder from it's root folder.
  The field is non-persistable and thus maximum length is not applicable.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : String

Type: string

Title: String

404 Response

The requested folder or file does not exist, or you do not have access to it.

Back to Top