- URL:
- https://<root>/data/items/bigDataFileShares/<dataItem>/hints/update
- Methods:
POST- Version Introduced:
- 10.5
Access requirements
Required privileges
The Sever 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.
Note that administrators assigned a custom role must also have the administrative View all content privilege assigned to them to access the API directory as an administrator.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Server 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 Portal Directory API. For security reasons, all POST requests made to the Server Administrator API must include a token in the request body.
Description
The update operation uploads a hints file for a big data file share item, which will replace the existing hints file. To apply the control parameters in the hints file and regenerate the manifest, use the Edit Data Item operation to edit the big data file share (using the same data store item as input) which will regenerate the manifest. When a manifest is regenerated, it will be updated only for datasets that have hints and for new datasets that are added to the existing big data file share location.
Request parameters
| Parameter | Details |
|---|---|
| The hints file to be uploaded. |
| The response format. The default response format is Values: |
JSON Response example
{"status": "success"}