ores.dq Messaging Reference
Table of Contents
- 1. Artefact Types
- 2. Badge Definitions
- 3. Badge Mappings
- 4. Badge Severities
- 5. Bundle Publishing
- 6. Catalogs
- 7. Change Reason Categories
- 8. Change Reasons
- 9. Code Domains
- 10. Coding Scheme Authority Types
- 11. Coding Schemes
- 12. Data Domains
- 13. Dataset Bundle Members
- 14. Dataset Bundles
- 15. Datasets
- 16. Entity History
- 17. FSM States
- 18. FSM Transitions
- 19. LEI Entities
- 20. LEI Relationships
- 21. LEI Bic
- 22. Methodologies
- 23. Nature Dimensions
- 24. Origin Dimensions
- 25. Publications
- 26. Publish from DQ Triggers
- 27. Report Definition Templates
- 28. Subject Areas
- 29. Treatment Dimensions
- 30. Entity Change Events
- 31. Useful Pages
NATS messaging reference for ores.dq. All subjects use the
dq.v1.> namespace. See ores.nats for transport details.
Each generated entity exposes the verbs list, get, get_many, put, put_many,
delete, and delete_many. Version history sits under the <entity>_versions prefix with
list and get. Read-only entities expose only list, get, and get_many. The entity
segment is the plural snake_case name, so a subject reads dq.v1.<entity>.<verb> or
dq.v1.<entity>_versions.<verb>.
Change notifications are published on dq.v1.<entity>_events.<action>, where the action is
created, updated, or deleted; see the Entity Change Events section.
1. Artefact Types
| Subject | Description |
|---|---|
dq.v1.artefact_types.list |
Retrieve all artefact types |
dq.v1.artefact_types.get |
Retrieve one artefact type |
dq.v1.artefact_types.get_many |
Retrieve several artefact types by key |
dq.v1.artefact_types.put |
Create or update an artefact type |
dq.v1.artefact_types.put_many |
Create or update several artefact types |
dq.v1.artefact_types.delete |
Delete one or more artefact types |
dq.v1.artefact_types.delete_many |
Delete several artefact types by key |
dq.v1.artefact_types_versions.list |
Retrieve version history for an artefact type |
dq.v1.artefact_types_versions.get |
Retrieve one version of an artefact type |
2. Badge Definitions
| Subject | Description |
|---|---|
dq.v1.badge_definitions.list |
Retrieve all badge definitions |
dq.v1.badge_definitions.get |
Retrieve one badge definition |
dq.v1.badge_definitions.get_many |
Retrieve several badge definitions by key |
dq.v1.badge_definitions.put |
Create or update a badge definition |
dq.v1.badge_definitions.put_many |
Create or update several badge definitions |
dq.v1.badge_definitions.delete |
Delete one or more badge definitions |
dq.v1.badge_definitions.delete_many |
Delete several badge definitions by key |
dq.v1.badge_definitions_versions.list |
Retrieve version history for a badge definition |
dq.v1.badge_definitions_versions.get |
Retrieve one version of a badge definition |
3. Badge Mappings
| Subject | Description |
|---|---|
dq.v1.badge_mappings.list |
Retrieve all badge mappings |
dq.v1.badge_mappings.list_by_code_domain_code |
Retrieve badge mappings for a code domain |
dq.v1.badge_mappings.get |
Retrieve one badge mapping |
dq.v1.badge_mappings.get_many |
Retrieve several badge mappings by key |
dq.v1.badge_mappings.put |
Create or update a badge mapping |
dq.v1.badge_mappings.put_many |
Create or update several badge mappings |
dq.v1.badge_mappings.delete |
Delete one or more badge mappings |
dq.v1.badge_mappings.delete_many |
Delete several badge mappings by key |
4. Badge Severities
| Subject | Description |
|---|---|
dq.v1.badge_severities.list |
Retrieve all badge severities |
dq.v1.badge_severities.get |
Retrieve one badge severity |
dq.v1.badge_severities.get_many |
Retrieve several badge severities by key |
dq.v1.badge_severities.put |
Create or update a badge severity |
dq.v1.badge_severities.put_many |
Create or update several badge severities |
dq.v1.badge_severities.delete |
Delete one or more badge severities |
dq.v1.badge_severities.delete_many |
Delete several badge severities by key |
dq.v1.badge_severities_versions.list |
Retrieve version history for a badge severity |
dq.v1.badge_severities_versions.get |
Retrieve one version of a badge severity |
5. Bundle Publishing
| Subject | Description |
|---|---|
dq.v1.ops.publish_bundle |
Publish all datasets in a bundle |
6. Catalogs
| Subject | Description |
|---|---|
dq.v1.catalogs.list |
Retrieve all catalogs |
dq.v1.catalogs.get |
Retrieve one catalog |
dq.v1.catalogs.get_many |
Retrieve several catalogs by key |
dq.v1.catalogs.put |
Create or update a catalog |
dq.v1.catalogs.put_many |
Create or update several catalogs |
dq.v1.catalogs.delete |
Delete one or more catalogs |
dq.v1.catalogs.delete_many |
Delete several catalogs by key |
dq.v1.catalogs_versions.list |
Retrieve version history for a catalog |
dq.v1.catalogs_versions.get |
Retrieve one version of a catalog |
7. Change Reason Categories
| Subject | Description |
|---|---|
dq.v1.change_reason_categories.list |
Retrieve all change reason categories |
dq.v1.change_reason_categories.get |
Retrieve one change reason category |
dq.v1.change_reason_categories.get_many |
Retrieve several change reason categories by key |
dq.v1.change_reason_categories.put |
Create or update a change reason category |
dq.v1.change_reason_categories.put_many |
Create or update several change reason categories |
dq.v1.change_reason_categories.delete |
Delete one or more change reason categories |
dq.v1.change_reason_categories.delete_many |
Delete several change reason categories by key |
dq.v1.change_reason_categories_versions.list |
Retrieve version history for a change reason category |
dq.v1.change_reason_categories_versions.get |
Retrieve one version of a change reason category |
8. Change Reasons
| Subject | Description |
|---|---|
dq.v1.change_reasons.list |
Retrieve all change reasons |
dq.v1.change_reasons.get |
Retrieve one change reason |
dq.v1.change_reasons.get_many |
Retrieve several change reasons by key |
dq.v1.change_reasons.put |
Create or update a change reason |
dq.v1.change_reasons.put_many |
Create or update several change reasons |
dq.v1.change_reasons.delete |
Delete one or more change reasons |
dq.v1.change_reasons.delete_many |
Delete several change reasons by key |
dq.v1.change_reasons_versions.list |
Retrieve version history for a change reason |
dq.v1.change_reasons_versions.get |
Retrieve one version of a change reason |
9. Code Domains
| Subject | Description |
|---|---|
dq.v1.code_domains.list |
Retrieve all code domains |
dq.v1.code_domains.get |
Retrieve one code domain |
dq.v1.code_domains.get_many |
Retrieve several code domains by key |
dq.v1.code_domains.put |
Create or update a code domain |
dq.v1.code_domains.put_many |
Create or update several code domains |
dq.v1.code_domains.delete |
Delete one or more code domains |
dq.v1.code_domains.delete_many |
Delete several code domains by key |
dq.v1.code_domains_versions.list |
Retrieve version history for a code domain |
dq.v1.code_domains_versions.get |
Retrieve one version of a code domain |
10. Coding Scheme Authority Types
| Subject | Description |
|---|---|
dq.v1.coding_scheme_authority_types.list |
Retrieve all coding scheme authority types |
dq.v1.coding_scheme_authority_types.get |
Retrieve one coding scheme authority type |
dq.v1.coding_scheme_authority_types.get_many |
Retrieve several coding scheme authority types by key |
dq.v1.coding_scheme_authority_types.put |
Create or update a coding scheme authority type |
dq.v1.coding_scheme_authority_types.put_many |
Create or update several coding scheme authority types |
dq.v1.coding_scheme_authority_types.delete |
Delete one or more coding scheme authority types |
dq.v1.coding_scheme_authority_types.delete_many |
Delete several coding scheme authority types by key |
dq.v1.coding_scheme_authority_types_versions.list |
Retrieve version history for a coding scheme authority type |
dq.v1.coding_scheme_authority_types_versions.get |
Retrieve one version of a coding scheme authority type |
11. Coding Schemes
| Subject | Description |
|---|---|
dq.v1.coding_schemes.list |
Retrieve all coding schemes |
dq.v1.coding_schemes.get |
Retrieve one coding scheme |
dq.v1.coding_schemes.get_many |
Retrieve several coding schemes by key |
dq.v1.coding_schemes.put |
Create or update a coding scheme |
dq.v1.coding_schemes.put_many |
Create or update several coding schemes |
dq.v1.coding_schemes.delete |
Delete one or more coding schemes |
dq.v1.coding_schemes.delete_many |
Delete several coding schemes by key |
dq.v1.coding_schemes_versions.list |
Retrieve version history for a coding scheme |
dq.v1.coding_schemes_versions.get |
Retrieve one version of a coding scheme |
12. Data Domains
| Subject | Description |
|---|---|
dq.v1.data_domains.list |
Retrieve all data domains |
dq.v1.data_domains.get |
Retrieve one data domain |
dq.v1.data_domains.get_many |
Retrieve several data domains by key |
dq.v1.data_domains.put |
Create or update a data domain |
dq.v1.data_domains.put_many |
Create or update several data domains |
dq.v1.data_domains.delete |
Delete one or more data domains |
dq.v1.data_domains.delete_many |
Delete several data domains by key |
dq.v1.data_domains_versions.list |
Retrieve version history for a data domain |
dq.v1.data_domains_versions.get |
Retrieve one version of a data domain |
13. Dataset Bundle Members
| Subject | Description |
|---|---|
dq.v1.dataset_bundle_members.list |
Retrieve all dataset bundle members |
dq.v1.dataset_bundle_members.list_by_bundle_code |
Retrieve dataset bundle members for a bundle |
dq.v1.dataset_bundle_members.get |
Retrieve one dataset bundle member |
dq.v1.dataset_bundle_members.get_many |
Retrieve several dataset bundle members by key |
dq.v1.dataset_bundle_members.put |
Create or update a dataset bundle member |
dq.v1.dataset_bundle_members.put_many |
Create or update several dataset bundle members |
dq.v1.dataset_bundle_members.delete |
Delete one or more dataset bundle members |
dq.v1.dataset_bundle_members.delete_many |
Delete several dataset bundle members by key |
14. Dataset Bundles
| Subject | Description |
|---|---|
dq.v1.dataset_bundles.list |
Retrieve all dataset bundles |
dq.v1.dataset_bundles.get |
Retrieve one dataset bundle |
dq.v1.dataset_bundles.get_many |
Retrieve several dataset bundles by key |
dq.v1.dataset_bundles.put |
Create or update a dataset bundle |
dq.v1.dataset_bundles.put_many |
Create or update several dataset bundles |
dq.v1.dataset_bundles.delete |
Delete one or more dataset bundles |
dq.v1.dataset_bundles.delete_many |
Delete several dataset bundles by key |
dq.v1.dataset_bundles_versions.list |
Retrieve version history for a dataset bundle |
dq.v1.dataset_bundles_versions.get |
Retrieve one version of a dataset bundle |
15. Datasets
| Subject | Description |
|---|---|
dq.v1.datasets.list |
Retrieve all datasets |
dq.v1.datasets.get |
Retrieve one dataset |
dq.v1.datasets.get_many |
Retrieve several datasets by key |
dq.v1.datasets.put |
Create or update a dataset |
dq.v1.datasets.put_many |
Create or update several datasets |
dq.v1.datasets.delete |
Delete one or more datasets |
dq.v1.datasets.delete_many |
Delete several datasets by key |
dq.v1.ops.publish_datasets |
Publish one or more datasets |
dq.v1.datasets_versions.list |
Retrieve version history for a dataset |
dq.v1.datasets_versions.get |
Retrieve one version of a dataset |
16. Entity History
| Subject | Description |
|---|---|
dq.v1.history.get |
Retrieve version history for an entity of any type |
17. FSM States
| Subject | Description |
|---|---|
dq.v1.fsm_states.list |
Retrieve all FSM states |
dq.v1.fsm_states.get |
Retrieve one FSM state |
dq.v1.fsm_states.get_many |
Retrieve several FSM states by key |
dq.v1.fsm_states.put |
Create or update an FSM state |
dq.v1.fsm_states.put_many |
Create or update several FSM states |
dq.v1.fsm_states.delete |
Delete one or more FSM states |
dq.v1.fsm_states.delete_many |
Delete several FSM states by key |
dq.v1.fsm_states_versions.list |
Retrieve version history for an FSM state |
dq.v1.fsm_states_versions.get |
Retrieve one version of an FSM state |
18. FSM Transitions
| Subject | Description |
|---|---|
dq.v1.fsm_transitions.list |
Retrieve all FSM transitions |
dq.v1.fsm_transitions.get |
Retrieve one FSM transition |
dq.v1.fsm_transitions.get_many |
Retrieve several FSM transitions by key |
dq.v1.fsm_transitions.put |
Create or update an FSM transition |
dq.v1.fsm_transitions.put_many |
Create or update several FSM transitions |
dq.v1.fsm_transitions.delete |
Delete one or more FSM transitions |
dq.v1.fsm_transitions.delete_many |
Delete several FSM transitions by key |
dq.v1.fsm_transitions_versions.list |
Retrieve version history for an FSM transition |
dq.v1.fsm_transitions_versions.get |
Retrieve one version of an FSM transition |
19. LEI Entities
| Subject | Description |
|---|---|
dq.v1.lei_entities.list |
Retrieve all LEI entities |
dq.v1.lei_entities.get |
Retrieve one LEI entity |
dq.v1.lei_entities.get_many |
Retrieve several LEI entities by key |
dq.v1.ops.get_lei_entities_summary |
Retrieve the LEI entity summary projection |
20. LEI Relationships
| Subject | Description |
|---|---|
dq.v1.lei_relationships.list |
Retrieve all LEI relationships |
dq.v1.lei_relationships.get |
Retrieve one LEI relationship |
dq.v1.lei_relationships.get_many |
Retrieve several LEI relationships by key |
21. LEI Bic
| Subject | Description |
|---|---|
dq.v1.lei_bic.list |
Retrieve all LEI to BIC mappings |
dq.v1.lei_bic.get |
Retrieve one LEI to BIC mapping |
dq.v1.lei_bic.get_many |
Retrieve several LEI to BIC mappings by key |
22. Methodologies
| Subject | Description |
|---|---|
dq.v1.methodologies.list |
Retrieve all methodologies |
dq.v1.methodologies.get |
Retrieve one methodology |
dq.v1.methodologies.get_many |
Retrieve several methodologies by key |
dq.v1.methodologies.put |
Create or update a methodology |
dq.v1.methodologies.put_many |
Create or update several methodologies |
dq.v1.methodologies.delete |
Delete one or more methodologies |
dq.v1.methodologies.delete_many |
Delete several methodologies by key |
dq.v1.methodologies_versions.list |
Retrieve version history for a methodology |
dq.v1.methodologies_versions.get |
Retrieve one version of a methodology |
23. Nature Dimensions
| Subject | Description |
|---|---|
dq.v1.nature_dimensions.list |
Retrieve all nature dimensions |
dq.v1.nature_dimensions.get |
Retrieve one nature dimension |
dq.v1.nature_dimensions.get_many |
Retrieve several nature dimensions by key |
dq.v1.nature_dimensions.put |
Create or update a nature dimension |
dq.v1.nature_dimensions.put_many |
Create or update several nature dimensions |
dq.v1.nature_dimensions.delete |
Delete one or more nature dimensions |
dq.v1.nature_dimensions.delete_many |
Delete several nature dimensions by key |
dq.v1.nature_dimensions_versions.list |
Retrieve version history for a nature dimension |
dq.v1.nature_dimensions_versions.get |
Retrieve one version of a nature dimension |
24. Origin Dimensions
| Subject | Description |
|---|---|
dq.v1.origin_dimensions.list |
Retrieve all origin dimensions |
dq.v1.origin_dimensions.get |
Retrieve one origin dimension |
dq.v1.origin_dimensions.get_many |
Retrieve several origin dimensions by key |
dq.v1.origin_dimensions.put |
Create or update an origin dimension |
dq.v1.origin_dimensions.put_many |
Create or update several origin dimensions |
dq.v1.origin_dimensions.delete |
Delete one or more origin dimensions |
dq.v1.origin_dimensions.delete_many |
Delete several origin dimensions by key |
dq.v1.origin_dimensions_versions.list |
Retrieve version history for an origin dimension |
dq.v1.origin_dimensions_versions.get |
Retrieve one version of an origin dimension |
25. Publications
| Subject | Description |
|---|---|
dq.v1.publications.list |
Retrieve all publications |
dq.v1.publications.get |
Retrieve one publication |
dq.v1.publications.get_many |
Retrieve several publications by key |
dq.v1.publications.put |
Create or update a publication |
dq.v1.publications.put_many |
Create or update several publications |
dq.v1.publications.delete |
Delete one or more publications |
dq.v1.publications.delete_many |
Delete several publications by key |
26. Publish from DQ Triggers
| Subject | Description |
|---|---|
dq.v1.ops.publish_ip2country_from_dq |
Trigger the IP-to-country publish-from-DQ step |
dq.v1.ops.publish_coding_schemes_from_dq |
Trigger the coding schemes publish-from-DQ step |
dq.v1.ops.publish_badge_severities_from_dq |
Trigger the badge severities publish-from-DQ step |
dq.v1.ops.publish_badge_definitions_from_dq |
Trigger the badge definitions publish-from-DQ step |
dq.v1.ops.publish_code_domains_from_dq |
Trigger the code domains publish-from-DQ step |
dq.v1.ops.publish_badge_mappings_from_dq |
Trigger the badge mappings publish-from-DQ step |
27. Report Definition Templates
| Subject | Description |
|---|---|
dq.v1.report_definition_templates.list |
Retrieve all report definition templates |
28. Subject Areas
| Subject | Description |
|---|---|
dq.v1.subject_areas.list |
Retrieve all subject areas |
dq.v1.subject_areas.get |
Retrieve one subject area |
dq.v1.subject_areas.get_many |
Retrieve several subject areas by key |
dq.v1.subject_areas.put |
Create or update a subject area |
dq.v1.subject_areas.put_many |
Create or update several subject areas |
dq.v1.subject_areas.delete |
Delete one or more subject areas |
dq.v1.subject_areas.delete_many |
Delete several subject areas by key |
dq.v1.subject_areas_versions.list |
Retrieve version history for a subject area |
dq.v1.subject_areas_versions.get |
Retrieve one version of a subject area |
29. Treatment Dimensions
| Subject | Description |
|---|---|
dq.v1.treatment_dimensions.list |
Retrieve all treatment dimensions |
dq.v1.treatment_dimensions.get |
Retrieve one treatment dimension |
dq.v1.treatment_dimensions.get_many |
Retrieve several treatment dimensions by key |
dq.v1.treatment_dimensions.put |
Create or update a treatment dimension |
dq.v1.treatment_dimensions.put_many |
Create or update several treatment dimensions |
dq.v1.treatment_dimensions.delete |
Delete one or more treatment dimensions |
dq.v1.treatment_dimensions.delete_many |
Delete several treatment dimensions by key |
dq.v1.treatment_dimensions_versions.list |
Retrieve version history for a treatment dimension |
dq.v1.treatment_dimensions_versions.get |
Retrieve one version of a treatment dimension |
30. Entity Change Events
| Subject | Description |
|---|---|
dq.v1.events.artefact_types.created |
Published when an artefact type is created |
dq.v1.events.artefact_types.deleted |
Published when an artefact type is deleted |
dq.v1.events.artefact_types.updated |
Published when an artefact type is updated |
dq.v1.events.badge_definitions.created |
Published when a badge definition is created |
dq.v1.events.badge_definitions.deleted |
Published when a badge definition is deleted |
dq.v1.events.badge_definitions.updated |
Published when a badge definition is updated |
dq.v1.events.badge_severities.created |
Published when a badge severity is created |
dq.v1.events.badge_severities.deleted |
Published when a badge severity is deleted |
dq.v1.events.badge_severities.updated |
Published when a badge severity is updated |
dq.v1.events.catalogs.created |
Published when a catalog is created |
dq.v1.events.catalogs.deleted |
Published when a catalog is deleted |
dq.v1.events.catalogs.updated |
Published when a catalog is updated |
dq.v1.events.change_reason_categories.created |
Published when a change reason category is created |
dq.v1.events.change_reason_categories.deleted |
Published when a change reason category is deleted |
dq.v1.events.change_reason_categories.updated |
Published when a change reason category is updated |
dq.v1.events.change_reasons.created |
Published when a change reason is created |
dq.v1.events.change_reasons.deleted |
Published when a change reason is deleted |
dq.v1.events.change_reasons.updated |
Published when a change reason is updated |
dq.v1.events.code_domains.created |
Published when a code domain is created |
dq.v1.events.code_domains.deleted |
Published when a code domain is deleted |
dq.v1.events.code_domains.updated |
Published when a code domain is updated |
dq.v1.events.coding_scheme_authority_types.created |
Published when a coding scheme authority type is created |
dq.v1.events.coding_scheme_authority_types.deleted |
Published when a coding scheme authority type is deleted |
dq.v1.events.coding_scheme_authority_types.updated |
Published when a coding scheme authority type is updated |
dq.v1.events.coding_schemes.created |
Published when a coding scheme is created |
dq.v1.events.coding_schemes.deleted |
Published when a coding scheme is deleted |
dq.v1.events.coding_schemes.updated |
Published when a coding scheme is updated |
dq.v1.events.data_domains.created |
Published when a data domain is created |
dq.v1.events.data_domains.deleted |
Published when a data domain is deleted |
dq.v1.events.data_domains.updated |
Published when a data domain is updated |
dq.v1.events.dataset_bundles.created |
Published when a dataset bundle is created |
dq.v1.events.dataset_bundles.deleted |
Published when a dataset bundle is deleted |
dq.v1.events.dataset_bundles.updated |
Published when a dataset bundle is updated |
dq.v1.events.datasets.created |
Published when a dataset is created |
dq.v1.events.datasets.deleted |
Published when a dataset is deleted |
dq.v1.events.datasets.updated |
Published when a dataset is updated |
dq.v1.events.fsm_states.created |
Published when an FSM state is created |
dq.v1.events.fsm_states.deleted |
Published when an FSM state is deleted |
dq.v1.events.fsm_states.updated |
Published when an FSM state is updated |
dq.v1.events.fsm_transitions.created |
Published when an FSM transition is created |
dq.v1.events.fsm_transitions.deleted |
Published when an FSM transition is deleted |
dq.v1.events.fsm_transitions.updated |
Published when an FSM transition is updated |
dq.v1.events.lei_entities.created |
Published when an LEI entity is created |
dq.v1.events.lei_entities.deleted |
Published when an LEI entity is deleted |
dq.v1.events.lei_entities.updated |
Published when an LEI entity is updated |
dq.v1.events.lei_relationships.created |
Published when an LEI relationship is created |
dq.v1.events.lei_relationships.deleted |
Published when an LEI relationship is deleted |
dq.v1.events.lei_relationships.updated |
Published when an LEI relationship is updated |
dq.v1.events.methodologies.created |
Published when a methodology is created |
dq.v1.events.methodologies.deleted |
Published when a methodology is deleted |
dq.v1.events.methodologies.updated |
Published when a methodology is updated |
dq.v1.events.nature_dimensions.created |
Published when a nature dimension is created |
dq.v1.events.nature_dimensions.deleted |
Published when a nature dimension is deleted |
dq.v1.events.nature_dimensions.updated |
Published when a nature dimension is updated |
dq.v1.events.origin_dimensions.created |
Published when an origin dimension is created |
dq.v1.events.origin_dimensions.deleted |
Published when an origin dimension is deleted |
dq.v1.events.origin_dimensions.updated |
Published when an origin dimension is updated |
dq.v1.events.publications.created |
Published when a publication is created |
dq.v1.events.publications.deleted |
Published when a publication is deleted |
dq.v1.events.publications.updated |
Published when a publication is updated |
dq.v1.events.subject_areas.created |
Published when a subject area is created |
dq.v1.events.subject_areas.deleted |
Published when a subject area is deleted |
dq.v1.events.subject_areas.updated |
Published when a subject area is updated |
dq.v1.events.treatment_dimensions.created |
Published when a treatment dimension is created |
dq.v1.events.treatment_dimensions.deleted |
Published when a treatment dimension is deleted |
dq.v1.events.treatment_dimensions.updated |
Published when a treatment dimension is updated |
31. Useful Pages
- ores.nats — transport layer: request/reply, subject naming, configuration
- Protocol Reference — all services overview
- ores.dq — component documentation