Converis Web Services (Read API)

{"openapi":"3.0.0","info":{"title":"Converis Web Services","description":"This API Specification describes how to read data from Converis in order to use it in other systems. Additionally, you can create, update, or delete users and its roles through the API calls. \n\n## Access and Credentials \nThis API reference is organized by resource type Data, Configuration and Administration. Each resource type has one or more endpoints. \n\nTo use these endpoints, an API authentication token needs to be issued by the Converis administrator from the configuration screen (Configuration --> API Authentication Info). \nThe table below specifies which type of endpoints require which ___type of service___ permission for the  Converis API authentication.\n\n| Type of endpoint | Type of service permission |\n| ---------------- | -------------------------- |\n| Data             | CONVERIS_DATA_SERVICE      |\n| Administration   | CONVERIS_ADMIN_SERVICE     |\n| Configuration    | CONVERIS_CONFIG_SERVICE    | \nThe generated API authentication token must then be provided per basic authentication with each request to the API (username = app name and password = generated token). \n\nThe URL needs to be adapted to the Converis instance’s specific domain. \n\nThe URL of API has the following pattern ___https://{host}:{port}/converis-apis/ws/v2/___ where *{host}* is the IP or the Hostname of your Converis installation. *{port}* must be provided only if it differs from 443. \n\n## Limits and Security\n- The API allows max. 10 requests per second.\n- All requests are secured through https (secure, TLS 1.2).\n","contact":{"email":"converis-info@clarivate.com"},"version":"2.0"},"servers":[{"url":"https://api.clarivate.com/converisreadapi"}],"tags":[{"name":"Data - Entity","description":"Get the entity data"},{"name":"Data - Link entity","description":"Get the links between entity data"},{"name":"Data - File","description":"Download files"},{"name":"Data - Tree","description":"Get the links between entity data"},{"name":"Administration - User data","description":"Perform User operations"},{"name":"Administration - User Delegations","description":"Perform User Delegation operations"},{"name":"Configuration - Entity definitions","description":"Get the configured entity definitions"},{"name":"Configuration - Link entity definitions","description":"Get the configured entity definitions"}],"paths":{"/admin/users/delegation":{"post":{"tags":["Administration - User Delegations"],"summary":"Create a User Delegation.","description":"Create a User Delegation.\n","requestBody":{"description":"Details of the Delegation to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDelegation"},"example":{"fromUser":{"userName":"fromUserName"},"toUser":{"userName":"toUserName"},"role":{"roleName":"Researcher","entryPointId":123124},"validity":{"startDate":"2022-10-10","endDate":"2022-10-12"}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":201,"statusDescription":"Created","message":"Delegation successfully created."}}}},"400":{"description":"This response is returned in case of errors with request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":400,"statusDescription":"Bad Request","message":"Error message."}}}},"401":{"description":"Request is unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":401,"statusDescription":"Unauthorized","message":"Full authentication is required to access this resource"}}}}},"security":[{"BasicAuth":[]}]},"put":{"tags":["Administration - User Delegations"],"summary":"Update a User Delegation.","description":"Update a User Delegation.\n","requestBody":{"description":"Update allowed to the date fields only.\n\nId of the delegation to be passed.\n\nValidity is a mandatory field.\n\nIf start date is not passed, it is considered as starting from today.\n\nIf end date is not passed, it is stored as null.\n\nPlease pass the same old value if the date value has not changed.\n","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDelegation"},"example":{"delegationId":1234,"validity":{"startDate":"2022-10-10","endDate":"2022-10-12"}}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":200,"statusDescription":"Ok","message":"Delegation successfully updated."}}}},"400":{"description":"This response is returned in case of errors with request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":400,"statusDescription":"Bad Request","message":"Error message."}}}},"401":{"description":"Request is unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":401,"statusDescription":"Unauthorized","message":"Full authentication is required to access this resource"}}}}},"security":[{"BasicAuth":[]}]},"get":{"tags":["Administration - User Delegations"],"summary":"Fetch User Delegations","description":"Get user delegations based on the input criteria.\n\nThe different combinations of input query parameters are as below. Any other input parameter combinations are not allowed.\n- delegationId fetches only that specific delegation.\n\n- fromUserName fetches delegations from this username.\n\n- fromUserName, entryPointId, roleName combination fetches delegations of this role and entrypoint by user fromUserName.\n\n- startDate fetches delegations that start on this date.\n\n- endDate fetches delegations that end on this date.\n\n- searchFromUser fetch the delegations where the username/firstname/lastname of the from user contains this string.\n  Maximum 2 search words are possible.\n- searchToUser fetch the delegations where the username/firstname/lastname of the to user contains this string.\n  Maximum 2 search words are possible.\n- startRecord and count fetch count number of delegations starting from the position of startRecord.\n  This can be combined with any other valid combination.\n- No query parameters, fetch all the delegations.\n","parameters":[{"name":"delegationId","in":"query","description":"Fetch only this delegation.\n\nThis parameter can be used only with startRecord and count\n","required":false,"style":"form","schema":{"type":"integer","example":123,"format":"int64"}},{"name":"fromUserName","in":"query","description":"Fetch delegations from the user whose loginname is fromUserName.\n\nIf parameters roleName and entryPointId are also passed, fetch delegations of role roleName with entrypoint entryPointId from the user fromUserName.\n\nThis parameter can be used with startRecord and count.\n\nIf provided, roleName and entryPointId both have to be provided.\n","required":false,"style":"form","schema":{"type":"string","example":"userLoginName"}},{"name":"entryPointId","in":"query","description":"Used in combination with fromUserName and roleName.\n\nFetch delegations of roleName and entryPointId by fromUserName.\n\nThis parameter can be used with startRecord and count.\n\nfromUserName and roleName are mandatory to be provided with this parameter.\n","required":false,"style":"form","schema":{"type":"integer","example":2345,"format":"int64"}},{"name":"roleName","in":"query","description":"Used in combination with fromUserName and entryPointId.\n\nFetch delegations of roleName and entryPointId by fromUserName.\n\nThis parameter can be used with startRecord and count.\n\nfromUserName and entryPointId are mandatory to be provided with this parameter.\n","required":false,"style":"form","schema":{"type":"string","example":"researcher"}},{"name":"startDate","in":"query","description":"Fetch delegations that start on this date.\n\nIn the format yyyy-MM-dd\n\nThis parameter can be used only with startRecord and count.\n","required":false,"style":"form","schema":{"type":"string","example":"2022-12-11T00:00:00.000Z","format":"date"}},{"name":"endDate","in":"query","description":"Fetch delegations that end on this date.\n\nIn the format yyyy-MM-dd\n\nThis parameter can be used only with startRecord and count.\n","required":false,"style":"form","schema":{"type":"string","example":"2022-12-13T00:00:00.000Z","format":"date"}},{"name":"startRecord","in":"query","description":"Starting record.\n\nDefaults to 1, the first record.\n","required":false,"style":"form","schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"Number of records to return.\n","required":false,"style":"form","schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"searchFromUser","in":"query","description":"Delegations where from user's login/first/last name contains this text are returned.\n\nA maximum of 2 search words are possible together and they are seperated by a space.\n\nThis parameter can be used only with startRecord and count.\n","required":false,"style":"form","schema":{"type":"string","example":"from"}},{"name":"searchToUser","in":"query","description":"Delegations where to user's login/first/last name contains this text are returned.\n\nA maximum of 2 search words are possible together and they are seperated by a space.\n\nThis parameter can be used only with startRecord and count.\n","required":false,"style":"form","schema":{"type":"string","example":"to"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDelegationList"}}}},"400":{"description":"This response is returned in case of errors with request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":400,"statusDescription":"Bad Request","message":"Error message."}}}},"401":{"description":"Request is unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation","status":401,"statusDescription":"Unauthorized","message":"Full authentication is required to access this resource"}}}}},"security":[{"BasicAuth":[]}]}},"/admin/users/delegation{delegation_id}":{"delete":{"tags":["Administration - User Delegations"],"summary":"Delete a User Delegation.","description":"Delete a User Delegation.\n\nId of the delegation to be passed.\n\nID should be valid.\n","parameters":[{"name":"delegation_id","in":"path","description":"Id of the delegation to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation/{delegation_id}","status":200,"statusDescription":"Ok","message":"Delegation successfully Deleted."}}}},"400":{"description":"This response is returned in case of errors with request data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation/{delegation_id}","status":400,"statusDescription":"Bad Request","message":"Error message."}}}},"401":{"description":"Request is unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/delegation/{delegation_id}","status":401,"statusDescription":"Unauthorized","message":"Full authentication is required to access this resource"}}}}},"security":[{"BasicAuth":[]}]}},"/admin/users":{"get":{"tags":["Administration - User data"],"summary":"Get all users","description":"Get all users of your Converis or users with only specific ___role___\n","parameters":[{"name":"role","in":"query","description":"Filter users only with specific role. Select all roles if null.","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"Researcher"}},{"name":"type","in":"query","description":"Filter users based on their type:\n * ___INTERNAL___ - Converis users that login directly in Converis\n * ___EXTERNAL___ - Login server users that login in Converis through SSO, e.g. Shibboleth\n * ___ALL___ - No filter, i.e. the response contains internal and external users.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ALL","enum":["INTERNAL","EXTERNAL","ALL"]}},{"name":"startRecord","in":"query","description":"Starting record.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"Number of records to return.","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserList"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]},"post":{"tags":["Administration - User data"],"summary":"Create user","description":"Create a Converis user with roles. An email will be sent to the INTERNAL users with the autogenerated password.\n","requestBody":{"description":"A user to be created","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"userName":"first.last","firstName":"First","lastName":"Last","email":"first.last@example-university.edu","firstLogin":true,"preferredLanguage":"en_GB","active":true,"acceptedTC":false,"userType":"INTERNAL","roles":[{"roleName":"Researcher","entryPointId":123124324}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users","status":201,"statusDescription":"Created","message":"User first.last successfully created."}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/admin/users/{username}":{"get":{"tags":["Administration - User data"],"summary":"Get information of a specific user","description":"Get information of a specific user by ___username___\n","parameters":[{"name":"username","in":"path","description":"the username which is used to login in Converis","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]},"put":{"tags":["Administration - User data"],"summary":"Update user","description":"Update a specific user by ___username___. If roles are not provided in request body, then they remain unchanged, otherwise they will be overwritten.\nPlease note that username can't be changed and is not allowed in request body\n","parameters":[{"name":"username","in":"path","description":"the username which is used to login in Converis","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"description":"A user to be updated. If roles are not provided in request body, then they remain unchanged, otherwise they will be overwritten.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"example":{"firstName":"First","lastName":"Last","email":"first.last@example-university.edu","firstLogin":true,"preferredLanguage":"en_GB","active":true,"acceptedTC":false,"userType":"INTERNAL","roles":[{"roleName":"Researcher","entryPointId":123124324}]}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/first.last","status":200,"statusDescription":"Ok","message":"User first.last successfully updated."}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]},"delete":{"tags":["Administration - User data"],"summary":"Delete user","description":"Delete a specific user and its roles by ___username___.\n","parameters":[{"name":"username","in":"path","description":"The username that is used to login in Converis. A user can be internal or external user, i.e. logged in through SSO, e.g. Shibboleth","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"},"example":{"timestamp":"2017-07-21T17:32:28Z","path":"/converis-apis/ws/v2/admin/users/first.last","status":200,"statusDescription":"Ok","message":"User first.last successfully deleted."}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/config/entities":{"get":{"tags":["Configuration - Entity definitions"],"summary":"Get definition of all entities","description":"Get definition of all entities. Additionally, you can\n\n  * specify language of labels through the query parameter ___language___\n  * include (excluded by default) linkentity reference API path through HTTP header ___Converis-linkentity-references___. The information about link entities can be requested through the responded paths.\n  * include (excluded by default) all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___\n","parameters":[{"name":"startRecord","in":"query","description":"Starting record.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"Number of records to return.","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"language","in":"query","description":"Return only labels or data for specific language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"en_GB"}},{"name":"Converis-linkentity-references","in":"header","description":"Set true if link entity references (href) should be returned.","required":false,"style":"simple","explode":false,"schema":{"type":"boolean","default":false}},{"name":"Converis-attribute-definition","in":"header","description":"Choose ALL to display all attributes","required":false,"style":"simple","explode":false,"schema":{"type":"string","default":"NONE","enum":["NONE","ALL"]}}],"responses":{"200":{"description":"Successfull response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDefinitionList"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/config/entities/{type}":{"get":{"tags":["Configuration - Entity definitions"],"summary":"Get definition of an entity","description":"Get definition of an entities by ___type___ name. Additionally, you can\n\n  * specify language of labels through the query parameter ___language___\n  * include (excluded by default) linkentity reference API path through HTTP header ___Converis-linkentity-references___. The information about link entities can be requested through the responded paths.\n  * include (excluded by default) specific or all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___\n","parameters":[{"name":"type","in":"path","description":"entity type name","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Return only labels or data for specific language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Converis-linkentity-references","in":"header","description":"Set true if link entity references (href) should be returned.","required":false,"style":"simple","explode":false,"schema":{"type":"boolean","example":false,"default":false}},{"name":"Converis-attribute-definition","in":"header","description":"Choose ALL to display all attributes","required":false,"style":"simple","explode":false,"schema":{"type":"string","default":"NONE","enum":["NONE","ALL"]}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityDefinition"}}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/config/linkentities":{"get":{"tags":["Configuration - Link entity definitions"],"summary":"Get definition of all entities","description":"Get definition of all link entities. Additionally, you can\n\n  * specify language of labels through the query parameter ___language___\n  * include (excluded by default) all attributes definitions of the link entity through HTTP Header ___Converis-attribute-definition___\n","parameters":[{"name":"startRecord","in":"query","description":"Starting record.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"Number of records to return.","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"language","in":"query","description":"Return only labels or data for specific language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"en_GB"}},{"name":"Converis-attribute-definition","in":"header","description":"Choose ALL to display all attributes","required":false,"style":"simple","explode":false,"schema":{"type":"string","default":"NONE","enum":["NONE","ALL"]}}],"responses":{"200":{"description":"Successfull response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkEntityDefinitionList"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/config/linkentities/{link_type}":{"get":{"tags":["Configuration - Link entity definitions"],"summary":"Get  definition of a link entity","description":"Get definition of a link entity by ___link_type___ name. Additionally, you can\n\n  * specify language of labels through the query parameter ___language___\n  * include (excluded by default) specific or all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___\n","parameters":[{"name":"link_type","in":"path","description":"link entity type name","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"language","in":"query","description":"Return only labels or data for specific language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"Converis-attribute-definition","in":"header","description":"Choose ALL to display all attributes","required":false,"style":"simple","explode":false,"schema":{"type":"string","default":"NONE","enum":["NONE","ALL"]}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkEntityDefinition"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/data/entities/{type}":{"get":{"tags":["Data - Entity"],"summary":"Get all data of an entity","description":"Get all data of an entity by ___type___ name. Additionally, you can\n\n  * specify language of attribute values through the query parameter ___language___\n  * include (excluded by default) linkentity reference API path through HTTP header ___Converis-linkentity-references___. The information about link entities can be requested through the responded paths.\n  * include (only basic attributes by default) specific or all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___\n\nThis endpoint doesn't require authentication for public data\n","parameters":[{"name":"type","in":"path","description":"the entity type name","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"Publication"}},{"name":"startRecord","in":"query","description":"Starting record.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"maximum number of records to return","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sort","in":"query","description":"Sort by attributes of the entity. __Currently only BASIC attributes are supported__.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"Updated on"}},{"name":"sortOrder","in":"query","description":"Sort order:\n * ___ASC___ - Ascending, from A to Z\n * ___DESC___ - Descending, from Z to A\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ASC","enum":["ASC","DESC"]}},{"name":"language","in":"query","description":"Return only labels or attribute data of specific configured language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"en_GB"}},{"name":"Converis-attribute-definition","in":"header","description":"The CSV list of attributes to be returned. Possible values BASIC, ALL, csv list of attributes comma separated\n\nBASIC includes\n  * Created by\n  * Created on\n  * Updated by\n  * Updated on\n  * Status\n  * Short description\n  * Public visible\n  * Left sequence (only for link entitites)\n  * Right sequence (only for link entities)\n","required":false,"style":"simple","explode":false,"schema":{"default":"BASIC","example":"publYear,srcAuthors","oneOf":[{"type":"string","default":"BASIC","enum":["BASIC","ALL"]},{"type":"string","example":"publYear, srcAuthors"}]}},{"name":"Converis-linkentity-references","in":"header","description":"Set true if link entity references (href) should be returned.","required":false,"style":"simple","explode":false,"schema":{"type":"boolean","example":false,"default":false}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDataList"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/data/entities/{type}/query":{"post":{"tags":["Data - Entity"],"summary":"Get all data of an entity filtered by query.","description":"Get all data of an entity by ___type___ name and query. Additionally, you can\n\n  * specify language of attribute values through the query parameter ___language___\n  * include (excluded by default) linkentity reference API path through HTTP header ___Converis-linkentity-references___. The information about link entities can be requested through the responded paths.\n  * include (only basic attributes by default) specific or all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___\n\nThis endpoint requires authentication\n","parameters":[{"name":"type","in":"path","description":"the entity type name","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"Publication"}},{"name":"startRecord","in":"query","description":"Starting record.","required":false,"style":"form","explode":true,"schema":{"minimum":1,"type":"integer","format":"int32","default":1}},{"name":"count","in":"query","description":"maximum number of records to return","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"sort","in":"query","description":"Sort by attributes of the entity. __Currently only BASIC attributes are supported__.","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"Updated on"}},{"name":"sortOrder","in":"query","description":"Sort order:\n * ___ASC___ - Ascending, from A to Z\n * ___DESC___ - Descending, from Z to A\n","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ASC","enum":["ASC","DESC"]}},{"name":"language","in":"query","description":"Return only labels or attribute data of specific configured language. Display all configured languages if null, eg. en_GB","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"en_GB"}},{"name":"Converis-attribute-definition","in":"header","description":"The CSV list of attributes to be returned. Possible values BASIC, ALL, csv list of attributes comma separated\n\nBASIC includes\n  * Created by\n  * Created on\n  * Updated by\n  * Updated on\n  * Status\n  * Short description\n  * Public visible\n  * Left sequence (only for link entitites)\n  * Right sequence (only for link entities)\n","required":false,"style":"simple","explode":false,"schema":{"default":"BASIC","example":"publYear,srcAuthors","oneOf":[{"type":"string","default":"BASIC","enum":["BASIC","ALL"]},{"type":"string","example":"publYear, srcAuthors"}]}},{"name":"Converis-linkentity-references","in":"header","description":"Set true if link entity references (href) should be returned.","required":false,"style":"simple","explode":false,"schema":{"type":"boolean","example":false,"default":false}}],"requestBody":{"description":"Content of the filter query.","required":true,"content":{"application/vnd.converis.ql+plain; charset=utf-8":{"schema":{"type":"string","example":"-- POST /converis-apis/data/entities/Publication/query\n-- we assume that Publication has an attribute named openAccess of type BOOLEAN\nopenAccess = true AND [publication type] = \"Journal Article\"\n"}}}},"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityDataList"}}}},"default":{"description":"Error response 400+","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultResponse"}}}}},"security":[{"BasicAuth":[]}]}},"/data/entities/{type}/{id}":{"get":{"tags":["Data - Entity"],"summary":"Get an entity data object","description":"\nGet one entity object by ___type___ name and by ___id___. Additionally, you can\n\n  * specify language of attribute values through the query parameter ___language___\n  * include (excluded by default) linkentity reference API path through HTTP header ___Converis-linkentity-references___. The information about link entities can be requested through the responded paths.\n  * include (only basic attributes by default) specific or all attributes definitions of the entity through HTTP Header ___Converis-attribute-definition___.\n\nThis endpoint doesn't require authentication for public data.\

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clarivate/refs/heads/main/openapi/clarivate-converisreadapi-openapi.json