4 Annotation Pane Configuration

This section describes how to configure the annotation pane using REST APIs. It contains the following sections:

Section 4.1, "GET Annotation Pane Configuration"
Section 4.2, "UPDATE Annotation Pane Configuration"

4.1 GET Annotation Pane Configuration

Gets all the annotation pane UI details as JSON.

PATH	<server url>/trc/opmconfigapi/v1.0/config/annotationPane
ACCEPTS	application/json
RETURNS	application/json
METHOD	GET

Response

Code	Reason	Representation (Example)
200	success

Example

{
    "eltWid": 1,
    "type": "PANE",
    "level": 0,
    "displayOrder": 0,
    "label": "Annotation",
    "items": [{
        "eltWid": 2,
        "type": "INPUT",
        "level": 1,
        "displayOrder": 0,
        "label": "Significance",
        "data_type": "ENUM",
        "attr_wid": 57,
        "data_key": "significance",
        "options": {
            "multiple": false,
            "read_only": false,
            "display": true,
            "allow_custom": false
        },
        "values": [{
            "wid": 2,
            "label": "Likely Benign",
            "value": 2,
            "displayOrder": 3
        }, {
            "wid": 1,
            "label": "Unknown Significance",
            "value": 1,
            "displayOrder": 4
        }]
    }, {
        "eltWid": 3,
        "type": "INPUT",
        "level": 1,
        "displayOrder": 1,
        "label": "Associated Diagnosis",
        "data_type": "LOOKUP",
        "attr_wid": 71,
        "data_key": "var_associated_diseases",
        "data_url": "diagnoses",
        "options": {
            "multiple": true,
            "read_only": false,
            "display": true,
            "allow_custom": true
        }
    }]
}

4.2 UPDATE Annotation Pane Configuration

This updates the label, display (True or False) and Display Order on the Annotation pane. The user has to be admin role of pm_admin_group.

Note:

While updating, make sure the display order is correct. This value cannot be duplicated for all siblings.

PATH	<server url>/trc/opmconfigapi/v1.0/config/annotationPane/changed
ACCEPTS	application/json
RETURNS	application/json
METHOD	PUT

Request

PARAMETER	DESCRIPTION	PARAMETER TYPE	DATA TYPE/ REPRESENTATION
body		body	[{ "etlWid":Number, "label":String, "display" : String, "displayOrder" : String }]

Example

[{
    "eltWid": 2,
    "label": "Significance",
    "display": true,
    "displayOrder": 0
}, {
    "eltWid": 3,
    "label": "Associated Diagnosis",
    "display": true,
    "displayOrder": 1
}]

Response

Code	Reason	Representation (Example)
200	success