https://api.movidesk.com/public/v1
Esta API pode ser usada juntamente com a API de contrato de horas.
Atividades
URL: /activity
Métodos: GET / POST / PATCH / DELETE
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
| Id | int | Código de referência da atividade. | ||
| activityDto | activityDto | Objeto que possui os campos da atividade criada. | ||
| data | activityDto | Os campos que serão alterados na atividade. |
activityDto
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
| Id | int | Código de referência da atividade (somente leitura). | ||
| Name | string | 128 | ✓ | Nome da atividade. |
| IsActive | bool | Se a atividade está ou não ativa. | ||
| IsAllowsAllTeams | bool | Se a atividade está disponível para todas as equipes. | ||
| Teams | array | * |
*Obrigatório quando IsAllowsAllTeams=false Não são permitidas equipes com nomes já existentes. |
URL: /addTeamsToActivity
Métodos: POST
| Propriedade | Tipo | Tamanho | Obrigatório | Descrição |
| activityId | int | Código de referência da atividade. | ||
| teams | array | Equipes. |
Método GET
GET: /activity
Parâmetros: id, token
Exemplo: Obtendo a atividade com o id 1
GET: https://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1
Retorno:
{
"id": 1,
"name": "Teste 3",
"isActive": true,
"isAllowsAllTeams": false,
"teams":
[
{
"name": "Administradores"
}
]
}
Obtendo atividades com paginação:
GET: /activity/
Parâmetros: token
Parâmetro opcional: limit, startingAfter, name
Parâmetros:
limit |
Um limite no número de objetos a serem retornados, entre 1 e 100. (padrão: 100) |
startingAfter |
Um cursor para uso na paginação. startingAfter é um ID de objeto que define seu lugar na lista. Por exemplo, se você fizer uma solicitação e receber 100 objetos, terminando com 100, em sua chamada subsequente poderá ser incluida o parametro startingAfter=100 para buscar a próxima página. (opcional) |
name |
Nome da atividade |
Retorno:
hasMore |
Se há ou não mais elementos disponíveis após este conjunto. Se false, compreende-se como o final da lista. |
items |
Um array contendo as atividades da página atual. |
Exemplo: Obtendo um limite de três atividades, que contenha "Atividade" no nome
Retorno:
{
"hasMore": true,
"items": [
{
"id": 371,
"name": "Atividade número dois",
"isActive": true,
"isAllowsAllTeams": false,
"teams": [
{
"name": "Comercial"
},
{
"name": "Desenvolvimento / Manutenção"
}
]
},
{
"id": 370,
"name": "Atividade",
"isActive": true,
"isAllowsAllTeams": true,
"teams": []
},
{
"id": 369,
"name": "Atividade número três",
"isActive": true,
"isAllowsAllTeams": true,
"teams": []
}
]
}
Método POST
POST: /activity
Parâmetros: token
Headers: Content-Type: application/json
Corpo do post: {objeto JSON}
Exemplo:
POST: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738
Headers: Content-Type: application/json
RequestBody:
{
"name": "atividade",
"isActive": true,
"isAllowsAllTeams": false,
"teams":
[
{
"name": "Administradores"
},
{
"name": "Suporte"
}
]
}
Retorno: Status 200 e o id da atividade criada
Método PATCH
PATCH: /activity
Parâmetros: id, token
Headers: Content-Type: application/json
Corpo do post: {objeto JSON}
Exemplo: Alterando o nome e os times da atividade com o id 1
POST: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1
RequestBody:
{
"name": "atividade alterada",
"teams":
[
{
"name": "Equipe"
}
]
}
Retorno: Status 200 e o id da atividade alteradaMétodo DELETE
DELETE: /activity
Parâmetros: id, token
Exemplo: Excluindo a atividade de id 1
DELETE: http://api.movidesk.com/public/v1/activity?token=c4f511ca-83e5-4155-9d01-325fa3ab3738&id=1
Retorno: Status 200 e o id da atividade excluída
Método POST
POST: /addTeamsToActivity
Parâmetros: activityId, token
Headers: Content-Type: application/json
Corpo do post: {objeto JSON}
Exemplo: adicionado a equipe "Suporte" à atividade de id 1
RequestBody:
[
"Suporte"
]
Retorno: Status 200 e um array com todas as equipes da atividade alterada após a adição das equipes