REST API¶
- GET /info¶
Get common API metadata
Returns the general metadata as one JSON object.
- Status Codes
200 OK – Successful Response
- GET /info/title¶
The title of the API
Returns the title of the API as
plain/text- Status Codes
200 OK – Successful Response
- GET /info/version¶
The version of the API
Returns the version of the API as
plain/text- Status Codes
200 OK – Successful Response
- GET /info/description¶
The description of the API
Returns the version of the API as
plain/markdown- Status Codes
200 OK – Successful Response
- GET /info/contact¶
Get the contact information of the API author(s).
Returns the general metadata as one JSON object.
- Status Codes
200 OK – Successful Response
- GET /info/contact/name¶
Providing the name of the team or author
Returns the name of responsible author(s) as
plain/text- Status Codes
200 OK – Successful Response
- GET /info/contact/url¶
The public website of the author(s)
Returns the public website of the author(s) as
plain/text- Status Codes
200 OK – Successful Response
- GET /info/contact/email¶
An email address to contact the author(s) of the API
Returns an email address to contact the author(s) of the API as
plain/markdown- Status Codes
200 OK – Successful Response
- GET /info/x-changelog¶
Get Api Meta Changelog Json
This endpoint only exists to be able to allow content negotiation further down and allow to reference it
- Status Codes
200 OK – Successful Response
- GET /info/x-changelog/release¶
Query releases by version and release date
Returns the matching releases specified by:
version_lower_limit<= Version of the release <=version_upper_limitdate_lower_limit<= Date of the release <=date_upper_limitlimitamount of wanted releases.
as
plain/markdown.Any of the query parameters are optional to give you full flexibility to query for certain releases.
- Request Headers
accept (string) –
- Query Parameters
version_lower_limit (string) – Version specification according to Semantic Versioning 2.0.0
version_upper_limit (string) –
Version specification according to Semantic Versioning 2.0.0
date_lower_limit (string) – Timestamp according to ISO 8601.
date_upper_limit (string) –
Timestamp according to ISO 8601.
limit (integer) – To return
nlast releases matching the query parameters
- Status Codes
200 OK –
Release notes of all releases matching the query
HTTP/1.1 200 OK Content-Type: text/markdown string
version_lower_limitorversion_upper_limitare not according to Semantic Versioning 2.0.0
`OR:raw-html-md:`
```date_lower_limit` ordate_upper_limitare not according to ISO 8601
`OR:raw-html-md:`
```limit` was not a number >= 0422 Unprocessable Entity – Validation Error
- GET /info/x-changelog/release/{version}¶
Get release notes for a specific version
Returns the release note matching the wanted
versioninplain/markdownorapplication/jsondepending on theAcceptheader..- Request Headers
accept (string) –
- Parameters
version (string, required) –
- Status Codes
200 OK –
The release notes of the requested version
HTTP/1.1 200 OK Content-Type: text/markdown string
400 Bad Request – The given version was of wrong format. Expected Semantic Versioning 2.0.0 - semver.org
404 Not Found – The requested version did not match any existing released versions.
422 Unprocessable Entity – Validation Error
- GET /info/x-api-id¶
Return static content: api-id
Generic endpoint to serve the
api-idinformation.- Status Codes
200 OK – Successful Response
- GET /info/x-datacatalogue-release¶
Return static content: datacatalogue-release
Generic endpoint to serve the
datacatalogue-releaseinformation.- Status Codes
200 OK – Successful Response
- GET /info/x-build-info¶
Return static content: build-info
Generic endpoint to serve the
build-infoinformation.- Status Codes
200 OK – Successful Response
- GET /catalogue/search¶
Search for data elements by metadata
Get search item by specified parameters. Any parameter can be omitted. Specifying multiple parameters will narrow down the search, so that the item has to match all specified parameters.
name: The substring which shall be used to match the name, alias name or description of the item.
locations: The substring to match by location. Use
"__root__"to filter for items that are not attached to a location.informationKind: Information kinds to filter items by (exact match required).
When passed an empty string, no filtration is applied. Use special value
%00to select items with no InformationKind set.- description_missing: if True, search will include only items without
description, if False, will include only items with description
- description_missing_code: str code of locale to check
description_missing only for specified language.
- description_missing_code: str code of locale to check
- unit_missing: if True, search will include only items without unit,
if False, will include only items with unit
- location_missing: if True, search will include only items without location,
if False, will include only items with location
- plausible_range_missing: if True, search will include only items
without plausible_range, if False, will include only items with plausible_range
Additional details on the search values:
You may use
*as wildcard within the substringsYou may conduct a literal search (matching the exact specified string) by enclosing your search keyword into single or double quotes.
When you filter by missing unit, description, location, range or info_kind, those params work inclusively. So, if you set missing unit and range, you will have items if they miss at least one of attributes.
- Query Parameters
parent_item_name (string) –
name (string) –
locations (array) –
- Defines a list of locations to filter items by.
If the query parameter is omitted, no filtering is applied.
informationKind (array) –
- Defines a list of information kinds to filter items by
(exact match required). If the query parameter is omitted, no filtering is applied. To filter for items with no information kind set, pass a
null-byte(%00), an empty string, or__unset__.
technologies (array) –
- Defines a list of technologies to filter items by.
If the query parameter is omitted, no filtering is applied.
units (array) –
- Defines a list of units to filter items by.
If the query parameter is omitted, no filtering is applied.
physical_quantities (array) –
- Defines a list of physical quantities to filter items by.
If the query parameter is omitted, no filtering is applied.
location_missing (boolean) –
description_missing (boolean) –
description_missing_code (string) –
unit_missing (boolean) –
plausible_range_missing (boolean) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /catalogue/search/locationTree¶
Conducts a search and returns a tree structure based on the location. To get the actual items for each node a additional search needs to be triggered.
Conducts a full search (for documentation check
/catalogue/searchendpoint) and builds a tree structure based on location from the results.- Query Parameters
include_locations_without_items (boolean) –
name (string) –
locations (array) –
- Defines a list of locations to filter items by.
If the query parameter is omitted, no filtering is applied.
informationKind (array) –
- Defines a list of information kinds to filter items by
(exact match required). If the query parameter is omitted, no filtering is applied. To filter for items with no information kind set, pass a
null-byte(%00), an empty string, or__unset__.
technologies (array) –
- Defines a list of technologies to filter items by.
If the query parameter is omitted, no filtering is applied.
units (array) –
- Defines a list of units to filter items by.
If the query parameter is omitted, no filtering is applied.
physical_quantities (array) –
- Defines a list of physical quantities to filter items by.
If the query parameter is omitted, no filtering is applied.
location_missing (boolean) –
description_missing (boolean) –
description_missing_code (string) –
unit_missing (boolean) –
plausible_range_missing (boolean) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /catalogue/search/itemTreeRoots¶
Get items in a tree-like structure. Use to show items in the location tree
Conducts a full search (for documentation check
/catalogue/searchendpoint) and builds a tree structure based on relations of items found in search.- Query Parameters
name (string) –
locations (array) –
- Defines a list of locations to filter items by.
If the query parameter is omitted, no filtering is applied.
informationKind (array) –
- Defines a list of information kinds to filter items by
(exact match required). If the query parameter is omitted, no filtering is applied. To filter for items with no information kind set, pass a
null-byte(%00), an empty string, or__unset__.
technologies (array) –
- Defines a list of technologies to filter items by.
If the query parameter is omitted, no filtering is applied.
units (array) –
- Defines a list of units to filter items by.
If the query parameter is omitted, no filtering is applied.
physical_quantities (array) –
- Defines a list of physical quantities to filter items by.
If the query parameter is omitted, no filtering is applied.
location_missing (boolean) –
description_missing (boolean) –
description_missing_code (string) –
unit_missing (boolean) –
plausible_range_missing (boolean) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /catalogue/autocomplete/{category}¶
Fetch suggestions for several metadata categories
Get autocompletion results for a category. If category doesn’t exist, raises 404.
category: category to autocomplete
substring: The substring which shall be used to filter the suggestion. Use ‘%’ as wildcard and omit to get a full list of all available items.
- Parameters
category (required) –
- Query Parameters
substring (string) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – The requested
categoryis not supported or the query parameter are of wrong type.
- PUT /catalogue/file¶
Upload metadata file to the server.
Uploads metadata file to the server.
parse_options is json string with following default values:
{ "valueSeparator": ",", "nullValueText": "", "quoteChar": "\"", "escapeChar": "\\", "firstRowIsHeader": true, "firstColumnIsHeader": false, "characterEncoding": "utf-8" }
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – File can’t be parsed with provided options.
- PUT /catalogue/file/columnMatch¶
Import metadata from file stored on server.
Imports metadata from uploaded file
- Status Codes
200 OK – Successful Response
202 Accepted – Import initiated, but not finished yet.
422 Unprocessable Entity – Import failed.
404 Not Found – Item not found.
- GET /catalogue/exportToken¶
Returns special token to export data
Get special token to export data
- Status Codes
200 OK – Successful Response
- GET /catalogue/export¶
Returns an export of the catalogues as csv file
Get search item by specified parameters. Any parameter can be omitted. Specifying multiple parameters will narrow down the search, so that the item has to match all specified parameters.
This endpoint is protected by export_token. Use
GET /catalogue/export_tokenendpoint to get token.name: The substring which shall be used to match the name, alias name or description of the item.
locations: The substring to match by location. Use
"__root__"to filter for items that are not attached to a location.informationKind: Information kinds to filter items by (exact match required).
When passed an empty string, no filtration is applied. Use special value
%00to select items with no InformationKind set.Additional details on the search values:
You may use
*as wildcard within the substringsYou may conduct a literal search (matching the exact specified string) by enclosing your search keyword into single or double quotes.
- Query Parameters
export_token (string, required) –
name (string) –
locations (array) –
- Defines a list of locations to filter items by.
If the query parameter is omitted, no filtering is applied.
informationKind (array) –
- Defines a list of information kinds to filter items by
(exact match required). If the query parameter is omitted, no filtering is applied. To filter for items with no information kind set, pass a
null-byte(%00), an empty string, or__unset__.
technologies (array) –
- Defines a list of technologies to filter items by.
If the query parameter is omitted, no filtering is applied.
units (array) –
- Defines a list of units to filter items by.
If the query parameter is omitted, no filtering is applied.
physical_quantities (array) –
- Defines a list of physical quantities to filter items by.
If the query parameter is omitted, no filtering is applied.
location_missing (boolean) –
description_missing (boolean) –
description_missing_code (string) –
unit_missing (boolean) –
plausible_range_missing (boolean) –
- Status Codes
200 OK – Successful Response
403 Forbidden – Export token is not valid.
422 Unprocessable Entity – Validation Error
- GET /catalogue/statistic¶
Get metadata statistic
Get metadata statistic. Returns total number of items and number of non-missing values in some categories.
- Status Codes
200 OK – Successful Response
403 Forbidden – This feature is not enabled on this installation.
- POST /catalogue/prediction/{category}¶
Fetch suggestions for several metadata categories
Get prediction results for a category. If category doesn’t exist, raises 404.
category: category to predict
- Parameters
category (required) –
- Query Parameters
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – The requested
categoryis not supported or the query parameter are of wrong type.
- GET /item/{item_id}/metadata¶
Get metadata for data element
Get search item by its id.
- Request Headers
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Parameters
item_id (string, required) –
- Query Parameters
as_of (string:date-time) –
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- PUT /item/{item_id}/metadata¶
Modify metadata for data element
Updates the metadata element.
- Parameters
item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
400 Bad Request – A requested resource (e.g. unit_id) was not available
422 Unprocessable Entity – Validation Error
- DELETE /item/{item_id}/metadata¶
Delete metadata element
Deletes the metadata element. Return 404 if item to delete was not found.
- Parameters
item_id (string, required) –
- Status Codes
204 No Content – Item successfully deleted
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- GET /item/metadata¶
Get metadata for all elements in this datasource
Get all items for the datasource.
- Request Headers
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Query Parameters
datasource_id (integer, required) –
page (integer) –
size (integer) –
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /item/{item_id}/metadata/versions¶
Get available metadata versions for data element
Get search item versions by its id.
- Request Headers
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Parameters
item_id (string, required) –
- Query Parameters
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- POST /item¶
Create metadata item for data element
Creates the metadata element.
- Query Parameters
datasource_id (integer, required) –
- Status Codes
200 OK – Successful Response
400 Bad Request – A requested resource (e.g. unit_id) was not available
422 Unprocessable Entity – Validation Error
- GET /item/{item_id}/technicalMetadata¶
Get technical metadata for data element
Get search item by its id.
- Parameters
item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item or technical metadata with the given id was not found.
422 Unprocessable Entity – Validation Error
- GET /item/{item_id}/dataAccessDocumentation¶
Get Data Documentation
Return all the information need it to query the item directly
- Parameters
item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- GET /item/{item_id}/dataPreview¶
Get preview of the data
Return all the information need it to query the item directly
- Parameters
item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
403 Forbidden – This feature is not enabled on this installation.
422 Unprocessable Entity – Validation Error
- GET /item/{item_id}/dataPreview/blob/{global_product_id}¶
Get preview of the binary data
Endpoint to download BLOB data by item_id and global_product_id
- Parameters
item_id (string, required) –
global_product_id (integer, required) –
- Status Codes
200 OK – Successful Response
403 Forbidden – This feature is not enabled on this installation.
422 Unprocessable Entity – Validation Error
- GET /config/masterData/unitOfMeasurement¶
Fetches a list of units of measurements
Fetches a list of units of measures.
The user can apply discrete substring filtering on the combination of unit description parameters:
symbol
displayName
Or instead, one can omit all of those and use
substring
to match either the symbol, displayName or a formatted unit provided by the
config/masterData/unitOfMeasurementendpoint.When mixing
substringparameter with parameters above a 400 error response is raised.- Query Parameters
symbol (string) –
display_name (string) –
substring (string) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
400 Bad Request – The combination of
substringwithsymbolordisplayNameis ambiguous. Please filter by a combination ofsymbolordisplayName. If it does not matter if you search for a symbol or a displayName or if you try to get match a suggestion please only specify thesubstringparameter.422 Unprocessable Entity – Validation Error
- POST /config/masterData/unitOfMeasurement¶
Adds a user defined unit of measurement
Creates new unit and returns created unit as a response.
- Status Codes
201 Created – Successful Response
422 Unprocessable Entity – Given unit symbol not valid or already exists.
- GET /config/masterData/unitOfMeasurement/{unit_id}¶
Fetches requested unit of measurement
Fetches the details of a unit of measurement by its id.
- Parameters
unit_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- PUT /config/masterData/unitOfMeasurement/{unit_id}¶
Updates the unit of measurement.
Fetches the details of a unit of measurement by its id.
- Parameters
unit_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Given unit symbol not valid or belongs to other unit.
- DELETE /config/masterData/unitOfMeasurement/{unit_id}¶
Deletes the unit of measurement.
Fetches the details of a unit of measurement by its id.
- Parameters
unit_id (integer, required) –
- Status Codes
204 No Content – Item successfully deleted
404 Not Found – The item with the given id was not found.
405 Method Not Allowed – The specified unit is in use and can not be deleted.
422 Unprocessable Entity – Validation Error
- GET /config/masterData/locale¶
Fetches a list of languages
Fetches the list of languages registered with the Data Catalogue.
- Query Parameters
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /config/masterData/locale¶
Adds a new locale based on the code.
Creates a new locale based on the validated new_locale.
- Status Codes
201 Created – Successful Response
422 Unprocessable Entity – The given code was not valid or know. Only pass values according to ISO 639-1 optionally followed by ISO 3166-1.
- GET /config/masterData/locale/{locale_code}¶
Fetches requested locale
Fetches the details of a locale by its code.
- Parameters
locale_code (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – There is no locale with the given code.
422 Unprocessable Entity – Validation Error
- DELETE /config/masterData/locale/{locale_code}¶
Deletes the locale.
Deletes the locale with matching
locale_code- Parameters
locale_code (string, required) –
- Status Codes
204 No Content – Locale successfully deleted
404 Not Found – There is no locale with the given code.
405 Method Not Allowed – The specified language is in use and can not be deleted.
422 Unprocessable Entity – Validation Error
- POST /config/masterData/location¶
Adds a new location based on the TOS tag.
Creates a new location based on the location TOS tag.
- Status Codes
201 Created – Successful Response
422 Unprocessable Entity – Validation Error
- GET /config/masterData/location/dataSourceLocation¶
Fetches a list of datasource locations
Fetches a list of datasource locations
- Query Parameters
substring (string) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /config/masterData/location/itemLocation¶
Fetches a list of item locations
Fetches a list of item locations
- Query Parameters
substring (string) –
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /config/dataSources¶
Fetches a list of connected data sources.
Return a list of all connected data sources.
- Status Codes
200 OK – Successful Response
- POST /config/dataSources¶
Create a new data source
Creates a new data source and returns the model of the newly created data source.
- Status Codes
201 Created – Successful Response
422 Unprocessable Entity – Validation Error
- GET /config/dataSources/states¶
Fetches the status of all connected data sources.
Return a list of stati all connected data sources.
- Status Codes
200 OK – Successful Response
- GET /config/dataSources/{data_source_id}¶
Fetches requested data source
Returns the details of the specific data source.
- Parameters
data_source_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- PUT /config/dataSources/{data_source_id}¶
Updates the data source
Updates the existing data source identified by
data_source_idwith the set data ofdata_source. Returns the updated model of the data source on success.- Parameters
data_source_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- DELETE /config/dataSources/{data_source_id}¶
Deletes the data source.
Deletes the data source identified by the
data_source_id.- Parameters
data_source_id (integer, required) –
- Status Codes
204 No Content – Data source successfully deleted
404 Not Found – The item with the given id was not found.
405 Method Not Allowed – The specified datasource is in use and can not be deleted.
422 Unprocessable Entity – Validation Error
- GET /config/dataSources/{data_source_id}/state¶
Current state of the data source
Returns the details of the specific data source.
- Parameters
data_source_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- PUT /config/dataSources/l1File/{datasource_id}¶
Upload digital ready L1 file to the server.
Uploads digital ready L1 file to the server.
parse_options is json string with following default values:
{ "valueSeparator": ",", "nullValueText": "", "quoteChar": "\"", "escapeChar": "\\", "characterEncoding": "utf-8" }
- Parameters
datasource_id (integer, required) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – File can’t be parsed with provided options.
409 Conflict – A job with different direction is already running. Wait until it is finished or stop it manually..
- POST /config/dataSources/syncAssets/{datasource_id}¶
Synchronize data from Asset Dictionary
Synchronize data from Asset Dictionary
- Parameters
datasource_id (integer, required) –
- Status Codes
200 OK – Successful Response
409 Conflict – A job with different direction is already running. Wait until it is finished or stop it manually..
422 Unprocessable Entity – Validation Error
- GET /config/dataSources/timeSeriesDb/databases¶
List of databases, available for TimeSeriesDB.
Returns list of databases, available for TimeSeriesDB.
- Query Parameters
source_connection (string, required) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- POST /dataSourceSynchronization/jobs¶
Create new synchronization job
Creates a new synchronization job for the data source.
If there is currently a job running, this endpoint will return the id of this job.
Returns a 409 in case a job already exists with a different direction.
- Status Codes
201 Created – Successful Response
409 Conflict – A job with different direction is already running. Wait until it is finished or stop it manually..
422 Unprocessable Entity – Validation Error
- GET /dataSourceSynchronization/jobs/latest¶
Returns the status of the latest known job for all datasources
Returns the details of the latest job for each datasource including the current status and progress.
- Status Codes
200 OK – Successful Response
- GET /dataSourceSynchronization/jobs/latest/{data_source_id}¶
Returns the status of the latest known job
Returns the details of the job including the current status and progress.
- Parameters
data_source_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – No job was ever run for this data source.
422 Unprocessable Entity – Validation Error
- GET /dataSourceSynchronization/jobs/allLogs/{data_source_id}¶
Returns all the job logs for this data source
Returns the details of the job including the current status and progress.
- Parameters
data_source_id (integer, required) –
- Query Parameters
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
404 Not Found – No job found with this data source.
422 Unprocessable Entity – Validation Error
- GET /dataSourceSynchronization/jobs/{job_id}¶
Returns the details of the job including the current status and progress
Returns the details of the job including the current status and progress.
- Parameters
job_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – No job found with this id and data source.
422 Unprocessable Entity – Validation Error
- DELETE /dataSourceSynchronization/jobs/{job_id}¶
Delete or stop the job
Deletes a finished job. If the job is still running the job will be stopped. To delete the job that has been stopped, call the delete method again. All replicated data will NOT be rolled back.
- Parameters
job_id (integer, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – No job found with this id and data source.
422 Unprocessable Entity – Validation Error
- GET /dataSourceSynchronization/jobs/{job_id}/logs¶
Returns the log messages of the job
Returns the details of the job including the current status and progress.
- Parameters
job_id (integer, required) –
- Query Parameters
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
404 Not Found – No job found with this id and data source.
422 Unprocessable Entity – Validation Error
- GET /health¶
Checks if app is ready for operation
Returns object defining the status of the API.
DEPRECATION WARNING: fields
app_infoandbuildwill be removed from the response in the future. Use/infoand/info/x-build-infoto obtains this information.- Status Codes
200 OK – Successful Response
- GET /livenessProbe¶
Used by Kubernetes to determine if the service is alive.
Used by Kubernetes to determine if the service is alive.
- Status Codes
200 OK – DataCatalogue is up and running.
503 Service Unavailable – DataCatalogue has been stopped.
- GET /license¶
Return license text
Returns the license text of this application.
- Status Codes
200 OK – Successful Response
- GET /license/usedRuntimePackages¶
Exposes the license info of all used 3rd party runtime packages
Exposes a list of used 3rd party licenses used during the runtime of this application.
- Query Parameters
page (integer) –
size (integer) –
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /sourceItem/{source_item_id}/metadata¶
Get metadata for data element
Get search item by its source id.
- Request Headers
datasource-token (string) –
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Parameters
source_item_id (string, required) –
- Query Parameters
as_of (string:date-time) –
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- PUT /sourceItem/{source_item_id}/metadata¶
Modify metadata for data element
Updates the metadata element.
- Request Headers
datasource-token (string) –
- Parameters
source_item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
400 Bad Request – A requested resource (e.g. unit_id) was not available
422 Unprocessable Entity – Validation Error
- DELETE /sourceItem/{source_item_id}/metadata¶
Delete metadata element
Deletes the metadata element. Return 404 if item to delete was not found.
- Request Headers
datasource-token (string) –
- Parameters
source_item_id (string, required) –
- Status Codes
204 No Content – Item successfully deleted
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- GET /sourceItem/metadata¶
Get metadata for all elements in this datasource
Get all items for the datasource.
- Request Headers
datasource-token (string) –
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Query Parameters
page (integer) –
size (integer) –
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
422 Unprocessable Entity – Validation Error
- GET /sourceItem/{source_item_id}/metadata/versions¶
Get available metadata versions for data element
Get search item versions by its id.
- Request Headers
datasource-token (string) –
accept-language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Parameters
source_item_id (string, required) –
- Query Parameters
Language (string) – A comma seperated list local identifiers: Locale code as combination of ISO 639-1 and optionally followed by ISO 3166-1, for example ‘en-EN’ or ‘en’. Warning: When using through SwaggerUI and passing nothing to this parameter, your browser may automatically populate some values.
- Status Codes
200 OK – Successful Response
404 Not Found – The item with the given id was not found.
422 Unprocessable Entity – Validation Error
- POST /sourceItem¶
Create metadata item for data element
Creates the metadata element.
- Request Headers
datasource-token (string) –
- Status Codes
200 OK – Successful Response
400 Bad Request – A requested resource (e.g. unit_id) was not available
422 Unprocessable Entity – Validation Error
- GET /sourceItem/{source_item_id}/technicalMetadata¶
Get technical metadata for data element
Get search item by its id.
- Request Headers
datasource-token (string) –
- Parameters
source_item_id (string, required) –
- Status Codes
200 OK – Successful Response
404 Not Found – The item or technical metadata with the given id was not found.
422 Unprocessable Entity – Validation Error