Jump to

• Request
• Response

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/code field. Example: E (for admin entity 'serviceType')
• version(required): string
  API version. Example: v1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: object

Show Source

• active(required): boolean
  Indicates if the record is active.
• description(required): string
  Display description for the record.
• id(required): string
  Id of the Insight Type record.
• insightAlgorithmId: string
  Indicates the algorithm for the insight type.
• rank(required): number
  Rank of importance.
• sourceSystem(required): string
  Source system for the insight type.

{
    "type":"object",
    "properties":{
        "sourceSystem":{
            "type":"string",
            "description":"Source system for the insight type."
        },
        "active":{
            "type":"boolean",
            "description":"Indicates if the record is active."
        },
        "description":{
            "type":"string",
            "description":"Display description for the record."
        },
        "rank":{
            "type":"number",
            "description":"Rank of importance."
        },
        "id":{
            "type":"string",
            "description":"Id of the Insight Type record."
        },
        "insightAlgorithmId":{
            "type":"string",
            "description":"Indicates the algorithm for the insight type."
        }
    },
    "required":[
        "id",
        "active",
        "description",
        "rank",
        "sourceSystem"
    ]
}

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

500 Response

An internal server error is encountered, due to an unknown reason.

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application relevant detail, defined in the API or a common\nlist."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\ncan be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "description":"URI of documentation describing the error.",
            "format":"uri"
        }
    }
}

Back to Top