Create list
post
/spaces/{spacename}/lists
Creates a list
Request
Path Parameters
- spacename
-
Type:
stringRequired:trueName of the portal
Body Parameter
List data
Root Schema : list
- author
-
Type:
objectPersonReference - columns
-
Type:
objectMetaColumns - created
-
Type:
string - creator
-
Type:
string - description
-
Type:
string - id
-
Type:
string - modified
-
Type:
string - modifiedByUser
-
Type:
objectPersonReference - modifier
-
Type:
string - name
-
Type:
string - scope
-
Type:
string
Nested Schema : PersonReference
- displayName
-
Type:
string - guid
-
Type:
string - id
-
Type:
string
Nested Schema : MetaColumns
- items
-
Type:
arrayitems - links
-
Type:
arraylinks - linkStates
-
Type:
arraylinkStates - resourceType
-
Type:
string
Nested Schema : items
Type:
array-
Type:
objectMetaColumn
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : MetaColumn
- allowLinks
-
Type:
boolean - dataType
-
Type:
string - defaultValue
-
Type:
integer - displayLength
-
Type:
objectBigInteger - displayWidth
-
Type:
objectBigInteger - editLines
-
Type:
objectBigInteger - format
-
Type:
string - hint
-
Type:
string - id
-
Type:
string - link
-
Type:
arraylink - linkStates
-
Type:
arraylinkStates - linkTarget
-
Type:
string - maxLength
-
Type:
objectBigInteger - name
-
Type:
string - peopleScope
-
Type:
string - rangeHigh
-
Type:
objectBigDecimal - rangeLow
-
Type:
objectBigDecimal - required
-
Type:
boolean - resourceType
-
Type:
string
Nested Schema : BigInteger
- bitCount
-
Type:
integer(int32) - bitLength
-
Type:
integer(int32) - lowestSetBit
-
Type:
integer(int32) - signum
-
Type:
integer(int32)
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : BigDecimal
- precision
-
Type:
integer(int32) - scale
-
Type:
integer(int32)
Nested Schema : link
- 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
- href
-
Type:
boolean - path
-
Type:
string - pathLinkValues
-
Type:
arraypathLinkValues - pathLinkWildcards
-
Type:
arraypathLinkWildcards - resourceMethod
-
Type:
objectreflect.Method - resourceType
-
Type:
string - root
-
Type:
boolean - supportedMethods
-
Type:
arraysupportedMethods - supportedQueryParams
-
Type:
arraysupportedQueryParams - template
-
Type:
boolean
Nested Schema : pathLinkValues
Type:
array-
Type:
string
Nested Schema : pathLinkWildcards
Type:
array-
Type:
string
Nested Schema : reflect.Method
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - bridge
-
Type:
boolean - default
-
Type:
boolean - defaultValue
-
Type:
integer - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - genericReturnType
-
Type:
objectreflect.Type - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : supportedMethods
Type:
array-
Type:
string
Nested Schema : supportedQueryParams
Type:
array-
Type:
objectQueryParam
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : reflect.AnnotatedType
- type
-
Type:
objectreflect.Type
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : reflect.Type
- typeName
-
Type:
string
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.Parameter
- annotatedType
-
Type:
objectreflect.AnnotatedType - declaringExecutable
-
Type:
objectreflect.Executable - implicit
-
Type:
boolean - modifiers
-
Type:
integer(int32) - name
-
Type:
string - namePresent
-
Type:
boolean - parameterizedType
-
Type:
objectreflect.Type - synthetic
-
Type:
boolean - varArgs
-
Type:
boolean
Nested Schema : reflect.Executable
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.TypeVariable
- annotatedBounds
-
Type:
arrayannotatedBounds - bounds
-
Type:
arraybounds - name
-
Type:
string
Nested Schema : annotatedBounds
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : bounds
Type:
array-
Type:
objectreflect.Type
Nested Schema : QueryParam
- value
-
Type:
string
Response
Supported Media Types
- application/json
200 Response
success
Body
Root Schema : list
- author
-
Type:
objectPersonReference - columns
-
Type:
objectMetaColumns - created
-
Type:
string - creator
-
Type:
string - description
-
Type:
string - id
-
Type:
string - modified
-
Type:
string - modifiedByUser
-
Type:
objectPersonReference - modifier
-
Type:
string - name
-
Type:
string - scope
-
Type:
string
Nested Schema : PersonReference
- displayName
-
Type:
string - guid
-
Type:
string - id
-
Type:
string
Nested Schema : MetaColumns
- items
-
Type:
arrayitems - links
-
Type:
arraylinks - linkStates
-
Type:
arraylinkStates - resourceType
-
Type:
string
Nested Schema : items
Type:
array-
Type:
objectMetaColumn
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : MetaColumn
- allowLinks
-
Type:
boolean - dataType
-
Type:
string - defaultValue
-
Type:
integer - displayLength
-
Type:
objectBigInteger - displayWidth
-
Type:
objectBigInteger - editLines
-
Type:
objectBigInteger - format
-
Type:
string - hint
-
Type:
string - id
-
Type:
string - link
-
Type:
arraylink - linkStates
-
Type:
arraylinkStates - linkTarget
-
Type:
string - maxLength
-
Type:
objectBigInteger - name
-
Type:
string - peopleScope
-
Type:
string - rangeHigh
-
Type:
objectBigDecimal - rangeLow
-
Type:
objectBigDecimal - required
-
Type:
boolean - resourceType
-
Type:
string
Nested Schema : BigInteger
- bitCount
-
Type:
integer(int32) - bitLength
-
Type:
integer(int32) - lowestSetBit
-
Type:
integer(int32) - signum
-
Type:
integer(int32)
Nested Schema : linkStates
Type:
array-
Type:
objectLinkElementState
Nested Schema : BigDecimal
- precision
-
Type:
integer(int32) - scale
-
Type:
integer(int32)
Nested Schema : link
- 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
- href
-
Type:
boolean - path
-
Type:
string - pathLinkValues
-
Type:
arraypathLinkValues - pathLinkWildcards
-
Type:
arraypathLinkWildcards - resourceMethod
-
Type:
objectreflect.Method - resourceType
-
Type:
string - root
-
Type:
boolean - supportedMethods
-
Type:
arraysupportedMethods - supportedQueryParams
-
Type:
arraysupportedQueryParams - template
-
Type:
boolean
Nested Schema : pathLinkValues
Type:
array-
Type:
string
Nested Schema : pathLinkWildcards
Type:
array-
Type:
string
Nested Schema : reflect.Method
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - bridge
-
Type:
boolean - default
-
Type:
boolean - defaultValue
-
Type:
integer - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - genericReturnType
-
Type:
objectreflect.Type - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : supportedMethods
Type:
array-
Type:
string
Nested Schema : supportedQueryParams
Type:
array-
Type:
objectQueryParam
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : reflect.AnnotatedType
- type
-
Type:
objectreflect.Type
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : reflect.Type
- typeName
-
Type:
string
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.Parameter
- annotatedType
-
Type:
objectreflect.AnnotatedType - declaringExecutable
-
Type:
objectreflect.Executable - implicit
-
Type:
boolean - modifiers
-
Type:
integer(int32) - name
-
Type:
string - namePresent
-
Type:
boolean - parameterizedType
-
Type:
objectreflect.Type - synthetic
-
Type:
boolean - varArgs
-
Type:
boolean
Nested Schema : reflect.Executable
- accessible
-
Type:
boolean - annotatedExceptionTypes
-
Type:
arrayannotatedExceptionTypes - annotatedParameterTypes
-
Type:
arrayannotatedParameterTypes - annotatedReceiverType
-
Type:
objectreflect.AnnotatedType - annotatedReturnType
-
Type:
objectreflect.AnnotatedType - genericExceptionTypes
-
Type:
arraygenericExceptionTypes - genericParameterTypes
-
Type:
arraygenericParameterTypes - modifiers
-
Type:
integer(int32) - name
-
Type:
string - parameterCount
-
Type:
integer(int32) - parameters
-
Type:
arrayparameters - synthetic
-
Type:
boolean - typeParameters
-
Type:
arraytypeParameters - varArgs
-
Type:
boolean
Nested Schema : annotatedExceptionTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : annotatedParameterTypes
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : genericExceptionTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : genericParameterTypes
Type:
array-
Type:
objectreflect.Type
Nested Schema : parameters
Type:
array-
Type:
objectreflect.Parameter
Nested Schema : typeParameters
Type:
array-
Type:
objectreflect.TypeVariable
Nested Schema : reflect.TypeVariable
- annotatedBounds
-
Type:
arrayannotatedBounds - bounds
-
Type:
arraybounds - name
-
Type:
string
Nested Schema : annotatedBounds
Type:
array-
Type:
objectreflect.AnnotatedType
Nested Schema : bounds
Type:
array-
Type:
objectreflect.Type
Nested Schema : QueryParam
- value
-
Type:
string
201 Response
List successfully created
400 Response
ID for the portal or list is invalid
422 Response
Data in the specified list is invalid
500 Response
List cannot be created