- URL:
- https://<root>/services/types/customrasterfunctions
- Methods:
GET- Operations:
- Register, Find
- Child Resources:
- Custom Raster Function
- Version Introduced:
- 12.2
Access requirements
Required privileges
The Server 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 ArcGIS 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 ArcGIS Server Administrator API generate operation. For security reasons, all POST requests made to the ArcGIS Server Administrator API must include a token in the request body.
Description
The customrasterfunctions resource returns all custom raster functions registered to the server. Raster functions are operations that apply processing directly to the pixels of imagery and raster datasets. In addition to the out-of-the-box raster functions that are provided by Esri, developers can create their own custom raster functions, which can be deployed to their servers for use with raster analysis.
In addition to returning a list of all registered custom raster functions, this resource provides access to the Register and Find operations.
Request parameters
| Parameter | Details |
|---|---|
(Optional) | The response format. The default format is Values: |
Example usage
The following is a sample request URL used to access the customrasterfunctions resource:
https://organization.example.com/<context>/admin/services/types/customrasterfunctions?f=pjsonJSON Response example
{
"customRasterFunctions": [
{
"id": "ba60574dbf4947859188186f3b69a276",
"rftName": "HeatIndex",
"created": 1789679618483,
"updated": 1789679618483,
"revision": 1,
"rftFileName": "HeatIndex.rft.xml",
"uploadItemId": "iba60574d-bf49-4785-9188-186f3b69a276"
},
{
"id": "13ea30931a1a4477bdb8076abbcbb6e9",
"rftName": "FillRaster",
"created": 1789678524186,
"updated": 1789678524186,
"revision": 1,
"rftFileName": "FillRaster.rft.json",
"uploadItemId": "iaad5ca02-f961-45ad-ab04-a321ac4734d0"
}
]
}