Proposal Page - Documentação da API

Colunas

Criar

Você pode usar esse endpoint para criar uma coluna.

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

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}
1
2
3
4
5
6
7

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da coluna que será criada. ✔️
    blockId string O id do bloco da coluna que será criada. ✔️
    rowId string O id da linha da coluna 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
    size número Tamanho da coluna (min 1 e max 12), a soma dos tamanhos das colunas de uma linha não deve exceder 12. ✔️
    contents array Conteúdos da coluna.

  • Exemplo:

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

Deletar

Você pode usar esse endpoint para excluir uma coluna.

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

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da coluna que será deletada. ✔️
    blockId string O id do bloco da coluna que será deletada. ✔️
    rowId string O id da linha da coluna que será deletada. ✔️
    columnId string O id da coluna a 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/columns/5cc0ac42003a7c001ab5c95a'
1

Listar

Você pode usar esse endpoint para listar as colunas de uma linha.

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

{
  [
    { ... },
    {
      "_id": "5cc0ac42003a7c001ab5c95a",
      "size": "12",
      "contents": [ contentSchema ],
    },
    { ... }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto que as colunas serão listadas. ✔️
    blockId string O id do bloco que as colunas serão listadas. ✔️
    rowId string O id da linha que colunas que 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/5cb869d232f905001a024657/columns'
1

Atualizar

Você pode usar esse endpoint para atualizar uma coluna.

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

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}
1
2
3
4
5
6
7

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da coluna que será atualizada. ✔️
    blockId string O id do bloco da coluna que será atualizada. ✔️
    rowId string O id da linha da coluna que será atualizada. ✔️
    columnId string O id da coluna 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
    size número Tamanho da coluna (min 1 e max 12), a soma dos tamanhos das colunas de uma linha não deve exceder 12. ✔️
    contents array Conteúdos da coluna.

  • Exemplo:

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

Recuperar

Você pode usar esse endpoint para recuperar uma coluna.

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

{
  "_id": "5cc0ac42003a7c001ab5c95a",
  "size": "12",
  "contents": [ contentSchema ],
}
1
2
3
4
5
6
7

  • Parâmetros:

    • Path:
    Nome Tipo Descrição Requerido
    projectId string O id do projeto da coluna que será recuperada. ✔️
    blockId string O id do bloco da coluna que será recuperada. ✔️
    rowId string O id da linha da coluna que será recuperada. ✔️
    columnId string O id da coluna 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/columns/5cc0ac42003a7c001ab5c95a'
1
Editar essa página no GitHub
Última Atualização: 2019-5-14 17:46:47

← Conteúdos →