Jump to

• Request
• Response

Get all the saved searches

get

/topology/v2/ui/savedsearch

Return all the saved searches sorted in the descending order of created date

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

All Searches retrieved successfully

Body ()

Root Schema : schema

Type: object

Show Source

• createdDate: string (date)
• createdUser: string
• description: string
• entityType: string
• id: integer (int64)
• lastEdgeCount: integer (int32)
• lastModifiedDate: string (date)
• lastModifiedUser: string
• lastNodeCount: integer (int32)
• name: string
• pathView: boolean
• searchParams: array searchParams
• url: string
• userId: string

{
    "properties":{
        "createdDate":{
            "format":"date",
            "type":"string"
        },
        "createdUser":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "entityType":{
            "type":"string"
        },
        "id":{
            "format":"int64",
            "type":"integer"
        },
        "lastEdgeCount":{
            "format":"int32",
            "type":"integer"
        },
        "lastModifiedDate":{
            "format":"date",
            "type":"string"
        },
        "lastModifiedUser":{
            "type":"string"
        },
        "lastNodeCount":{
            "format":"int32",
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "pathView":{
            "type":"boolean"
        },
        "searchParams":{
            "items":{
                "$ref":"#/components/schemas/SavedSearchParamType"
            },
            "type":"array"
        },
        "url":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : searchParams

Type: array

Show Source

• Array of: object SavedSearchParamType

{
    "items":{
        "$ref":"#/components/schemas/SavedSearchParamType"
    },
    "type":"array"
}

Nested Schema : SavedSearchParamType

Type: object

Show Source

• filterName: string
• filterValue: string
• id: integer (int64)
• operator: string
• paramNumber: integer (int32)
• valueList: array valueList

{
    "properties":{
        "filterName":{
            "type":"string"
        },
        "filterValue":{
            "type":"string"
        },
        "id":{
            "format":"int64",
            "type":"integer"
        },
        "operator":{
            "type":"string"
        },
        "paramNumber":{
            "format":"int32",
            "type":"integer"
        },
        "valueList":{
            "items":{
                "type":"string"
            },
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : valueList

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Examples

Select an example Response

400 Response

The request isn't valid

Body ()

Root Schema : ErrorType

Type: object

Show Source

• code(required): string
• message: array message
• reason(required): string
• status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

401 Response

The request is unauthorized

Body ()

Root Schema : ErrorType

Type: object

Show Source

• code(required): string
• message: array message
• reason(required): string
• status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

403 Response

The request is forbidden

Body ()

Root Schema : ErrorType

Type: object

Show Source

• code(required): string
• message: array message
• reason(required): string
• status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

404 Response

The requested resource not found

Body ()

Root Schema : ErrorType

Type: object

Show Source

• code(required): string
• message: array message
• reason(required): string
• status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

500 Response

An Internal Server Error has occurred

Body ()

Root Schema : ErrorType

Type: object

Show Source

• code(required): string
• message: array message
• reason(required): string
• status: string

{
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "nullable":false,
            "type":"string"
        },
        "message":{
            "items":{
                "type":"string"
            },
            "type":"array"
        },
        "reason":{
            "nullable":false,
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    },
    "type":"object"
}

Nested Schema : message

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    },
    "type":"array"
}

Back to Top