POST v1/Lists

Request Information

URI Parameters

None.

Body Parameters

ListInModel
NameDescriptionTypeAdditional information
id

integer

None.

name

string

Required

description

string

None.

isMenuList

boolean

None.

listType

integer

None.

Request Formats

application/json, text/json, application/vnd.team.do+json

Sample:
{
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isMenuList": true,
  "listType": 5
}

text/html

Sample:
{"id":1,"name":"sample string 2","description":"sample string 3","isMenuList":true,"listType":5}

Response Information

Resource Description

ListOutModel
NameDescriptionTypeAdditional information
items

Collection of BaseModel

None.

id

integer

None.

name

string

Required

description

string

None.

isMenuList

boolean

None.

listType

integer

None.

Response Formats

application/json, text/json, application/vnd.team.do+json

Sample:
{
  "items": [
    {
      "id": 1,
      "name": "sample string 2",
      "listId": 3,
      "orderRow": 4,
      "color": "sample string 5",
      "textColor": "sample string 6"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "listId": 3,
      "orderRow": 4,
      "color": "sample string 5",
      "textColor": "sample string 6"
    }
  ],
  "id": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "isMenuList": true,
  "listType": 5
}

text/html

Sample:
{"items":[{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"},{"id":1,"name":"sample string 2","listId":3,"orderRow":4,"color":"sample string 5","textColor":"sample string 6"}],"id":1,"name":"sample string 2","description":"sample string 3","isMenuList":true,"listType":5}