/query/mostCommonDisnetConcepts

  • Description

    Retrieve most common DISNET Concepts for a given source and snapshot. Excludes or forcing semantic types, it adds an option to show or not the codes associated with the disease and finally allowed retrieve that DISNET Concepts that were filtered by our TVP procedure.

  • URL (PATH)

    /query/mostCommonDisnetConcepts?source=:source&version=:version&validated=:validated&limit=:limit&excludeSemanticTypes=:excludeSemanticTypes&forceSemanticTypes=:forceSemanticTypes&token=:token

  • Method

    GET

  • Auth required

    Yes (token)

  • Request parameters
    Parameter Description
    source *required
    [alphanumeric]
    example: source=wikipedia
    Name of the information source.
    version *required
    [alphanumeric with format “aaaa-mm-dd”]
    example: token=eyJhbGciOiJI...
    Date of information source extraction, in "yyyy-mm-dd" format.
    validated
    [boolean] by default always is true
    example: validated=false
    Show DISNET Concepts filtered by our TVP process.
    limit
    [integer] by default always is 10
    example: limit=2
    Show DISNET Concepts filtered by our TVP process.
    excludeSemanticTypes
    [alphanumeric]
    example: excludeSemanticTypes=dsyn,sosy
    Excludes the semantic type or types defined. If there are more than one, they are separated by commas (,).
    forceSemanticTypes
    [alphanumeric]
    example: forceSemanticTypes=dsyn,sosy
    It forces the semantic type or types defined. If there are more than one, they are separated by commas (,).
    token *required
    [alphanumeric]
    example: token=eyJhbGciOiJI...
    Access key that allows the query to be executed.
  • Important

    A correct request can only be made if the excludeSemanticTypes=true parameter and the forceSemanticTypes=false parameter are used, both cannot have the true value.

  • Example request
                                         
                                             GET http://disnet.ctb.upm.es/api/disnet/query/mostCommonDisnetConcepts?source=wikipedia&version=2018-09-15&limit=3&validated=&excludeSemanticTypes=&forceSemanticTypes=dsyn&token=eyJhbGciOiJI...
                                         
                                    
  • Success response (application/json)
                                        
                                            {
                                                "token": "eyJhbGciOiJI...",
                                                "authorized": true,
                                                "authorizationMessage": "Authorized!",
                                                "responseCode": "200",
                                                "responseMessage": "OK",
                                                "errorsFound": [],
                                                "disnetConceptsCount": 3,
                                                "disnetConcepts": [
                                                    {
                                                        "cui": "C0162429",
                                                        "name": "Malnutrition",
                                                        "common": 760,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    },
                                                    {
                                                        "cui": "C0011849",
                                                        "name": "Diabetes mellitus, NOS",
                                                        "common": 467,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    },
                                                    {
                                                        "cui": "C0038454",
                                                        "name": "Cerebrovascular accident",
                                                        "common": 382,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    }
                                                ]
                                            }
                                        
                                    
  • Error response (application/json)