Jump to

• Request
• Response

Retrieve list by ID

get

/spaces/{spacename}/lists/({id: .+})

Retrieves the available list based on the specified ID

Request

Path Parameters

• id: string
  List ID
• spacename: string
  Name of the portal

Back to Top

Response

Supported Media Types

• application/json

200 Response

success

Body ()

Root Schema : list

Type: object

Show Source

• author(optional): object PersonReference
• columns(optional): object MetaColumns
• created(optional): string
• creator(optional): string
• description(optional): string
• id(optional): string
• modified(optional): string
• modifiedByUser(optional): object PersonReference
• modifier(optional): string
• name(optional): string
• scope(optional): string

{
    "properties":{
        "created":{
            "type":"string"
        },
        "columns":{
            "$ref":"#/definitions/MetaColumns"
        },
        "author":{
            "$ref":"#/definitions/PersonReference"
        },
        "id":{
            "type":"string"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/PersonReference"
        },
        "creator":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "modifier":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "modified":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : PersonReference

Type: object

Show Source

• displayName(optional): string
• guid(optional): string
• id(optional): string

{
    "properties":{
        "displayName":{
            "type":"string"
        },
        "guid":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : MetaColumns

Type: object

Show Source

• items(optional): array items
• links(optional): array links
• linkStates(optional): array linkStates
• resourceType(optional): string

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MetaColumn"
            }
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "resourceType":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object MetaColumn

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MetaColumn"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : linkStates

Type: array

Show Source

• Array of: object LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

Nested Schema : MetaColumn

Type: object

Show Source

• allowLinks(optional): boolean
• dataType(optional): string
• defaultValue(optional): integer
• displayLength(optional): object BigInteger
• displayWidth(optional): object BigInteger
• editLines(optional): object BigInteger
• format(optional): string
• hint(optional): string
• id(optional): string
• link(optional): array link
• linkStates(optional): array linkStates
• linkTarget(optional): string
• maxLength(optional): object BigInteger
• name(optional): string
• peopleScope(optional): string
• rangeHigh(optional): object BigDecimal
• rangeLow(optional): object BigDecimal
• required(optional): boolean
• resourceType(optional): string

{
    "properties":{
        "hint":{
            "type":"string"
        },
        "rangeHigh":{
            "$ref":"#/definitions/BigDecimal"
        },
        "id":{
            "type":"string"
        },
        "maxLength":{
            "$ref":"#/definitions/BigInteger"
        },
        "name":{
            "type":"string"
        },
        "linkTarget":{
            "type":"string"
        },
        "editLines":{
            "$ref":"#/definitions/BigInteger"
        },
        "required":{
            "type":"boolean"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "dataType":{
            "type":"string"
        },
        "peopleScope":{
            "type":"string"
        },
        "allowLinks":{
            "type":"boolean"
        },
        "defaultValue":{
            "type":"integer"
        },
        "linkStates":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkElementState"
            }
        },
        "resourceType":{
            "type":"string"
        },
        "displayWidth":{
            "$ref":"#/definitions/BigInteger"
        },
        "displayLength":{
            "$ref":"#/definitions/BigInteger"
        },
        "format":{
            "type":"string"
        },
        "rangeLow":{
            "$ref":"#/definitions/BigDecimal"
        }
    }
}

Nested Schema : BigInteger

Type: object

Show Source

• bitCount(optional): integer(int32)
• bitLength(optional): integer(int32)
• lowestSetBit(optional): integer(int32)
• signum(optional): integer(int32)

{
    "properties":{
        "bitCount":{
            "type":"integer",
            "format":"int32"
        },
        "bitLength":{
            "type":"integer",
            "format":"int32"
        },
        "lowestSetBit":{
            "type":"integer",
            "format":"int32"
        },
        "signum":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : linkStates

Type: array

Show Source

• Array of: object LinkElementState

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkElementState"
    }
}

Nested Schema : BigDecimal

Type: object

Show Source

• precision(optional): integer(int32)
• scale(optional): integer(int32)

{
    "properties":{
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "scale":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : link

Type: object

Show Source

• capabilities(optional): string
• contentType(optional): string
• href(optional): string
• rel(optional): string
• resourceType(optional): string
• template(optional): string
• title(optional): string
• type(optional): string

{
    "properties":{
        "contentType":{
            "type":"string"
        },
        "resourceType":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "capabilities":{
            "type":"string"
        },
        "template":{
            "type":"string"
        },
        "title":{
            "type":"string"
        }
    }
}

Nested Schema : LinkElementState

Type: object

Show Source

• href(optional): boolean
• path(optional): string
• pathLinkValues(optional): array pathLinkValues
• pathLinkWildcards(optional): array pathLinkWildcards
• resourceMethod(optional): object reflect.Method
• resourceType(optional): string
• root(optional): boolean
• template(optional): boolean

{
    "properties":{
        "resourceType":{
            "type":"string"
        },
        "root":{
            "type":"boolean"
        },
        "path":{
            "type":"string"
        },
        "template":{
            "type":"boolean"
        },
        "pathLinkValues":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "pathLinkWildcards":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "href":{
            "type":"boolean"
        },
        "resourceMethod":{
            "$ref":"#/definitions/reflect.Method"
        }
    }
}

Nested Schema : pathLinkValues

Type: array

Show Source

• Array of: string

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

Nested Schema : pathLinkWildcards

Type: array

Show Source

• Array of: string

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

Nested Schema : reflect.Method

Type: object

Show Source

• accessible(optional): boolean
• annotatedExceptionTypes(optional): array annotatedExceptionTypes
• annotatedParameterTypes(optional): array annotatedParameterTypes
• annotatedReceiverType(optional): object reflect.AnnotatedType
• annotatedReturnType(optional): object reflect.AnnotatedType
• bridge(optional): boolean
• default(optional): boolean
• defaultValue(optional): integer
• genericExceptionTypes(optional): array genericExceptionTypes
• genericParameterTypes(optional): array genericParameterTypes
• genericReturnType(optional): object reflect.Type
• modifiers(optional): integer(int32)
• name(optional): string
• parameterCount(optional): integer(int32)
• parameters(optional): array parameters
• synthetic(optional): boolean
• typeParameters(optional): array typeParameters
• varArgs(optional): boolean

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "bridge":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "genericReturnType":{
            "$ref":"#/definitions/reflect.Type"
        },
        "defaultValue":{
            "type":"integer"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        },
        "default":{
            "type":"boolean"
        }
    }
}

Nested Schema : annotatedExceptionTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : annotatedParameterTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : reflect.AnnotatedType

Type: object

Show Source

• type(optional): object reflect.Type

{
    "properties":{
        "type":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

Nested Schema : genericExceptionTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : genericParameterTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : reflect.Type

Type: object

Show Source

• typeName(optional): string

{
    "properties":{
        "typeName":{
            "type":"string"
        }
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

Nested Schema : typeParameters

Type: array

Show Source

• Array of: object reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

Nested Schema : reflect.Parameter

Type: object

Show Source

• annotatedType(optional): object reflect.AnnotatedType
• declaringExecutable(optional): object reflect.Executable
• implicit(optional): boolean
• modifiers(optional): integer(int32)
• name(optional): string
• namePresent(optional): boolean
• parameterizedType(optional): object reflect.Type
• synthetic(optional): boolean
• varArgs(optional): boolean

{
    "properties":{
        "varArgs":{
            "type":"boolean"
        },
        "implicit":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "namePresent":{
            "type":"boolean"
        },
        "annotatedType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "declaringExecutable":{
            "$ref":"#/definitions/reflect.Executable"
        },
        "parameterizedType":{
            "$ref":"#/definitions/reflect.Type"
        }
    }
}

Nested Schema : reflect.Executable

Type: object

Show Source

• accessible(optional): boolean
• annotatedExceptionTypes(optional): array annotatedExceptionTypes
• annotatedParameterTypes(optional): array annotatedParameterTypes
• annotatedReceiverType(optional): object reflect.AnnotatedType
• annotatedReturnType(optional): object reflect.AnnotatedType
• genericExceptionTypes(optional): array genericExceptionTypes
• genericParameterTypes(optional): array genericParameterTypes
• modifiers(optional): integer(int32)
• name(optional): string
• parameterCount(optional): integer(int32)
• parameters(optional): array parameters
• synthetic(optional): boolean
• typeParameters(optional): array typeParameters
• varArgs(optional): boolean

{
    "properties":{
        "genericExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "genericParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "varArgs":{
            "type":"boolean"
        },
        "annotatedReturnType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "parameterCount":{
            "type":"integer",
            "format":"int32"
        },
        "annotatedReceiverType":{
            "$ref":"#/definitions/reflect.AnnotatedType"
        },
        "name":{
            "type":"string"
        },
        "annotatedExceptionTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "accessible":{
            "type":"boolean"
        },
        "modifiers":{
            "type":"integer",
            "format":"int32"
        },
        "synthetic":{
            "type":"boolean"
        },
        "annotatedParameterTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Parameter"
            }
        },
        "typeParameters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.TypeVariable"
            }
        }
    }
}

Nested Schema : annotatedExceptionTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : annotatedParameterTypes

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : genericExceptionTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : genericParameterTypes

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

Nested Schema : parameters

Type: array

Show Source

• Array of: object reflect.Parameter

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Parameter"
    }
}

Nested Schema : typeParameters

Type: array

Show Source

• Array of: object reflect.TypeVariable

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.TypeVariable"
    }
}

Nested Schema : reflect.TypeVariable

Type: object

Show Source

• annotatedBounds(optional): array annotatedBounds
• bounds(optional): array bounds
• name(optional): string

{
    "properties":{
        "bounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.Type"
            }
        },
        "annotatedBounds":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/reflect.AnnotatedType"
            }
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : annotatedBounds

Type: array

Show Source

• Array of: object reflect.AnnotatedType

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.AnnotatedType"
    }
}

Nested Schema : bounds

Type: array

Show Source

• Array of: object reflect.Type

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/reflect.Type"
    }
}

404 Response

ID for the portal, list, or column is invalid

500 Response

Specified List is unavailable for this portal

Back to Top