Skip to navigation

Risk Time Period Items

View as Markdown

Retrieve several risk time periods by ID.

Available to: Organization administrators (own organization’s risk time periods)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve multiple riskTimePeriodIds to their risk time period records in a single call. Prefer this over repeated riskTimePeriodItem calls when you need to resolve several IDs at once.

Common Failure Scenarios

  • An ID in ids that doesn’t match a risk time period, or matches one you can’t access, is left out of the response array. The call still succeeds, so compare the returned records against the IDs you requested.
  • The ids parameter is missing or repeated (HTTP 404), or contains a value that isn’t a number (HTTP 500).
  • The caller’s user type, or the API key’s permissions, can’t read risk time periods. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read risk time periods.
(no message text)404The ids parameter is missing or repeated.
"Internal Server Error, error id: {id}"500A value in ids isn’t a number. The error ID is generated per request.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

idslist of longsRequired

Response

RiskTimePeriod
namestring<=64 characters
startTimeobject
stopTimeobject
idlongOptional
organizationIdlongOptional