This site is moving soon to become part of an integrated Appfire documentation and information site for our apps. This site will remain available during the transition to our new and improved site. Once this site is moved over, this banner will be updated with the new site link for easy access.
Take a look here! If you have any questions please email support@appfire.com
Métodos de atualização da API
- Weronika Spaleniak (Unlicensed)
A url base para todas as chamadas de API é:
Se você está na região da UE:
https://okr-for-jira-prod-eu.herokuapp.com
Em todas as outras localidades:
https://okr-for-jira-prod.herokuapp.com
Pré-requisitos
Todos os métodos de atualização são POST e requerem objeto JSON com propriedades
especificadas no corpo da solicitação.
A autenticação é realizada do mesmo modo, assim como para os métodos de consulta - usando o
cabeçalho API-Token: {token} com o seu token de autenticação.
Além disso, o cabeçalho Content-Type: application/json é obrigatório para o servidor, para
analisar a sua solicitação corretamente.
Atualizar objetivo
Criar atualização para o objetivo especificado com
POST /api/v2/api-update/objectives
Propriedade | Descrição | Obrigatório |
|---|---|---|
| Id do objetivo a ser atualizado. | |
| Novo estado do objetivo. Status permitidos: | |
| Uma descrição para aparecer na atualização criada. |
Exemplo de solicitação:
POST https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/objectives
Corpo da solicitação:
{
"objectiveId": "62334eac00ee2b102e34fdb7",
"status" : "ON TRACK",
"description" : "Spaceship assembly docks are delivering on time"
}
Atualizar key result
Criar atualização para o key result especificado.
POST /api/v2/api-update/keyResults
Propriedade | Descrição | Obrigatório |
|---|---|---|
| Id do key result que será atualizado. | |
| Novo estado do key result. Status permitidos: | |
| Valor do progresso para definir na atualização. | |
| Uma descrição para aparecer na atualização criada. |
Exemplo de solicitação:
POST https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/keyResults
Corpo da solicitação: