Jump to

• Request
• Response

Create a row in a list

post

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

Creates a row in a list

Request

Path Parameters

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

Body ()

Row data

Root Schema : Row

Type: object

Show Source

• author(optional): object PersonReference
• columns(optional): array columns
• created(optional): string
• creator(optional): string
• id(optional): string
• listId(optional): string
• modified(optional): string
• modifiedByUser(optional): object PersonReference
• modifier(optional): string
• scope(optional): string

{
    "properties":{
        "created":{
            "type":"string"
        },
        "columns":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/dataColumn"
            }
        },
        "author":{
            "$ref":"#/definitions/PersonReference"
        },
        "id":{
            "type":"string"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/PersonReference"
        },
        "creator":{
            "type":"string"
        },
        "listId":{
            "type":"string"
        },
        "modifier":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "modified":{
            "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 : columns

Type: array

Show Source

• Array of: object dataColumn

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

Nested Schema : dataColumn

Type: object

Show Source

• id(optional): string
• name(optional): string
• value(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

success

Body ()

Root Schema : Row

Type: object

Show Source

• author(optional): object PersonReference
• columns(optional): array columns
• created(optional): string
• creator(optional): string
• id(optional): string
• listId(optional): string
• modified(optional): string
• modifiedByUser(optional): object PersonReference
• modifier(optional): string
• scope(optional): string

{
    "properties":{
        "created":{
            "type":"string"
        },
        "columns":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/dataColumn"
            }
        },
        "author":{
            "$ref":"#/definitions/PersonReference"
        },
        "id":{
            "type":"string"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/PersonReference"
        },
        "creator":{
            "type":"string"
        },
        "listId":{
            "type":"string"
        },
        "modifier":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "modified":{
            "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 : columns

Type: array

Show Source

• Array of: object dataColumn

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

Nested Schema : dataColumn

Type: object

Show Source

• id(optional): string
• name(optional): string
• value(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

201 Response

Row successfully created

404 Response

ID for the portal, list, or row is invalid

422 Response

Data in the specified list row is invalid

500 Response

Specified List is unavailable for this portal

Back to Top