---
title: "Métodos de atualização da API"
canonical: "https://support.appfire.com/space/OFJ/603652621/M%C3%A9todos%20de%20atualiza%C3%A7%C3%A3o%20da%20API"
format: markdown
---
**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](https://okr-for-jira-prod-eu.herokuapp.com)  
  
Em todas as outras localidades:  
[https://okr-for-jira-prod.herokuapp.com](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

<span style="color: #36b37e">**POST **</span>`/api/v2/api-update/objectives`

| **Propriedade** | **Descrição** | **Obrigatório** |
| --- | --- | --- |
| `objectiveId` | Id do objetivo a ser atualizado. | :check_mark: |
| `status` | Novo estado do objetivo. Status permitidos:  
`NOT STARTED`, `ON TRACK`, `AT RISK`, `OFF TRACK` | ❎ |
| `description` | Uma descrição para aparecer na atualização criada. | ❎ |

Exemplo de solicitação:

<span style="color: #36b37e">**POST **</span>`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"
}
```

<details>
<summary>curl</summary>

```

```
</details>

<details>
<summary>Exemplo de resposta</summary>

```

```
</details>

 

### Atualizar key result

Criar atualização para o key result especificado.

<span style="color: #36b37e">**POST **</span>`/api/v2/api-update/keyResults`

| **Propriedade** | **Descrição** | **Obrigatório** |
| --- | --- | --- |
| `keyResultId` | Id do key result que será atualizado. | :check_mark: |
| `status` | Novo estado do key result. Status permitidos:  
`NOT STARTED`, `ON TRACK`, `AT RISK`, `OFF TRACK` | ❎ |
| `newValue` | Valor do progresso para definir na atualização.  
Não pode ser definido para key results automáticos, pois seus valores vêm de consulta JQL.  
Caso a unidade do progresso do KR seja moeda, o valor ainda deve ser um número, sem o símbolo de moeda. | ❎ |
| `description` | Uma descrição para aparecer na atualização criada. | ❎ |

Exemplo de solicitação:

<span style="color: #36b37e">**POST **</span>`https://okr-for-jira-prod.herokuapp.com/api/v2/api-update/keyResults`

Corpo da solicitação:

```
{
  "keyResultId": "62384a6942adda046598b3bd",
  "status" : "AT RISK",
  "newValue" : 13500.5,
  "description" : "Reduction in ship hull output is caused by Unobtainium supply disruptions."
}
```

<details>
<summary>curl</summary>

```

```
</details>

<details>
<summary>Exemplo de resposta</summary>

```
{
	"entityId": "62384a6942adda046598b3bd",
	"status": "AT RISK",
	"created": "2022-05-20T13:01:35+0000",
	"value": 13500.5,
	"description": "Reduction in ship hull output is caused by Unobtainium supply disruptions."
}
```
</details>