Endpoint que permite a listagem dos projetos criados na plataforma da SULTS.
URL: https://api.sults.com.br/api/v1/implantacao/projeto
Método: GET
A busca da lista de implantação é paginada. O endpoint é limitado a 100 registros por página.
Parâmetros
Headers
| Header | Valor |
|---|---|
| Authorization | <token_de_acesso> |
| Content-Type | application/json;charset=UTF-8 |
Query parameters
| Filtro | Valor | Descrição |
|---|---|---|
| start | Integer | Início da paginação (número da página). Padrão 0 |
| limit | Integer | Número de registros por página. Máximo 100. Padrão 100 |
| id | Integer | Código do Projeto |
| modeloId | Integer | Código do Modelo do Projeto |
| responsavelId | Integer | Código da pessoa responsável pelo Projeto |
| unidadeId | Integer | Código da empresa do Projeto |
| concluido | Booleano | Booleano que indica se projeto esta concluído. Valores válidos (true ou false). Padrão true |
| dtInicio | String | Data de inicio do projeto. Busca os projetos a partir da data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtFim | String | Data de término do projeto. Busca os projetos anteriores à data informada. Essa data deve ser uma string em UTC ISO 8601. Exemplo: 2021-08-06T18:02:55Z |
Exemplo
fetch("https://api.sults.com.br/api/v1/implantacao/projeto?start=0&limit=100&dtInicio=2018-08-06T18:02:55Z&dtFim=2022-02-01T00:02:55Z", {
method: "GET",
headers: {
"Authorization":"<token_de_acesso>",
"Content-Type":"application/json;charset=UTF-8"
}
})
Resposta
{
"data": [
{
"id": 1,
"nome": "Projeto Teste",
"modelo": {
"id": 1,
"nome": "Modelo de Projeto Teste"
},
"categoria": {
"id": 2,
"nome": "Categoria Teste"
},
"responsavel": {
"id": 999,
"nome": "User Teste"
},
"unidade": {
"id": 999,
"nomeFantasia": "Unidade em implantação #999",
"cnpj": "99999999999999"
},
"tipoCalculoTarefa": 2,
"diaSemanaTarefa": 3,
"descricaoHtml": "<p>Descrição Html</p>",
"anotacaoAtencao": "Nota de atenção.",
"ativo": true,
"pausado": false,
"concluido": false,
"dtCriacao": "2019-03-07T03:54:26Z",
"dtInicio": "2019-03-07T03:00:00Z",
"dtFim": "2020-09-10T03:00:00Z",
"dtInicioPlanejamento": "2019-03-07T03:00:00Z",
"dtFimPlanejamento": "2019-03-31T03:00:00Z",
"dtConclusao": "2019-03-31T03:00:00Z",
"dtPausado": "2019-03-31T03:00:00Z",
"dtInativo": "2019-03-31T03:00:00Z",
"pausadoPessoa": {
"id": 999,
"nome": "User Teste"
},
"inativoPessoa": {
"id": 999,
"nome": "User Teste"
},
"equipe": [
{
"pessoa": {
"id": 999,
"nome": "User Teste"
},
"permitidoProjetoEdicao": true,
"permitidoProjetoDocumentoEdicao": true,
"permitidoProjetoDiscoVirtualEdicao": true,
"permitidoTarefasVerTodas": true,
"permitidoTarefasEdicaoBasica": true,
"permitidoTarefasEdicaoAvancada": true
}
],
"etiqueta": [
{
"id": 1,
"nome": "Estiqueta Teste",
"cor": "#579bfc"
}
]
}
],
"start": 0,
"limit": 100,
"totalPage": 1,
"size": 1
}
Campos da resposta
Campos principais
| Nome Atributo | Tipo | Descrição |
|---|---|---|
| id | Integer | Código do Projeto |
| nome | String | Nome do Projeto |
| modelo | Objeto Modelo: – id – nome | Modelo do Projeto |
| categoria | Objeto Categoria: – id – nome | Categoria do Projeto |
| responsavel | Objeto Pessoa | Pessoa responsável pelo Projeto |
| unidade | Objeto Unidade | Unidade do Projeto |
| tipoCalculoTarefa | Integer referente ao cálculo de prazo das tarefas: 1 – Cálculo Automático 2 – Cálculo Manual | Tipo de cálculo das tarefas do Projeto. |
| diaSemanaTarefa | Integer referente a contagem de dias no cálculo de prazo das tarefas: 1 – Segunda a Sexta 2 – Segunda a Sábado 3 – Dias corridos | Dias da Semana que serão usados no cálculo automático das tarefas do Projeto. |
| descricaoHtml | String | Descrição do Projeto |
| anotacaoAtencao | String | Nota de atenção do Projeto |
| ativo | Booleano | true – projeto ativo. false – projeto inativo. |
| pausado | Booleano | true – projeto pausado. false – projeto não pausado. |
| concluido | Booleano | true – projeto concluído. false – projeto não concluído. |
| dtCriacao | String | Data em que o projeto foi criado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtInicio | String | Data em que o projeto foi iniciado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtFim | String | Data em que o projeto foi finalizado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtInicioPlanejamento | String | Data em que o projeto foi planejado para ser inicializado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtFimPlanejamento | String | Data em que o projeto foi planejado para ser finalizado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtConclusao | String | Data em que o projeto foi concluído. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtPausado | String | Data em que o projeto foi pausado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| dtInativo | String | Data em que o projeto foi inativado. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z |
| pausadoPessoa | Objeto Pessoa | Pessoa que pausou o Projeto |
| inativoPessoa | Objeto Pessoa | Pessoa que inativou o Projeto |
| equipe | Lista de Objeto Equipe | Lista de pessoas e permissões no Projeto |
| etiqueta | Lista de Objeto Etiqueta | Lista de etiquetas do Projeto |
Campos do Objeto Pessoa
| Nome Atributo | Tipo | Descrição |
|---|---|---|
| id | Integer | Código da Pessoa |
| nome | String | Nome da Pessoa |
Campos do Objeto Equipe
| Nome Atributo | Tipo | Descrição |
|---|---|---|
| pessoa | Objeto pessoa | Pessoa da equipe do Projeto |
| permitidoProjetoEdicao | Booleano | Se true a pessoa pode editar o Projeto. |
| permitidoProjetoDocumentoEdicao | Booleano | Se true a pessoa pode editar os Documentos do Projeto |
| permitidoProjetoDiscoVirtualEdicao | Booleano | Se true a pessoa pode editar o Disco Virtual do Projeto |
| permitidoTarefasVerTodas | Booleano | Se true a pessoa pode Ver todas as Tarefas do Projeto |
| permitidoTarefasEdicaoBasica | Booleano | Se true a pessoa pode fazer edições básicas nas Tarefas do Projeto |
| permitidoTarefasEdicaoAvancada | Booleano | Se true a pessoa pode fazer edições avançadas nas Tarefas do Projeto |
Campos do Objeto Unidade
| Nome Atributo | Tipo | Descrição |
|---|---|---|
| id | Integer | Código da Unidade |
| nomeFantasia | String | Nome fantasia da Unidade |
| cnpj | String | CNPJ da Unidade |
Campos do Objeto Etiqueta
| Nome Atributo | Tipo | Descrição |
|---|---|---|
| id | Integer | Código da Etiqueta |
| nome | String | Nome da Etiqueta |
| cor | String | Cor da Etiqueta |