Skip to content

Find

URL:
https://<root>/services/types/customrasterfunctions/find
Methods:
POST
Version Introduced:
11.5

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 rftName 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

ParameterDetails

rftName

(Required)

The name of the custom raster function being searched for.

Use dark colors for code blocksCopy
1
rftName=HeatIndex

f

The response format. The default format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the find operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
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-kI7uLwQ

JSON Response examples

The following response is returned when the operation successfully identifies an already registered custom raster function of the same name:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "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:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "error" : {
    "code" : 500,
    "message" : "Failed to find registered custom raster function with id 'heatindex'",
    "details" : null
  }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.