Referência da APIInstrumentos
Obter instrumento
GET
/forms/{formId}Retorna um instrumento com questões, opções, subescalas e faixas de interpretação.
Com format=pdf, retorna o instrumento em PDF.
Autorização
ApiKey ApiSecret X-Api-Key<token>
API Key do parceiro. Deve ser enviada junto com X-Api-Secret.
Em: header
X-Api-Secret<token>
API Secret do parceiro. Deve ser enviada junto com X-Api-Key.
Em: header
Parâmetros de path
formId*string
ID do instrumento.
Formato
uuidParâmetros de query
format?string
Use pdf para receber o instrumento em PDF. Qualquer outro valor retorna JSON.
Corpo da resposta
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/forms/b1e7d9c2-4f3a-4d8e-9c1b-7a2e5f0d6c88"{ "averageScore": 0, "config": { "globalScoreConfig": { "calculateGlobalScore": true, "calculationMethod": "SUM", "scoreDirection": "HIGHER_WORSE", "source": "QUESTIONS" } }, "createdAt": "2019-08-24T14:15:22Z", "description": "string", "developerReferences": "string", "formattedTitle": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instruction": "string", "instrumentType": "STANDARDIZED_SCALE", "isNew": true, "isPublic": true, "isScorable": true, "metadata": { "publishedAt": "2019-08-24T14:15:22Z" }, "patientInstruction": "string", "questions": [ { "centerEmoji": "string", "centerLabel": "string", "code": "string", "createdAt": "2019-08-24T14:15:22Z", "formSubScaleId": 0, "hasWeight": true, "id": 0, "leftEmoji": "string", "leftLabel": "string", "pointAnchors": [ { "emoji": "string", "label": "string", "value": 0 } ], "position": 0, "questionOptions": [ { "createdAt": "2019-08-24T14:15:22Z", "emoji": "string", "id": 0, "isOther": true, "position": 0, "updatedAt": "2019-08-24T14:15:22Z", "value": "string", "weight": 0 } ], "questionType": "MULTIPLE_CHOICE", "rightEmoji": "string", "rightLabel": "string", "scaleEnd": 0, "scaleStart": 0, "scaleStep": 0, "subScaleIds": [ 0 ], "title": "string", "updatedAt": "2019-08-24T14:15:22Z", "visibilityCondition": { "operator": "OPTION_SELECTED", "optionValue": "string", "sourceQuestionId": 0, "sourceQuestionPosition": 0, "threshold": 0 } } ], "references": "string", "scoreRanges": [ { "color": "string", "createdAt": "2019-08-24T14:15:22Z", "formSubScaleId": 0, "formTemplateId": "f62b9cf2-5cec-4a00-b364-0e5e6e71cce0", "id": 0, "maxScore": 0, "minScore": 0, "title": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "sections": [ { "createdAt": "2019-08-24T14:15:22Z", "description": "string", "id": 0, "position": 0, "title": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "shortTitle": "string", "status": "DRAFT", "subScales": [ { "calculationMethod": "SUM", "childSubScaleIds": [ 0 ], "code": "string", "createdAt": "2019-08-24T14:15:22Z", "id": 0, "name": "string", "scoreDirection": "HIGHER_WORSE", "scoreRanges": [ { "color": "string", "createdAt": "2019-08-24T14:15:22Z", "formSubScaleId": 0, "formTemplateId": "f62b9cf2-5cec-4a00-b364-0e5e6e71cce0", "id": 0, "maxScore": 0, "minScore": 0, "title": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "source": "QUESTIONS", "updatedAt": "2019-08-24T14:15:22Z" } ], "tags": [ { "createdAt": "2019-08-24T14:15:22Z", "id": 0, "name": "string", "updatedAt": "2019-08-24T14:15:22Z" } ], "title": "string", "updatedAt": "2019-08-24T14:15:22Z"}