Retrieves lists in a portal based on search criteria

get

/spaces/{spacename}/lists

Returns all the available list based on the specified search criteria

• Request
• Response

Request

Path Parameters

spacename

Type: string

Required: true

Name of the portal

Query Parameters

itemsPerPage

Type: integer

Number of items per page

Default Value

10

projection

Type: string

Projection parameters

q

Type: string

Parameters to use for search

startIndex

Type: integer

Start index

Default Value

0

Response

Supported Media Types

• application/json

200 Response

success

Body

Root Schema : lists

Properties

items

Type: array items

itemsPerPage

Type: integer

links

Type: array links

linkStates

Type: array linkStates

resourceType

Type: string

startIndex

Type: integer

totalResults

Type: integer

Nested Schema : items

Type: array

Items

• Type: object link

Nested Schema : links

Type: array

Items

• Type: object link

Nested Schema : linkStates

Type: array

Items

• Type: object LinkElementState

Nested Schema : link

Properties

capabilities

Type: string

contentType

Type: string

href

Type: string

rel

Type: string

resourceType

Type: string

template

Type: string

title

Type: string

type

Type: string

Nested Schema : LinkElementState

Properties

href

Type: boolean

path

Type: string

pathLinkValues

Type: array pathLinkValues

pathLinkWildcards

Type: array pathLinkWildcards

resourceMethod

Type: object reflect.Method

resourceType

Type: string

root

Type: boolean

supportedMethods

Type: array supportedMethods

supportedQueryParams

Type: array supportedQueryParams

template

Type: boolean

Nested Schema : pathLinkValues

Type: array

Items

• Type: string

Nested Schema : pathLinkWildcards

Type: array

Items

• Type: string

Nested Schema : reflect.Method

Properties

accessible

Type: boolean

annotatedExceptionTypes

Type: array annotatedExceptionTypes

annotatedParameterTypes

Type: array annotatedParameterTypes

annotatedReceiverType

Type: object reflect.AnnotatedType

annotatedReturnType

Type: object reflect.AnnotatedType

bridge

Type: boolean

default

Type: boolean

defaultValue

Type: integer

genericExceptionTypes

Type: array genericExceptionTypes

genericParameterTypes

Type: array genericParameterTypes

genericReturnType

Type: object reflect.Type

modifiers

Type: integer (int32)

name

Type: string

parameterCount

Type: integer (int32)

parameters

Type: array parameters

synthetic

Type: boolean

typeParameters

Type: array typeParameters

varArgs

Type: boolean

Nested Schema : supportedMethods

Type: array

Items

• Type: string

Nested Schema : supportedQueryParams

Type: array

Items

• Type: object QueryParam

Nested Schema : annotatedExceptionTypes

Type: array

Items

• Type: object reflect.AnnotatedType

Nested Schema : annotatedParameterTypes

Type: array

Items

• Type: object reflect.AnnotatedType

Nested Schema : reflect.AnnotatedType

Properties

type

Type: object reflect.Type

Nested Schema : genericExceptionTypes

Type: array

Items

• Type: object reflect.Type

Nested Schema : genericParameterTypes

Type: array

Items

• Type: object reflect.Type

Nested Schema : reflect.Type

Properties

typeName

Type: string

Nested Schema : parameters

Type: array

Items

• Type: object reflect.Parameter

Nested Schema : typeParameters

Type: array

Items

• Type: object reflect.TypeVariable

Nested Schema : reflect.Parameter

Properties

annotatedType

Type: object reflect.AnnotatedType

declaringExecutable

Type: object reflect.Executable

implicit

Type: boolean

modifiers

Type: integer (int32)

name

Type: string

namePresent

Type: boolean

parameterizedType

Type: object reflect.Type

synthetic

Type: boolean

varArgs

Type: boolean

Nested Schema : reflect.Executable

Properties

accessible

Type: boolean

annotatedExceptionTypes

Type: array annotatedExceptionTypes

annotatedParameterTypes

Type: array annotatedParameterTypes

annotatedReceiverType

Type: object reflect.AnnotatedType

annotatedReturnType

Type: object reflect.AnnotatedType

genericExceptionTypes

Type: array genericExceptionTypes

genericParameterTypes

Type: array genericParameterTypes

modifiers

Type: integer (int32)

name

Type: string

parameterCount

Type: integer (int32)

parameters

Type: array parameters

synthetic

Type: boolean

typeParameters

Type: array typeParameters

varArgs

Type: boolean

Nested Schema : annotatedExceptionTypes

Type: array

Items

• Type: object reflect.AnnotatedType

Nested Schema : annotatedParameterTypes

Type: array

Items

• Type: object reflect.AnnotatedType

Nested Schema : genericExceptionTypes

Type: array

Items

• Type: object reflect.Type

Nested Schema : genericParameterTypes

Type: array

Items

• Type: object reflect.Type

Nested Schema : parameters

Type: array

Items

• Type: object reflect.Parameter

Nested Schema : typeParameters

Type: array

Items

• Type: object reflect.TypeVariable

Nested Schema : reflect.TypeVariable

Properties

annotatedBounds

Type: array annotatedBounds

bounds

Type: array bounds

name

Type: string

Nested Schema : annotatedBounds

Type: array

Items

• Type: object reflect.AnnotatedType

Nested Schema : bounds

Type: array

Items

• Type: object reflect.Type

Nested Schema : QueryParam

Properties

value

Type: string

500 Response

Specified List is unavailable for this portal