Jump to

• Request
• Response

Get all Insight Group Insight Types

get

/api/utilitiesAdmin/{version}/insightGroupInsightTypes

Gets a list of Insight Group Insight Types records.

Request

Path Parameters

• version(required): string
  API version. Example: v1

Query Parameters

• expand: string
  This query parameter can be specified to retrieve an expanded version of a particular subresource. Example: ?expand=state where state is a sub resource
• fields: string
  This query parameter can be specified as comma-separated list of fields, and it returns only the specified fields for the resource. Example: ?fields=description,icon
• limit: number
  By specifying this query parameter, the number of items returned will be limited to this number. Example: ?limit=10
• offset: number
  By specifying this query parameter, a subset of records starting with this offset value will be retrieved. Example: ?offset=2
• orderBy: string
  This query parameter determines the sort order of results by a field. Example: description:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expression. The value of this query parameter is an expression(Format: ?q=expression). Supported comparison operators are: '=' , '!='. Example1: ?q=description=Electric , Example2: ?q=description!=Electric
• totalResults: boolean
  This query parameter can be specified, to return the total number of items available. Example: ?totalResults=true

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Match One Schema

Show Source

• object insightGroupInsightTypesItems

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/insightGroupInsightTypesItems"
        }
    ]
}

Nested Schema : insightGroupInsightTypesItems

Type: object

Show Source

• count: number
  The number of records returned in the current range.
• hasMore: boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server.
• items: array items
• limit: number
  The actual paging size used by the server.
• offset: number
  The offset value used in the current page.
• totalResults: number
  The estimated total record count.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"number",
            "description":"The offset value used in the current page."
        },
        "limit":{
            "type":"number",
            "description":"The actual paging size used by the server."
        },
        "count":{
            "type":"number",
            "description":"The number of records returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server."
        },
        "totalResults":{
            "type":"number",
            "description":"The estimated total record count."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/insightGroupInsightTypes"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object insightGroupInsightTypes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/insightGroupInsightTypes"
    },
    "x-cardinality":"1"
}

Nested Schema : insightGroupInsightTypes

Type: object

Show Source

• id(required): string
  Id of the Insight Group Insight Types record.
• insightGroup(required): string
  Unique identifier of insight group.
• insightType(required): string
  Unique identifier of insight type.

{
    "type":"object",
    "properties":{
        "insightGroup":{
            "type":"string",
            "description":"Unique identifier of insight group."
        },
        "id":{
            "type":"string",
            "description":"Id of the Insight Group Insight Types record."
        },
        "insightType":{
            "type":"string",
            "description":"Unique identifier of insight type."
        }
    },
    "required":[
        "id",
        "insightGroup",
        "insightType"
    ]
}

400 Response

An error is encountered due to an invalid request

Body ()

Root Schema : Error

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\n    list."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\n    can 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 : Error

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\n    list."
        },
        "message":{
            "type":"string",
            "description":"More details and corrective actions related to the error which\n    can 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