- URL:
- https://<root>/services/types/customrasterfunctions/find
- Methods:
POST- Version Introduced:
- 11.5
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 find operation searches the raster functions registered to the organization for custom raster functions that exactly match the name provided as input for the rft parameter. This operation is case sensitive, and will only return a match if the casing and spelling of the custom raster function are an exact match. This operation will return an error message if a match cannot be found.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The name of the custom raster function being searched for. |
| The response format. The default format is Values: |
Example usage
The following is a sample POST request for the find operation:
POST /<context>/services/types/customrasterfunctions/find HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
rftName=HeatIndex&f=pjson&token=ZSQdguIKc3G6kJGm2WlvAaBmCO9yvdtebnd9KP5zbP5_dQlCSJ1jejEdlYPn4IborV1gO2_0aqSe-7dy9D7pEDWFphiO22yGMUNPSEvX61vy6VZrBxjZ7pDB8MLkD3U9YYR5rR4TjN1WM6qJubaBHAozC8WaA9nchSMtREnfNet5xfqhyzruScNNYuz37JyJbhjCSq9T7azYgQpiDfCUupTFVN9O-XY66PtEOtlRDpMDq13BSqRRgvg6-kI7uLwQJSON Response examples
The following response is returned when the operation successfully identifies an already registered custom raster function of the same name:
{
"zipFilename": "HeatIndex.zip",
"portalItemId": "ba60574dbf4947859188186f3b69a276",
"rftName": "HeatIndex",
"rftFileName": "HeatIndex.rft.xml",
"id": "ba60574dbf4947859188186f3b69a276",
"revision": 1
}The following response is returned when the operation cannot find an exact match to the provided name:
{
"error" : {
"code" : 500,
"message" : "Failed to find registered custom raster function with id 'heatindex'",
"details" : null
}
}