Skip to main content

PATCH Definir Modalidade de Procedimentos

Grava a mesma modalidade DICOM (ou null, para limpar) em vários procedimentos de uma vez. Só afeta procedimentos da própria conta e não excluídos; ids que não casam são ignorados, sem erro.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige a permissão update_procedures.


Endpoint​

PATCH https://api-dev.imagemais.com.br/api/procedures/modality

Corpo da Requisição​

CampoTipoObrigatórioValores válidosDescrição
procedureIdsnumber[]✅lista não vazia de inteirosIDs dos procedimentos
modalitystring | null✅CT, MR, US, CR, DX, MG, NM, PT, XA, RF, OT, ECG, ES, IO, RTIMAGE, RTDOSE, RTSTRUCT ou nullModalidade DICOM. null remove a modalidade

Requisição​

curl -X 'PATCH' \
'https://api-dev.imagemais.com.br/api/procedures/modality' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}' \
-H 'Content-Type: application/json' \
-d '{
"procedureIds": [
42,
43
],
"modality": "US"
}'

Respostas​

200 Sucesso​

{
"data": {
"count": 2
}
}

count é o número de procedimentos efetivamente atualizados.

400 Requisição inválida​

Retornado quando o corpo ou a query não passam na validação. A lista message traz um item por regra violada, por exemplo:

{
"message": [
"procedureIds should not be empty",
"modality must be one of the following values: CT, MR, US, CR, DX, MG, NM, PT, XA, RF, OT, ECG, ES, IO, RTIMAGE, RTDOSE, RTSTRUCT"
],
"error": "Bad Request",
"statusCode": 400
}

403 Sem permissão​

{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}