Linhas

Clonar

Você pode usar esse endpoint para clonar uma linha e colocá-la em uma posição específica.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>/clone/<position>
1
  • Resposta:
Status: 201

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da linha que será clonada. ✔️
    blockId string O id do bloco da linha que será clonada. ✔️
    rowId string O id da linha que será clonada. ✔️
    position número A posição para colocar a linha que será clonada (por exemplo, 0 é a primeira).
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.
  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657/clone/0'
1

Criar

Você pode usar esse endpoint para criar uma linha.

  • Endpoint:
POST https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows
1
  • Resposta:
Status: 201

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da linha que será criada. ✔️
    blockId string O id do bloco da linha que será criada. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo:
    Nome Tipo Descrição Requerido
    description string Descrição da linha. ✔️
    columns array Colunas da linha.
  • Exemplo:

curl -XPOST -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "New row", "columns": [] }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows'
1

Deletar

Você pode usar esse endpoint para excluir uma linha.

  • Endpoint:
DELETE https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>
1
  • Resposta:
Status: 204 (no-content)
1
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da linha que será deletada. ✔️
    blockId string O id do bloco da linha que será deletada. ✔️
    rowId string O id da linha que será deletada. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.
  • Exemplo:

curl -XDELETE -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657'
1

Listar

Você pode usar endpoint para listar as linhas de um bloco.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows
1
  • Resposta:
Status: 200

{
  [
    { ... },
    {
      "_id": "5cb869d232f905001a024657",
      "description": "New row",
      "columns": [ columnSchema ],
      "createdAt": "2019-01-18T13:56:53.742Z",
      "updatedAt": "2019-01-18T13:56:53.742Z"
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto que as linhas do bloco serão listadas. ✔️
    blockId string O id do bloco que as linhas serão listadas. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.
  • Exemplo:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows'
1

Atualizar

Você pode usar esse endpoint para atualizar uma linha.

  • Endpoint:
PUT https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>
1
  • Resposta:
Status: 200

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da linha que será atualizada. ✔️
    blockId string O id do bloco da linha que será atualizada. ✔️
    rowId string O id da linha que será atualizada. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo:
    Nome Tipo Descrição Requerido
    description string Descrição da linha.
    columns array Colunas da linha.
  • Exemplo:

curl -XPUT -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" -d '{ "description": "Updated description" }' 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657'
1

Recuperar

Você pode usar esse endpoint para recuperar uma linha.

  • Endpoint:
GET https://api.proposalpage.com/projects/<projectId>/blocks/<blockId>/rows/<rowId>
1
  • Resposta:
Status: 200

{
  "_id": "5cb869d232f905001a024657",
  "description": "New row",
  "columns": [ columnSchema ],
  "createdAt": "2019-01-18T13:56:53.742Z",
  "updatedAt": "2019-01-18T13:56:53.742Z"
}
1
2
3
4
5
6
7
8
9
  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da linha que será recuperada. ✔️
    blockId string O id do bloco da linha que será recuperada. ✔️
    rowId string O id da linha que será recuperada. ✔️
    • Cabeçalho:
    Nome Tipo Descrição Requerido
    Authorization string Seu Bearer Token obtido no endpoint autenticação. ✔️
    • Corpo: Vazio.
  • Exemplo:

curl -XGET -H 'Authorization: Bearer $TOKEN' -H "Content-type: application/json" 'https://api.proposalpage.com/projects/5cbe31f7372099001a4f0d74/blocks/5c41db25d139900014b5d8ae/5cb869d232f905001a024657/rows/5cb869d232f905001a024657'
1
Última Atualização: 2019-5-14 17:46:47