Risk Time Period Suggest
Suggest risk time periods matching a search term.
Available to: Organization administrators (own organization’s risk time periods)
Environments: Demo, Live
Rate Limit: No endpoint-specific limit
Return the risk time periods you can access that match the search text in t. Use this endpoint to power a type-ahead or search box over risk time periods, rather than retrieving the full list and filtering client-side.
The search ignores case and matches from the start of a word in the risk time period’s name or its organization’s name. By default, the response returns at most 10 risk time periods, even if l is larger. Set l lower to return fewer.
Common Failure Scenarios
- Risk time periods you can’t access are left out of the results. The call doesn’t return an error for them.
- The
tparameter is missing or repeated, or thelparameter is repeated (HTTP 404). Anlvalue that isn’t a whole number in the 32-bit range returnsHTTP 500. - The caller’s user type, or the API key’s permissions, can’t read risk time periods. This returns
HTTP 401with"Access is denied".
Error Messages
Related Endpoints
- Use
riskTimePeriodListto retrieve every risk time period in your organization. - Use
riskTimePeriodFindto look up a risk time period by its fullname(the match ignores case).
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
t
Text
l
Max number of entities
Response
RiskTimePeriod
name
startTime
stopTime
id
organizationId