Get Insight Type
get
/api/utilitiesAdmin/{version}/insightType/{id}
Gets details of a specific Insight Type record by its id field.
Request
Path Parameters
-
id(required): string
Value of resource id field. Example: C1-PER-NONPAY-CARD (for admin entity 'insightType')
-
version(required): string
API version. Example: v1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Success
Nested Schema : insightType
Type:
Show Source
object
-
active(required): boolean
Boolean that is true if active, false if inactive.
-
description(required): string
Display description for the record.
-
id(required): string
Id of the Insight Type record.
-
rank(required): number
Rank of importance.
-
sourceSystem(required): string
Source system for the insight type.
Examples
400 Response
An error is encountered due to an invalid request
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
An internal server error is encountered, due to an unknown reason
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension