- URL:
- https://<root>/data/unregisterItem
- Methods:
POST- Version Introduced:
- 10.9
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The unregister operation unregisters a data item that is registered with the server's data store.
Request parameters
| Parameter | Details |
|---|---|
| The item path for the data item. |
| To unregister a data store item, this parameter must be set to Values: |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the unregister operation:
POST /<context>/admin/data/unregisterItem HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
path=folderShare/sharedFolder&f=pjson&token=IYaMF43HohYOwZYZYaTOXDiuR9H4MnIaFk48iJgOxapdyKOsQTlRDrbHUUPKw8MHcJPaSJfxTAF8i0ES8obXfXmq-Ki3vQ9Ox1FHGmQwph7dmAx8wX1e2AhavLh2uSIwiWFo9Nj03YzZD_pe5jaEnjBRaulsAJy-as2xpGurWFYf6yFTiWvcl8K9nx16_IJEtlQdo3V-iJSrQDxiBxZxl7ywNmI8DwSqfz9m0fNwNlmb1ZmT2EVBNkRg7o_Oqx8hJSON Response example
{"status": "success"}