/query/lessCommonDisnetConcepts

  • Description

    Retrieve the least common DISNET Concepts for a given source and snapshot. It is possible to exclude or force certain semantic types, Optionally, it can be shown: the codes associated with the disease, and the number of times a DISNET Concept has been found in the disease's texts. Finally, there is also the possibility to only retrieve the DISNET Concepts that have been filtered with our TVP procedure.

  • URL (PATH)

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

  • Method

    GET

  • Auth required

    Optional (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: version=2018-09-15
    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
    [alphanumeric]
    example: token=eyJhbGciOiJI...
    Optional access key to save the current query inside the user's profile
  • Important

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

  • Example request
                                         
                                             GET http://disnet.ctb.upm.es/api/disnet/query/lessCommonDisnetConcepts?source=wikipedia&version=2018-09-15&limit=3&validated=&excludeSemanticTypes=&forceSemanticTypes=dsyn&token=
                                         
                                    
  • Success response (application/json)
                                        
                                            {
                                                                                        "token": null,
                                                "authorized": false,
                                                "authorizationMessage": null,
                                                "responseCode": "200",
                                                "responseMessage": "OK",
                                                "errorsFound": [],
                                                "disnetConceptsCount": 3,
                                                "disnetConcepts": [
                                                    {
                                                        "cui": "C0455990",
                                                        "name": "Immune hydrops fetalis",
                                                        "common": 1,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    },
                                                    {
                                                        "cui": "C0013608",
                                                        "name": "Cardiac edema",
                                                        "common": 1,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    },
                                                    {
                                                        "cui": "C0015938",
                                                        "name": "Fetal macrosomia",
                                                        "common": 1,
                                                        "semanticTypes": [
                                                            "dsyn"
                                                        ]
                                                    }
                                                ]
                                            }
                                        
                                    
  • Error response (application/json)